agi.foundation.communications.signalprocessing

(agi.foundation.communications-2024r2.jar)

Class SignalFilter

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.signalprocessing.SignalProcessor

agi.foundation.communications.signalprocessing.SignalFilter

All Implemented Interfaces:

ISignalSource, ISignalOutputService, ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IServiceProvider

Direct Known Subclasses:

GpsPowerSpectralDensityFilter, RectangularFilter

public abstract class SignalFilter
extends SignalProcessor

Base class for all signal filters.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SignalFilter() Initializes a new instance.
protected	SignalFilter(SignalFilter existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	checkForSameDefinition(SignalFilter other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(SignalProcessor other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
double	getFrequency() Gets the center frequency of the filter, in hertz.
double	getLowerBandwidthLimit() Gets the offset to the lower limit of the filter bandwidth, in hertz.
double	getNoiseTemperature() Gets the thermal noise temperature of the filter, in kelvin.
double	getUpperBandwidthLimit() Gets the offset to the upper limit of the filter bandwidth, in hertz.
void	setFrequency(double value) Sets the center frequency of the filter, in hertz.
void	setLowerBandwidthLimit(double value) Sets the offset to the lower limit of the filter bandwidth, in hertz.
void	setNoiseTemperature(double value) Sets the thermal noise temperature of the filter, in kelvin.
void	setUpperBandwidthLimit(double value) Sets the offset to the upper limit of the filter bandwidth, in hertz.

Methods inherited from class agi.foundation.communications.signalprocessing.SignalProcessor

checkForSameDefinition, getInputSignalProcessor, getProcessingDelay, getService, getSignalEvaluator, getSignalEvaluator, getSignalOutput, setInputSignalProcessor

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, enumerateDependencies, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SignalFilter

protected SignalFilter()

Initializes a new instance.

SignalFilter

protected SignalFilter(@Nonnull
                       SignalFilter existingInstance,
                       @Nonnull
                       CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

checkForSameDefinition

protected final boolean checkForSameDefinition(SignalProcessor other)

Checks to determine if another instance has the same definition as this instance and returns true 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 false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Specified by:

checkForSameDefinition in class SignalProcessor

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected abstract boolean checkForSameDefinition(SignalFilter other)

Checks to determine if another instance has the same definition as this instance and returns true 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 false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

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 SignalFilter.checkForSameDefinition(agi.foundation.communications.signalprocessing.SignalProcessor) method.

Overrides:

computeCurrentDefinitionHashCode in class SignalProcessor

Returns:

The computed hash code.

getFrequency

public final double getFrequency()

Gets the center frequency of the filter, in hertz.

setFrequency

public final void setFrequency(double value)

Sets the center frequency of the filter, in hertz.

getLowerBandwidthLimit

public final double getLowerBandwidthLimit()

Gets the offset to the lower limit of the filter bandwidth, in hertz.

setLowerBandwidthLimit

public final void setLowerBandwidthLimit(double value)

Sets the offset to the lower limit of the filter bandwidth, in hertz.

getUpperBandwidthLimit

public final double getUpperBandwidthLimit()

Gets the offset to the upper limit of the filter bandwidth, in hertz.

setUpperBandwidthLimit

public final void setUpperBandwidthLimit(double value)

Sets the offset to the upper limit of the filter bandwidth, in hertz.

getNoiseTemperature

public final double getNoiseTemperature()

Gets the thermal noise temperature of the filter, in kelvin.

setNoiseTemperature

public final void setNoiseTemperature(double value)

Sets the thermal noise temperature of the filter, in kelvin.