agi.foundation.communications

Class SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable

java.lang.Object

agi.foundation.communications.SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable

All Implemented Interfaces:

IEquatable<SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable>

Enclosing class:

SphericalTabularMonostaticCrossSectionScatteringCoefficient

public static final class SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable
extends Object
implements IEquatable<SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable>

Type which represents the 2x2 complex scattering matrix cross section value table data. The scattering data is arranged in a matrix where the first dimension (rows) count equals the number of clock angles and the second dimension (columns) equals the number of cone angles.

Constructor Summary

Constructors

Constructor and Description
CrossSectionScatteringMatrixSphericalTable(double[] coneAngles, ComplexCrossSectionScatteringCoefficient[] crossSectionValues, SphericalTabularMonostaticCrossSectionScatteringCoefficient.PolarizationScatteringBasis polarizationScatteringBasis, Double frequency) Initializes a new instance given an array of cone angles, in radians, and an array of .
CrossSectionScatteringMatrixSphericalTable(double[] clockAngles, double[] coneAngles, ComplexCrossSectionScatteringCoefficient[][] crossSectionValues, SphericalTabularMonostaticCrossSectionScatteringCoefficient.PolarizationScatteringBasis polarizationScatteringBasis, Double frequency) Initializes an instance given an array of clock angles, an array of cone angles, and a two-dimensional array of ComplexCrossSectionScatteringCoefficient values.
CrossSectionScatteringMatrixSphericalTable(double[] clockAngles, double[] coneAngles, double[][] crossSectionValues, SphericalTabularMonostaticCrossSectionScatteringCoefficient.PolarizationScatteringBasis polarizationScatteringBasis, Double frequency) Initializes an instance given an array of clock angles, an array of cone angles, and a two-dimensional array of real cross section values, in meters squared.
CrossSectionScatteringMatrixSphericalTable(double[] coneAngles, double[] crossSectionValues, SphericalTabularMonostaticCrossSectionScatteringCoefficient.PolarizationScatteringBasis polarizationScatteringBasis, Double frequency) Initializes a new instance given an array of cone angles, in radians, and an array of real cross section values, in meters squared.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equalsType(SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable other) Indicates whether another instance of this type is exactly equal to this instance.
double[]	getClockAngles() Gets the array of clock angles.
double[]	getConeAngles() Gets the array of cone angles.
ComplexCrossSectionScatteringCoefficient[][]	getCrossSectionValues() Gets the 2x2 complex cross section scattering coefficient matrix.
Double	getFrequency() Gets the associated frequency of the complex scattering coefficient matrix data.
boolean	getIsSymmetrical() Gets a value indicating whether or not the table is symmetrical about the z-axis.
SphericalTabularMonostaticCrossSectionScatteringCoefficient.PolarizationScatteringBasis	getScatteringBasis() Gets the polarization scattering basis.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CrossSectionScatteringMatrixSphericalTable

public CrossSectionScatteringMatrixSphericalTable(double[] clockAngles,
                                                  double[] coneAngles,
                                                  @Nonnull
                                                  ComplexCrossSectionScatteringCoefficient[][] crossSectionValues,
                                                  @Nonnull
                                                  SphericalTabularMonostaticCrossSectionScatteringCoefficient.PolarizationScatteringBasis polarizationScatteringBasis,
                                                  @Nullable
                                                  Double frequency)

Initializes an instance given an array of clock angles, an array of cone angles, and a two-dimensional array of ComplexCrossSectionScatteringCoefficient values. 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 component values array must be the same size as the clock angles array and the second dimension of the cross section component 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. /

Parameters:

clockAngles - The array of clock angle values.

coneAngles - The array of cone angle values.

crossSectionValues - A two-dimensional array of which represent the cross section values.

polarizationScatteringBasis - The polarization scattering basis.

frequency - The frequency associated with the scattering coefficient data.

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.

See Also:

ComplexCrossSectionScatteringCoefficient

CrossSectionScatteringMatrixSphericalTable

public CrossSectionScatteringMatrixSphericalTable(double[] clockAngles,
                                                  double[] coneAngles,
                                                  double[][] crossSectionValues,
                                                  @Nonnull
                                                  SphericalTabularMonostaticCrossSectionScatteringCoefficient.PolarizationScatteringBasis polarizationScatteringBasis,
                                                  @Nullable
                                                  Double frequency)

Initializes an instance given an array of clock angles, an array of cone angles, and a two-dimensional array of real 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 component values array must be the same size as the clock angles array and the second dimension of the cross section component 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. /

Parameters:

clockAngles - The array of clock angle values.

coneAngles - The array of cone angle values.

crossSectionValues - A two-dimensional array of real cross section values, in meters squared.

polarizationScatteringBasis - The polarization scattering basis.

frequency - The frequency associated with the scattering coefficient data.

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.

CrossSectionScatteringMatrixSphericalTable

public CrossSectionScatteringMatrixSphericalTable(@Nonnull
                                                  double[] coneAngles,
                                                  @Nonnull
                                                  ComplexCrossSectionScatteringCoefficient[] crossSectionValues,
                                                  @Nonnull
                                                  SphericalTabularMonostaticCrossSectionScatteringCoefficient.PolarizationScatteringBasis polarizationScatteringBasis,
                                                  @Nullable
                                                  Double frequency)

Initializes a new instance given an array of cone angles, in radians, and an array of . 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.

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 which represent the cross section values.

polarizationScatteringBasis - The polarization scattering basis.

frequency - The frequency associated with the scattering coefficient data.

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.

See Also:

ComplexCrossSectionScatteringCoefficient, ComplexCrossSectionScatteringCoefficient

CrossSectionScatteringMatrixSphericalTable

public CrossSectionScatteringMatrixSphericalTable(double[] coneAngles,
                                                  double[] crossSectionValues,
                                                  @Nonnull
                                                  SphericalTabularMonostaticCrossSectionScatteringCoefficient.PolarizationScatteringBasis polarizationScatteringBasis,
                                                  @Nullable
                                                  Double frequency)

Initializes a new instance given an array of cone angles, in radians, and an array of real 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.

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 real cross section values, in meters squared.

polarizationScatteringBasis - The polarization scattering basis.

frequency - The frequency associated with the scattering coefficient data.

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.

Method Detail

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

equalsType

public final boolean equalsType(SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<SphericalTabularMonostaticCrossSectionScatteringCoefficient.CrossSectionScatteringMatrixSphericalTable>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

getClockAngles

public final double[] getClockAngles()

Gets the array of clock angles.

getConeAngles

public final double[] getConeAngles()

Gets the array of cone angles.

getIsSymmetrical

public final boolean getIsSymmetrical()

Gets a value indicating whether or not the table is symmetrical about the z-axis.

getCrossSectionValues

public final ComplexCrossSectionScatteringCoefficient[][] getCrossSectionValues()

Gets the 2x2 complex cross section scattering coefficient matrix.

getFrequency

@Nullable
public final Double getFrequency()

Gets the associated frequency of the complex scattering coefficient matrix data.

getScatteringBasis

@Nonnull
public final SphericalTabularMonostaticCrossSectionScatteringCoefficient.PolarizationScatteringBasis getScatteringBasis()

Gets the polarization scattering basis.