agi.foundation.communications.signalprocessing

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

Class LowNoiseAmplifier

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.signalprocessing.SignalProcessor

agi.foundation.communications.signalprocessing.Amplifier

agi.foundation.communications.signalprocessing.LowNoiseAmplifier

All Implemented Interfaces:

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

public class LowNoiseAmplifier
extends Amplifier

A signal processor which applies several gains to its input, representing a low noise amplifier.

Constructor Summary

Constructors

Modifier	Constructor and Description
	LowNoiseAmplifier() Initializes a new instance.
protected	LowNoiseAmplifier(LowNoiseAmplifier existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.
	LowNoiseAmplifier(SignalProcessor input, double preLnaGain, double lnaGain, double postLnaGain, double noiseFactor, double referenceTemperature) Initializes a new instance from the given signal input, amplification gains, noise factor, and reference temperature.

Method Summary

Modifier and Type	Method and Description
protected 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(LowNoiseAmplifier other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
Object	clone(CopyContext context) Clones this object using the specified context.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
SignalProcessor	getInputSignalProcessor() Gets the signal processor which produces the set of signals which this processor modifies.
double	getLnaGain() Gets the gain to apply to the input signal.
double	getLnaInputGain() Gets the gain applied before the signal is amplified.
double	getLnaOutputGain() Gets the gain applied after the signal has been amplified.
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 system noise temperature calculated from the different gain values, the NoiseFactor (get / set) and the ReferenceTemperature (get / set).
double	getReferenceTemperature() Gets the amplifier's operating temperature.
SignalEvaluator	getSignalEvaluator(EvaluatorGroup group, SignalPropagationGraph graph) Get an evaluator which modifies the InputSignalProcessor (get / set) by applying the LnaGain (get / set).
void	setInputSignalProcessor(SignalProcessor value) Sets the signal processor which produces the set of signals which this processor modifies.
void	setLnaGain(double value) Sets the gain to apply to the input signal.
void	setLnaInputGain(double value) Sets the gain applied before the signal is amplified.
void	setLnaOutputGain(double value) Sets the gain applied after the signal has been amplified.
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 amplifier's operating temperature.

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

checkForSameDefinition

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

checkForSameDefinition, getProcessingDelay, getService, getSignalEvaluator, getSignalOutput

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, 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

LowNoiseAmplifier

public LowNoiseAmplifier()

Initializes a new instance.

LowNoiseAmplifier

public LowNoiseAmplifier(SignalProcessor input,
                         double preLnaGain,
                         double lnaGain,
                         double postLnaGain,
                         double noiseFactor,
                         double referenceTemperature)

Initializes a new instance from the given signal input, amplification gains, noise factor, and reference temperature.

Parameters:

input - The signal processor producing the signal to be amplified.

preLnaGain - The gain applied before the signal is amplified.

lnaGain - The gain applied by the amplifier.

postLnaGain - The gain applied after the signal is amplified.

noiseFactor - The noise factor of the amplifier.

referenceTemperature - The reference temperature of the amplifier.

LowNoiseAmplifier

protected LowNoiseAmplifier(@Nonnull
                            LowNoiseAmplifier 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

clone

public Object clone(CopyContext context)

Clones this object using the specified context.

This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.

A typical implementation of ICloneWithContext:

public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}

In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.

alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}

If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.

public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;

Specified by:

clone in interface ICloneWithContext

Specified by:

clone in class DefinitionalObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected final 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).

Specified by:

checkForSameDefinition in class Amplifier

Parameters:

other - The other instance to compare to this one.

Returns:

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

checkForSameDefinition

protected boolean checkForSameDefinition(LowNoiseAmplifier 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 LowNoiseAmplifier.checkForSameDefinition(agi.foundation.communications.signalprocessing.Amplifier) method.

Overrides:

computeCurrentDefinitionHashCode in class Amplifier

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(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.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class DefinitionalObject

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

getInputSignalProcessor

public SignalProcessor getInputSignalProcessor()

Gets the signal processor which produces the set of signals which this processor modifies.

Specified by:

getInputSignalProcessor in class SignalProcessor

setInputSignalProcessor

public void setInputSignalProcessor(SignalProcessor value)

Sets the signal processor which produces the set of signals which this processor modifies.

Specified by:

setInputSignalProcessor in class SignalProcessor

getNoiseTemperature

public double getNoiseTemperature()

Gets the system noise temperature calculated from the different gain values, the NoiseFactor (get / set) and the ReferenceTemperature (get / set).

Overrides:

getNoiseTemperature in class Amplifier

getLnaInputGain

public final double getLnaInputGain()

Gets the gain applied before the signal is amplified. Typically due to cabling from the antenna to the LNA. Note that if this is a loss, the Gain should be less than 1.

setLnaInputGain

public final void setLnaInputGain(double value)

Sets the gain applied before the signal is amplified. Typically due to cabling from the antenna to the LNA. Note that if this is a loss, the Gain should be less than 1.

getReferenceTemperature

public double getReferenceTemperature()

Gets the amplifier's operating temperature. Note that this temperature is used for both the input and output.

Overrides:

getReferenceTemperature in class Amplifier

setReferenceTemperature

public void setReferenceTemperature(double value)

Sets the amplifier's operating temperature. Note that this temperature is used for both the input and output.

Overrides:

setReferenceTemperature in class Amplifier

getLnaOutputGain

public final double getLnaOutputGain()

Gets the gain applied after the signal has been amplified. Typically due to cabling from the LNA to the receiver. Note that if this is a loss, the LnaOutputGain (get / set) should be less than 1.

setLnaOutputGain

public final void setLnaOutputGain(double value)

Sets the gain applied after the signal has been amplified. Typically due to cabling from the LNA to the receiver. Note that if this is a loss, the LnaOutputGain (get / set) should be less than 1.

getLnaGain

public final double getLnaGain()

Gets the gain to apply to the input signal.

setLnaGain

public final void setLnaGain(double value)

Sets the gain to apply to the input signal.

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.

Overrides:

getNoiseFactor in class Amplifier

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.

Overrides:

setNoiseFactor in class Amplifier

getSignalEvaluator

public SignalEvaluator getSignalEvaluator(EvaluatorGroup group,
                                          SignalPropagationGraph graph)

Get an evaluator which modifies the InputSignalProcessor (get / set) by applying the LnaGain (get / set).

Specified by:

getSignalEvaluator in interface ISignalSource

Specified by:

getSignalEvaluator in class SignalProcessor

Parameters:

group - The evaluator group in which to create the evaluator.

graph - The graph of the communication links used to propagate signals.

Returns:

An evaluator which modifies the InputSignalProcessor (get / set) by applying the LnaGain (get / set).

Throws:

ArgumentNullException - Thrown when group or graph is null.