agi.foundation.radar

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

Class RadarWaveformProcessor

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.radar.RadarWaveformProcessor

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

FixedNumberOfPulsesWaveformIntegrator, GoalSignalToNoiseRatioWaveformIntegrator

public abstract class RadarWaveformProcessor
extends DefinitionalObject

Represents a radar signal processor that produces a ProcessedRadarWaveform instance from the Signal scattered from the target as well as any interference signals.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	attachSignalProcessorAsInput(SignalProcessor inputSignalProcessor) Attaches an SignalProcessor instance as the input for this waveform processor.
protected boolean	checkForSameDefinition(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected abstract 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.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
abstract Evaluator<ProcessedRadarWaveform>	getEvaluator(EvaluatorGroup group, IntendedSignalStrategy intendedSignalStrategy, SignalPropagationGraph graph, boolean evaluateInterference) Constructs a Evaluator instance from the input signal source, intended signal strategy, and signal propagation graph.
RadarWaveformProcessor	getInputWaveformProcessor() Gets the input to the waveform processor.
void	setInputWaveformProcessor(RadarWaveformProcessor value) Sets the input to the waveform processor.
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.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

RadarWaveformProcessor

protected RadarWaveformProcessor()

Initializes a new instance.

RadarWaveformProcessor

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

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(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).

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

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

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.

validateProperties

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

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

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:

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

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

getInputWaveformProcessor

public final RadarWaveformProcessor getInputWaveformProcessor()

Gets the input to the waveform processor.

setInputWaveformProcessor

public final void setInputWaveformProcessor(RadarWaveformProcessor value)

Sets the input to the waveform processor.

attachSignalProcessorAsInput

public final void attachSignalProcessorAsInput(SignalProcessor inputSignalProcessor)

Attaches an SignalProcessor instance as the input for this waveform processor.

Parameters:

inputSignalProcessor - The SignalProcessor from which this waveform processor will pull it's input signals.

getEvaluator

@Nonnull
public abstract Evaluator<ProcessedRadarWaveform> getEvaluator(@Nonnull
                                                                         EvaluatorGroup group,
                                                                         @Nonnull
                                                                         IntendedSignalStrategy intendedSignalStrategy,
                                                                         @Nonnull
                                                                         SignalPropagationGraph graph,
                                                                         boolean evaluateInterference)

Constructs a Evaluator instance from the input signal source, intended signal strategy, and signal propagation graph.

Parameters:

group - The evaluator group used to optimize the evaluators.

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

evaluateInterference - If enabled, the evaluator will compute interference in the processed waveform.

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

Returns:

An evaluator for evaluating ProcessedRadarWaveform instances.

Throws:

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