Click or drag to resize

RectangularFilter Class

A filter which constrains the incoming signals into a specified bandwidth range, ignoring power spectral density.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Communications.SignalProcessing
Assembly:  AGI.Foundation.Communications (in AGI.Foundation.Communications.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax
public class RectangularFilter : SignalFilter

The RectangularFilter type exposes the following members.

Constructors
  NameDescription
Public methodRectangularFilter
Initializes a new instance.
Protected methodRectangularFilter(RectangularFilter, CopyContext)
Initializes a new instance as a copy of an existing instance.
Public methodRectangularFilter(SignalProcessor, Double, Double, Double, Double)
Initialize a new instance based on the given parameters.
Top
Properties
  NameDescription
Public propertyFrequency
Gets or sets the center frequency of the filter, in hertz.
(Inherited from SignalFilter.)
Public propertyInputSignalProcessor
Gets or sets the signal processor which produces the set of signals which this processor modifies.
(Overrides SignalProcessorInputSignalProcessor.)
Public propertyIsFrozen
Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so.
(Inherited from DefinitionalObject.)
Public propertyLowerBandwidthLimit
Gets or sets the offset to the lower limit of the filter bandwidth, in hertz.
(Inherited from SignalFilter.)
Public propertyNoiseTemperature
Gets or sets the thermal noise temperature of the filter, in kelvin.
(Inherited from SignalFilter.)
Public propertySignalOutput
Gets the signal processor representing the output of the service provider.
(Inherited from SignalProcessor.)
Public propertyUpperBandwidthLimit
Gets or sets the offset to the upper limit of the filter bandwidth, in hertz.
(Inherited from SignalFilter.)
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(DefinitionalObject)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from SignalProcessor.)
Protected methodCheckForSameDefinition(RectangularFilter)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
Protected methodCheckForSameDefinition(SignalFilter)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Overrides SignalFilterCheckForSameDefinition(SignalFilter).)
Protected methodCheckForSameDefinition(SignalProcessor)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from SignalFilter.)
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Protected methodComputeCurrentDefinitionHashCode
Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the CheckForSameDefinition(DefinitionalObject) method.
(Overrides SignalFilterComputeCurrentDefinitionHashCode.)
Public methodEnumerateDependencies
Enumerates the dependencies of this object by calling EnumerateT(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.
(Overrides DefinitionalObjectEnumerateDependencies(DependencyEnumerator).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
Called by Freeze to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.
(Inherited from DefinitionalObject.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetProcessingDelay
Get an evaluator which computes the time delay between the input and output of this signal processor.
(Inherited from SignalProcessor.)
Public methodGetService
Gets the service object of the specified type.
(Inherited from SignalProcessor.)
Public methodGetSignalEvaluator(SignalPropagationGraph)
Get an evaluator which can produce the output from the signal processor.
(Inherited from SignalProcessor.)
Public methodGetSignalEvaluator(EvaluatorGroup, SignalPropagationGraph)
Get a signal evaluator which takes the signals from the InputSignalProcessor and constrains the bandwidth.
(Overrides SignalProcessorGetSignalEvaluator(EvaluatorGroup, SignalPropagationGraph).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

The filter constrains the signal in the following way:

  • Input signal inside filter bandwidth: output signal noise bandwidth will be constrained to only lie within the filter bandwidth.
  • Input signal completely outside filter bandwidth: no output signal (removed from SignalCollection).
  • Input signal partially overlaps the filter bandwidth: in this case, the output signal's power will be decreased according to the ratio of the overlap and the signal bandwidth will be constrained to only lie within the filter bandwidth. Also, the noise bandwidth will be constrained to only lie within the filter bandwidth.
See Also