100 lines
3.8 KiB
Plaintext
100 lines
3.8 KiB
Plaintext
/*
|
|
* DTS.Slice.Control.Event.Module.Channel.cs
|
|
*
|
|
* Copyright © 2009
|
|
* Diversified Technical Systems, Inc.
|
|
* All Rights Reserved
|
|
*/
|
|
|
|
using System;
|
|
using DTS.Common.Utilities;
|
|
using DTS.Slice.Control.DAS.Channel;
|
|
|
|
namespace DTS.Slice.Control
|
|
{
|
|
public partial class Event
|
|
{ // *** see DTS.Slice.Control.Event.cs ***
|
|
public partial class Module
|
|
{ // *** see DTS.Slice.Control.Event.Module.cs ***
|
|
public partial class Channel
|
|
{ // *** see DTS.Slice.Control.Event.Module.Channel.cs ***
|
|
/// <summary>
|
|
/// A filter for DTS.Slice.Control.Event.Module.Channels.
|
|
/// </summary>
|
|
public abstract class Filter
|
|
: Exceptional,
|
|
IFilter
|
|
{
|
|
/// <summary>
|
|
/// A descriptive <see cref="string"/> designation for the filter.
|
|
/// </summary>
|
|
public abstract string Name
|
|
{
|
|
get;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Get the <see cref="Boolean"/> value indicating whether or not this filter
|
|
/// corresponds to a CFC value.
|
|
/// </summary>
|
|
public abstract bool IsCfc
|
|
{
|
|
get;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Get a <see cref="ChannelFilter"/> designation for this filter.
|
|
/// </summary>
|
|
public abstract ChannelFilter Type
|
|
{
|
|
get;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Get the <see cref="double"/> cutoff frequency for this filter.
|
|
/// </summary>
|
|
public abstract double CutoffFrequencyHz
|
|
{
|
|
get;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Apply the filter to the specified input.
|
|
/// </summary>
|
|
///
|
|
/// <param name="input">
|
|
/// The input to the filter.
|
|
/// </param>
|
|
///
|
|
/// <param name="displayUnits">
|
|
/// The <see cref="DTS.Slice.Control.Event.Module.Channel.DataDisplayUnits"/> to be
|
|
/// filtered from the channel.
|
|
/// </param>
|
|
/// <param name="bUseLegacyTDCSoftwareFilterAdjustment">
|
|
/// controls whether filtered data is adjusted by one sample to match TDC behavior
|
|
/// 8747
|
|
/// </param>
|
|
/// <returns>
|
|
/// The filtering of the input.
|
|
/// </returns>
|
|
///
|
|
public abstract double[] Apply(
|
|
Channel input,
|
|
DataDisplayUnits displayUnits,
|
|
bool bUseLegacyTDCSoftwareFilterAdjustment);
|
|
public abstract double[] Apply(
|
|
double[] data,
|
|
double sampleRate,
|
|
bool bUseLegacyTDCSoftwareFilterAdjustment);
|
|
/// <summary>
|
|
/// the ToString is already overloaded, but we sometimes need the base name, not the decorated name that
|
|
/// is returned in ToString.
|
|
/// </summary>
|
|
/// <returns></returns>
|
|
public abstract string ToBaseString();
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|