agi.foundation.communications.signalprocessing

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

Class Amplifier

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.signalprocessing.SignalProcessor

agi.foundation.communications.signalprocessing.Amplifier

All Implemented Interfaces:

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

Direct Known Subclasses:

ConstantGainAmplifier, LowNoiseAmplifier, VariableGainAmplifier

public abstract class Amplifier
extends SignalProcessor

Abstract class for an amplifier signal processor.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Amplifier() Initializes a new instance.
protected	Amplifier(Amplifier existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
protected	Amplifier(double noiseFactor, double referenceTemperature) Initializes a new instance from the given noise factor, and reference temperature.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	checkForSameDefinition(Amplifier 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	getNoiseFactor() Gets the noise factor representing the ratio of the NoiseTemperature (get) to ReferenceTemperature (get / set) plus 1 (i.e.
double	getNoiseTemperature() Gets the noise temperature of the amplifier, in kelvin.
double	getReferenceTemperature() Gets the reference temperature for this amplifier, in kelvin.
void	setNoiseFactor(double value) Sets the noise factor representing the ratio of the NoiseTemperature (get) to ReferenceTemperature (get / set) plus 1 (i.e.
void	setReferenceTemperature(double value) Sets the reference temperature for this amplifier, in kelvin.

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

Amplifier

protected Amplifier()

Initializes a new instance.

Amplifier

protected Amplifier(double noiseFactor,
                    double referenceTemperature)

Initializes a new instance from the given noise factor, and reference temperature.

Parameters:

noiseFactor - The noise factor of the amplifier.

referenceTemperature - The reference temperature of the amplifier, in kelvin.

Amplifier

protected Amplifier(@Nonnull
                    Amplifier 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(Amplifier 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 Amplifier.checkForSameDefinition(agi.foundation.communications.signalprocessing.SignalProcessor) method.

Overrides:

computeCurrentDefinitionHashCode in class SignalProcessor

Returns:

The computed hash code.

getNoiseFactor

public double getNoiseFactor()

Gets the noise factor representing the ratio of the NoiseTemperature (get) to ReferenceTemperature (get / set) plus 1 (i.e. NoiseFactor (get / set) = NoiseTemperature (get)/ReferenceTemperature (get / set) + 1).

The NoiseFactor (get / set) defines how much noise the amplifier has. A NoiseFactor (get / set) of 1.0 indicates the Amplifier has no noise. A NoiseFactor (get / set) of 2 indicates a NoiseTemperature (get) equal to the ReferenceTemperature (get / set). The default value is 1.0.

setNoiseFactor

public void setNoiseFactor(double value)

Sets the noise factor representing the ratio of the NoiseTemperature (get) to ReferenceTemperature (get / set) plus 1 (i.e. NoiseFactor (get / set) = NoiseTemperature (get)/ReferenceTemperature (get / set) + 1).

The NoiseFactor (get / set) defines how much noise the amplifier has. A NoiseFactor (get / set) of 1.0 indicates the Amplifier has no noise. A NoiseFactor (get / set) of 2 indicates a NoiseTemperature (get) equal to the ReferenceTemperature (get / set). The default value is 1.0.

getReferenceTemperature

public double getReferenceTemperature()

Gets the reference temperature for this amplifier, in kelvin.

The default value is 290 K.

setReferenceTemperature

public void setReferenceTemperature(double value)

Sets the reference temperature for this amplifier, in kelvin.

The default value is 290 K.

getNoiseTemperature

public double getNoiseTemperature()

Gets the noise temperature of the amplifier, in kelvin.