public class SphericalTabularElectricFieldPattern extends Object implements IEquatable<SphericalTabularElectricFieldPattern>
| Constructor and Description |
|---|
SphericalTabularElectricFieldPattern(double[] clockAngleValues,
double[] coneAngleValues,
ElectricFieldVectorComponents[][] electricFieldComponents)
Initializes an instance given an array of clock angles, an array of cone angles, and a two-dimensional array of
ElectricFieldVectorComponents values. |
SphericalTabularElectricFieldPattern(SphericalTabularElectricFieldPattern existingInstance)
Initializes a new instance as a copy of an existing instance.
|
| Modifier and Type | Method and Description |
|---|---|
ElectricFieldVectorComponents |
computeElectricFieldComponents(Cartesian linkVector)
Computes the electric field vector components given the cartesian direction.
|
boolean |
equals(Object obj)
Indicates whether another object is exactly equal to this instance.
|
boolean |
equalsType(SphericalTabularElectricFieldPattern other)
Indicates whether another instance of this type is exactly equal to this instance.
|
List<Double> |
getClockAngleValues()
Gets the list of clock angle values that specify the azimuthal angle measured from the x-axis
in the x-y plane.
|
List<Double> |
getConeAngleValues()
Gets the list of cone angle values that specify the zenith angle measured from the z-axis.
|
int |
hashCode()
Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
|
public SphericalTabularElectricFieldPattern(@Nonnull double[] clockAngleValues, @Nonnull double[] coneAngleValues, @Nonnull ElectricFieldVectorComponents[][] electricFieldComponents)
ElectricFieldVectorComponents 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 electric field vector component
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 electric field vector component values array must be
the same size as the clock angles array and the second dimension of the electric field vector 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.clockAngleValues - 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.coneAngleValues - An array of cone angles. Cone angle is defined as the zenith angle from the positive z-axis to the point.electricFieldComponents - A two-dimensional array of electric field vector component values.ArgumentNullException - Thrown if clockAngleValues, coneAngleValues, or electricFieldComponents is null.ArgumentException - Thrown in the following cases:
clockAngleValues or coneAngleValues array arguments length is less than or equal to 1.clockAngleValues array argument length is not equal to the first dimension of the electricFieldComponents two-dimensional array.coneAngleValues array argument length is not equal to the second dimension of the electricFieldComponents two-dimensional arrayclockAngleValues.coneAngleValues.public SphericalTabularElectricFieldPattern(@Nonnull SphericalTabularElectricFieldPattern existingInstance)
existingInstance - The existing instance to copy.public boolean equals(Object obj)
equals in class Objectobj - The object to compare to this instance.true if obj is an instance of this type and represents the same value as this instance; otherwise false.Object.hashCode(),
HashMappublic final boolean equalsType(SphericalTabularElectricFieldPattern other)
equalsType in interface IEquatable<SphericalTabularElectricFieldPattern>other - The instance to compare to this instance.true if other represents the same value as this instance; otherwise false.public int hashCode()
hashCode in class ObjectObject.equals(java.lang.Object),
System.identityHashCode(java.lang.Object)@Nonnull public final ElectricFieldVectorComponents computeElectricFieldComponents(@Nonnull Cartesian linkVector)
linkVector - Cartesian which represents the direction at which the electric field components should be computed.@Nonnull public final List<Double> getClockAngleValues()