SphericalTabularMonostaticCrossSectionScatteringCoefficient

java.lang.Object
- agi.foundation.infrastructure.DefinitionalObject
- - agi.foundation.communications.ScatteringCoefficient
  - - agi.foundation.communications.SphericalTabularMonostaticCrossSectionScatteringCoefficient

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

AnsysHfssCrossSectionScatteringCoefficient
```
public class SphericalTabularMonostaticCrossSectionScatteringCoefficient
extends ScatteringCoefficient
```
A ScatteringCoefficient which is represented by monostatic tabular cross section values provided in a spherical coordinate system. Each cross section value is a 2x2 complex polarization scattering matrix. The 2x2 radar cross section scattering matrix may be specified for linear or circular polarization.
The 2x2 complex scattering matrix cross section value is evaluated by first computing the monostatic direction vector, which is the bisection of the incident and reflected unit vectors. Then from the monostatic direction, the cone angle and clock angle are computed in the spherical coordinate system. The cross section value is the obtained by interpolating the cross section table data using the computed cone and clock angles.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable` Type which represents the 2x2 complex scattering matrix cross section value table data.
`static class`	`SphericalTabularMonostaticCrossSectionScatteringCoefficient.PolarizationScatteringBasis` The scattering basis associated with the 2x2 complex scattering matrix cross section values.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`SphericalTabularMonostaticCrossSectionScatteringCoefficient(double[] coneAngles, ComplexCrossSectionScatteringCoefficient[] crossSectionValues)` Initializes an instance given an array of cone angles, in radians, and an array of monostatic cross section values represented as a complex 2x2 scattering matrix.
	`SphericalTabularMonostaticCrossSectionScatteringCoefficient(double[] coneAngles, double[] crossSectionValues)` Initializes an instance given an array of cone angles, in radians, and an array of monostatic cross section values, in meters squared.
	`SphericalTabularMonostaticCrossSectionScatteringCoefficient(double[] clockAngles, double[] coneAngles, ComplexCrossSectionScatteringCoefficient[][] crossSectionValues)` Initializes an instance given an array of clock angles, an array of cone angles, and a two-dimensional array of monostatic cross section values represented as a complex 2x2 scattering matrix.
	`SphericalTabularMonostaticCrossSectionScatteringCoefficient(double[] clockAngles, double[] coneAngles, double[][] crossSectionValues)` Initializes an instance given an array of clock angles, an array of cone angles, and a two-dimensional array of monostatic cross section values, in meters squared.
	`SphericalTabularMonostaticCrossSectionScatteringCoefficient(SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable crossSectionScatteringMatrixTable)` Initializes a new instance.
`protected`	`SphericalTabularMonostaticCrossSectionScatteringCoefficient(SphericalTabularMonostaticCrossSectionScatteringCoefficient existingInstance, CopyContext context)` Initializes a new instance as a copy of an existing instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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(ScatteringCoefficient other)` Checks to determine if another instance has the same definition as this instance and returns `true` if it does.
`protected boolean`	`checkForSameDefinition(SphericalTabularMonostaticCrossSectionScatteringCoefficient 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.
`protected ComplexCrossSectionScatteringCoefficient`	`computeScatteringCoefficient(Spherical monoStaticDirection)` Computes the scattering coefficient in the supplied monostatic direction.
`protected ComplexCrossSectionScatteringCoefficient`	`computeScatteringCoefficient(UnitCartesian monoStaticDirection)` Computes the scattering coefficient in the supplied monostatic direction.
`void`	`enumerateDependencies(DependencyEnumerator enumerator)` Enumerates the dependencies of this object by calling `DependencyEnumerator#enumerate(T)` for each object that this object directly depends upon.
`double`	`get(int clockAngleIndex, int coneAngleIndex)` Gets the cross section value, in meters squared, at the given clock and cone angle indices.
`List<Double>`	`getClockAngles()` Gets the clock angles.
`List<Double>`	`getConeAngles()` Gets the cone angles.
`boolean`	`getIsSymmetrical()` Gets a value indicating whether or not the pattern is symmetrical.

Methods inherited from class agi.foundation.communications.ScatteringCoefficient
checkForSameDefinition, toScatteringCoefficient

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SphericalTabularMonostaticCrossSectionScatteringCoefficient
```
public SphericalTabularMonostaticCrossSectionScatteringCoefficient(@Nonnull
                                                                   SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable crossSectionScatteringMatrixTable)
```
    Initializes a new instance.
    
    Parameters:
    
    crossSectionScatteringMatrixTable - The 2x2 complex scattering matrix cross section table data.
    
    Throws:
    
    ArgumentNullException - Thrown if the crossSectionScatteringMatrixTable argument is null.
  - SphericalTabularMonostaticCrossSectionScatteringCoefficient
```
public SphericalTabularMonostaticCrossSectionScatteringCoefficient(double[] coneAngles,
                                                                   double[] crossSectionValues)
```
    Initializes an instance given an array of cone angles, in radians, and an array of monostatic cross section values, in meters squared. This represents a symmetrical pattern about the z-axis. For a given cone angle, the cross section is the same for every clock angle about the z-axis.
    The polarization scattering basis defaults to T:AGI.Foundation.Graphics.SetHint when using this constructor.
    
    Parameters:
    
    coneAngles - An array of cone angles. The cone angle is defined as the zenith angle from the positive z-axis to the point.
    
    crossSectionValues - An array of cross section values in meters squared.
    
    Throws:
    
    ArgumentNullException - Thrown if either the coneAngles or crossSectionValues arguments are null.
    
    ArgumentException - Thrown if the coneAngles array argument length is less than or equal to 1. Thrown if the coneAngles array argument and crossSectionValues array argument do not have the same length. Thrown if there is less than 1 unique cone angle value in the coneAngles array argument.
  - SphericalTabularMonostaticCrossSectionScatteringCoefficient
```
public SphericalTabularMonostaticCrossSectionScatteringCoefficient(double[] coneAngles,
                                                                   ComplexCrossSectionScatteringCoefficient[] crossSectionValues)
```
    Initializes an instance given an array of cone angles, in radians, and an array of monostatic cross section values represented as a complex 2x2 scattering matrix. This represents a symmetrical pattern about the z-axis. For a given cone angle, the cross section is the same for every clock angle about the z-axis.
    The polarization scattering basis defaults to T:AGI.Foundation.Graphics.SetHint when using this constructor.
    
    Parameters:
    
    coneAngles - An array of cone angles. The cone angle is defined as the zenith angle from the positive z-axis to the point.
    
    crossSectionValues - An array of cross section values represented as a complex 2x2 scattering matrix.
    
    Throws:
    
    ArgumentNullException - Thrown if either the coneAngles or crossSectionValues arguments are null.
    
    ArgumentException - Thrown if the coneAngles array argument length is less than or equal to 1. Thrown if the coneAngles array argument and crossSectionValues array argument do not have the same length. Thrown if there is less than 1 unique cone angle value in the coneAngles array argument.
  - SphericalTabularMonostaticCrossSectionScatteringCoefficient
```
public SphericalTabularMonostaticCrossSectionScatteringCoefficient(double[] clockAngles,
                                                                   double[] coneAngles,
                                                                   double[][] crossSectionValues)
```
    Initializes an instance given an array of clock angles, an array of cone angles, and a two-dimensional array of monostatic cross section values, in meters squared. Clock angle is defined as the azimuth angle from the positive x-axis to the orthogonal projection of the point in the x-y plane. Cone angle is defined as the zenith angle from the positive z-axis to the point. The cross section values array must be arranged such that the rows of the array represent clock angle cuts through the pattern and the columns represent cone angle cuts. Therefore, the first dimension of the cross section values array must be the same size as the clock angles array and the second dimension of the cross section values array must be the same size as the cone angles array. If duplicate clock/cone angle points are found, the first one that is found will be kept and subsequent clock/cone angle points are ignored. For example, if the clock angle array contains a value of 0 degrees and a value of 360 degrees (same cut through the sphere) all of the cone angles at clock angle equal to 360 degrees will be ignored.
    The polarization scattering basis defaults to T:AGI.Foundation.Graphics.SetHint when using this constructor.
    Parameters:
    
    clockAngles - An array of clock angles. Clock angle is defined as the azimuth angle from the positive x-axis to the orthogonal projection of the point in the x-y plane.
    
    coneAngles - An array of cone angles. Cone angle is defined as the zenith angle from the positive z-axis to the point.
    
    crossSectionValues - A two-dimensional array of cross section values, in meters squared.
    
    Throws:
    
    ArgumentNullException - Thrown if clockAngles, coneAngles, or crossSectionValues is null.
    ArgumentException -
    Thrown in the following cases:
    
    the clockAngles or coneAngles array arguments length is less than or equal to 1.
    
    the clockAngles array argument length is not equal to the first dimension of the crossSectionValues two-dimensional array.
    
    the coneAngles array argument length is not equal to the second dimension of the crossSectionValues two-dimensional array
    
    there is less than 1 unique clock angle value in clockAngles.
    
    there is less than 1 unique cone angle value in coneAngles.
  - SphericalTabularMonostaticCrossSectionScatteringCoefficient
```
public SphericalTabularMonostaticCrossSectionScatteringCoefficient(double[] clockAngles,
                                                                   double[] coneAngles,
                                                                   ComplexCrossSectionScatteringCoefficient[][] crossSectionValues)
```
    Initializes an instance given an array of clock angles, an array of cone angles, and a two-dimensional array of monostatic cross section values represented as a complex 2x2 scattering matrix. Clock angle is defined as the azimuth angle from the positive x-axis to the orthogonal projection of the point in the x-y plane. Cone angle is defined as the zenith angle from the positive z-axis to the point. The cross section values array must be arranged such that the rows of the array represent clock angle cuts through the pattern and the columns represent cone angle cuts. Therefore, the first dimension of the cross section values array must be the same size as the clock angles array and the second dimension of the cross section values array must be the same size as the cone angles array. If duplicate clock/cone angle points are found, the first one that is found will be kept and subsequent clock/cone angle points are ignored. For example, if the clock angle array contains a value of 0 degrees and a value of 360 degrees (same cut through the sphere) all of the cone angles at clock angle equal to 360 degrees will be ignored.
    The polarization scattering basis defaults to T:AGI.Foundation.Graphics.SetHint when using this constructor.
    Parameters:
    
    clockAngles - An array of clock angles. Clock angle is defined as the azimuth angle from the positive x-axis to the orthogonal projection of the point in the x-y plane.
    
    coneAngles - An array of cone angles. Cone angle is defined as the zenith angle from the positive z-axis to the point.
    
    crossSectionValues - A two-dimensional array of cross section values represented as a complex 2x2 scattering matrix.
    
    Throws:
    
    ArgumentNullException - Thrown if clockAngles, coneAngles, or crossSectionValues is null.
    ArgumentException -
    Thrown in the following cases:
    
    the clockAngles or coneAngles array arguments length is less than or equal to 1.
    
    the clockAngles array argument length is not equal to the first dimension of the crossSectionValues two-dimensional array.
    
    the coneAngles array argument length is not equal to the second dimension of the crossSectionValues two-dimensional array
    
    there is less than 1 unique clock angle value in clockAngles.
    
    there is less than 1 unique cone angle value in coneAngles.
  - SphericalTabularMonostaticCrossSectionScatteringCoefficient
```
protected SphericalTabularMonostaticCrossSectionScatteringCoefficient(@Nonnull
                                                                      SphericalTabularMonostaticCrossSectionScatteringCoefficient 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(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).
    
    Specified by:
    
    checkForSameDefinition in class ScatteringCoefficient
    
    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(SphericalTabularMonostaticCrossSectionScatteringCoefficient 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 SphericalTabularMonostaticCrossSectionScatteringCoefficient.checkForSameDefinition(agi.foundation.communications.ScatteringCoefficient) method.
    
    Overrides:
    
    computeCurrentDefinitionHashCode in class ScatteringCoefficient
    
    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.
  - getConeAngles
```
@Nonnull
public final List<Double> getConeAngles()
```
    Gets the cone angles.
  - getClockAngles
```
@Nonnull
public final List<Double> getClockAngles()
```
    Gets the clock angles.
  - get
```
public final double get(int clockAngleIndex,
                        int coneAngleIndex)
```
    Gets the cross section value, in meters squared, at the given clock and cone angle indices.
    
    Parameters:
    
    clockAngleIndex - The desired clock angle index.
    
    coneAngleIndex - the desired cone angle index.
    
    Returns:
    
    The cross section value in meters squared.
  - getIsSymmetrical
```
public final boolean getIsSymmetrical()
```
    Gets a value indicating whether or not the pattern is symmetrical.
  - computeScatteringCoefficient
```
@Nonnull
protected ComplexCrossSectionScatteringCoefficient computeScatteringCoefficient(@Nonnull
                                                                                          UnitCartesian monoStaticDirection)
```
    Computes the scattering coefficient in the supplied monostatic direction.
    
    Parameters:
    
    monoStaticDirection - The monostatic direction used to compute the scattering coefficient.
    
    Returns:
    
    The scattering coefficient as a 2x2 complex matrix.
  - computeScatteringCoefficient
```
@Nonnull
protected final ComplexCrossSectionScatteringCoefficient computeScatteringCoefficient(@Nonnull
                                                                                                Spherical monoStaticDirection)
```
    Computes the scattering coefficient in the supplied monostatic direction.
    
    Parameters:
    
    monoStaticDirection - The monostatic direction used to compute the scattering coefficient.
    
    Returns:
    
    The scattering coefficient as a 2x2 complex matrix.
  - applyScatteringCoefficient
```
public Signal applyScatteringCoefficient(@Nonnull
                                         UnitCartesian incidentDirection,
                                         @Nonnull
                                         UnitCartesian reflectedDirection,
                                         @Nonnull
                                         UnitQuaternion sourceToSinkRotation,
                                         Signal inputSignal)
```
    Applies the scattering coefficient to the input signal.
    
    Specified by:
    
    applyScatteringCoefficient in class ScatteringCoefficient
    
    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
```
public SignalCollection applyScatteringCoefficient(@Nonnull
                                                   UnitCartesian incidentDirection,
                                                   @Nonnull
                                                   UnitCartesian reflectedDirection,
                                                   @Nonnull
                                                   UnitQuaternion sourceToSinkRotation,
                                                   Signal primaryPolarizationInputSignal,
                                                   Signal orthogonalPolarizationInputSignal)
```
    Applies the scattering coefficient to the input signals.
    
    Overrides:
    
    applyScatteringCoefficient in class ScatteringCoefficient
    
    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.

Class SphericalTabularMonostaticCrossSectionScatteringCoefficient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class agi.foundation.communications.ScatteringCoefficient

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

Methods inherited from class java.lang.Object

Constructor Detail

SphericalTabularMonostaticCrossSectionScatteringCoefficient

SphericalTabularMonostaticCrossSectionScatteringCoefficient

SphericalTabularMonostaticCrossSectionScatteringCoefficient

SphericalTabularMonostaticCrossSectionScatteringCoefficient

SphericalTabularMonostaticCrossSectionScatteringCoefficient

Method Detail

clone

checkForSameDefinition

checkForSameDefinition

computeCurrentDefinitionHashCode

enumerateDependencies

getConeAngles

getClockAngles

get

getIsSymmetrical

computeScatteringCoefficient

computeScatteringCoefficient

applyScatteringCoefficient

applyScatteringCoefficient