agi.foundation.radar

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

Class GoalSignalToNoiseRatioWaveformIntegrator

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.radar.RadarWaveformProcessor

agi.foundation.radar.GoalSignalToNoiseRatioWaveformIntegrator

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

ConstantEfficiencyGoalSignalToNoiseRatioWaveformIntegrator, PerfectGoalSignalToNoiseRatioWaveformIntegrator

public abstract class GoalSignalToNoiseRatioWaveformIntegrator
extends RadarWaveformProcessor

A radar waveform integrator which will integrate as many pulses as necessary in order to reach a goal signal-to-noise ratio.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GoalSignalToNoiseRatioWaveformIntegrator() Initializes a new instance.
protected	GoalSignalToNoiseRatioWaveformIntegrator(double goalSignalToNoiseRatio) Initializes a new instance.
protected	GoalSignalToNoiseRatioWaveformIntegrator(GoalSignalToNoiseRatioWaveformIntegrator 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(GoalSignalToNoiseRatioWaveformIntegrator other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(RadarWaveformProcessor 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	getGoalSignalToNoiseRatio() Gets the goal signal-to-noise ratio, after integration.
void	setGoalSignalToNoiseRatio(double value) Sets the goal signal-to-noise ratio, after integration.
protected void	validateProperties(EvaluatorGroup group, IntendedSignalStrategy intendedSignalStrategy, SignalPropagationGraph graph) Validates that required properties and parameters are configured correctly in order to get an evaluator for this instance.

Methods inherited from class agi.foundation.radar.RadarWaveformProcessor

attachSignalProcessorAsInput, checkForSameDefinition, enumerateDependencies, getEvaluator, getInputWaveformProcessor, setInputWaveformProcessor

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, 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

GoalSignalToNoiseRatioWaveformIntegrator

protected GoalSignalToNoiseRatioWaveformIntegrator()

Initializes a new instance.

GoalSignalToNoiseRatioWaveformIntegrator

protected GoalSignalToNoiseRatioWaveformIntegrator(double goalSignalToNoiseRatio)

Initializes a new instance.

Parameters:

goalSignalToNoiseRatio - The desired signal-to-noise ratio, after integration.

GoalSignalToNoiseRatioWaveformIntegrator

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

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(GoalSignalToNoiseRatioWaveformIntegrator 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 GoalSignalToNoiseRatioWaveformIntegrator.checkForSameDefinition(agi.foundation.radar.RadarWaveformProcessor) method.

Overrides:

computeCurrentDefinitionHashCode in class RadarWaveformProcessor

Returns:

The computed hash code.

getGoalSignalToNoiseRatio

public final double getGoalSignalToNoiseRatio()

Gets the goal signal-to-noise ratio, after integration.

setGoalSignalToNoiseRatio

public final void setGoalSignalToNoiseRatio(double value)

Sets the goal signal-to-noise ratio, after integration.

validateProperties

protected void validateProperties(EvaluatorGroup group,
                                  IntendedSignalStrategy intendedSignalStrategy,
                                  SignalPropagationGraph graph)

Validates that required properties and parameters are configured correctly in order to get an evaluator for this instance.

Overrides:

validateProperties in class RadarWaveformProcessor

Parameters:

group - The evaluator group used to optimize the evaluators.

intendedSignalStrategy - The intended signal strategy used to choose one of the signals in the signal collection.

graph - The signal propagation graph, which represents all of the signal paths in the analysis.

Throws:

PropertyInvalidException - Thrown when GoalSignalToNoiseRatio (get / set) is less than zero.

ArgumentNullException - Thrown when group, intendedSignalStrategy, or graph is null.

PropertyInvalidException - Thrown when InputWaveformProcessor (get / set) is null.