agi.foundation.communications

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

Class ScatteringCoefficient

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.communications.ScatteringCoefficient

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

ConstantCrossSectionScatteringCoefficient, SphericalTabularMonostaticCrossSectionScatteringCoefficient

public abstract class ScatteringCoefficient
extends DefinitionalObject

Modifies an incident signal by a scattering coefficient to produce a reflected signal.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract Signal	applyScatteringCoefficient(UnitCartesian incidentDirection, UnitCartesian reflectedDirection, UnitQuaternion sourceToSinkRotation, Signal inputSignal) Applies the scattering coefficient to the input signal.
SignalCollection	applyScatteringCoefficient(UnitCartesian incidentDirection, UnitCartesian reflectedDirection, UnitQuaternion sourceToSinkRotation, Signal primaryPolarizationInputSignal, Signal orthogonalPolarizationInputSignal) Applies the scattering coefficient to the input signals.
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(ScatteringCoefficient 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.
static ScatteringCoefficient	toScatteringCoefficient(double value) Converts a scattering coefficient as a double value to a ScatteringCoefficient.

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

ScatteringCoefficient

protected ScatteringCoefficient()

Initializes a new instance.

ScatteringCoefficient

protected ScatteringCoefficient(@Nonnull
                                ScatteringCoefficient 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(ScatteringCoefficient 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 ScatteringCoefficient.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

applyScatteringCoefficient

@Nonnull
public abstract Signal applyScatteringCoefficient(@Nonnull
                                                            UnitCartesian incidentDirection,
                                                            @Nonnull
                                                            UnitCartesian reflectedDirection,
                                                            @Nonnull
                                                            UnitQuaternion sourceToSinkRotation,
                                                            @Nonnull
                                                            Signal inputSignal)

Applies the scattering coefficient to the input signal.

Parameters:

incidentDirection - The incident direction.

reflectedDirection - The reflected direction.

sourceToSinkRotation - The unit quaternion which represents the rotation from the source axes to the sink axes.

inputSignal - The input signal to be modified by the scattering coefficient.

Returns:

The reflected signal which is the input signal modified by the computed scattering coefficient.

applyScatteringCoefficient

@Nonnull
public SignalCollection applyScatteringCoefficient(@Nonnull
                                                             UnitCartesian incidentDirection,
                                                             @Nonnull
                                                             UnitCartesian reflectedDirection,
                                                             @Nonnull
                                                             UnitQuaternion sourceToSinkRotation,
                                                             @Nonnull
                                                             Signal primaryPolarizationInputSignal,
                                                             Signal orthogonalPolarizationInputSignal)

Applies the scattering coefficient to the input signals.

Parameters:

incidentDirection - The incident direction.

reflectedDirection - The reflected direction.

sourceToSinkRotation - The unit quaternion which represents the rotation from the source axes to the sink axes.

primaryPolarizationInputSignal - The input signals from the primary polarization channel to be modified by the scattering coefficient.

orthogonalPolarizationInputSignal - The input signals from the orthogonal polarization channel to be modified by the scattering coefficient.

Returns:

The reflected signals which is the input signals modified by the computed scattering coefficient.

toScatteringCoefficient

@Nonnull
public static ScatteringCoefficient toScatteringCoefficient(double value)

Converts a scattering coefficient as a double value to a ScatteringCoefficient.

Parameters:

value - The value to convert.

Returns:

A new ScatteringCoefficient configured with the given scattering coefficient value.