public class SphericalTabularGainData extends Function2<Cartesian,Double>
CustomGainPattern
class to model an antenna pattern using measured gain data.| Modifier | Constructor and Description |
|---|---|
|
SphericalTabularGainData(double[] phiValues,
double[] thetaValues,
double[][] gainValues,
boolean gainValuesAreDecibel)
Initializes an instance given an array of theta values, an array of phi values, and a multidimensional array of gain values.
|
protected |
SphericalTabularGainData(SphericalTabularGainData existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
| Modifier and Type | Method and Description |
|---|---|
Object |
clone(CopyContext context)
Clones this object using the specified context.
|
protected void |
dispose(boolean disposing)
Releases any resources associated with this instance.
|
Double |
evaluate(Cartesian direction)
Evaluate the gain given the cartesian direction expressed in the antennas axes.
|
Motion1<Double> |
evaluate(Cartesian direction,
int order)
Evaluate the gain given the cartesian direction expressed in the antennas axes.
|
double |
getGainDecibel(int phiIndex,
int thetaIndex)
Gets the gain value in decibel units at the given phi, theta indices.
|
boolean |
getIsThreadSafe()
Gets a value indicating whether the methods on this instance are safe to call from
multiple threads simultaneously.
|
List<Double> |
getPhiValues()
Gets the list of phi values that specify the azimuthal angle measured from the x-axis
in the x-y plane.
|
List<Double> |
getThetaValues()
Gets the list of theta values that specify the zenith angle measured from the z-axis.
|
dispose, getNextSampleSuggestionclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclosepublic SphericalTabularGainData(@Nonnull double[] phiValues, @Nonnull double[] thetaValues, @Nonnull double[][] gainValues, boolean gainValuesAreDecibel)
This type represents an exception in the library which otherwise uses linear units. The gain values are stored in decibels because the interpolation scheme interpolates in decibels rather than linear units. The gain produced by the evaluate method is still in linear units.
phiValues - An array of phi values. Phi is defined as the azimuth angle from the positive x-axis to the orthogonal projection of the
point in the x-y plane.thetaValues - An array of theta values. Theta is defined as the zenith angle from the positive z-axis to the point.gainValues - A multidimensional array of gain values.gainValuesAreDecibel - True if the values in the gainValues array are in decibels.
False if the values in the gainValues array are in linear units.ArgumentNullException - Thrown when phiValues, thetaValues or gainValues is null.protected SphericalTabularGainData(@Nonnull SphericalTabularGainData existingInstance, @Nonnull CopyContext context)
See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor
in a derived class.
existingInstance - The existing instance to copy.context - A CopyContext that controls the depth of the copy.ArgumentNullException - Thrown when existingInstance or context is null.public Object clone(CopyContext 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:
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:
CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to
non-evaluators.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the
same CopyContext passed to the constructor.
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;public boolean getIsThreadSafe()
If this property is true, all methods and properties are guaranteed to be thread safe.
Conceptually, an object that returns true for this method acts as if there is a lock
protecting each method and property such that only one thread at a time can be inside any method or
property in the class. In reality, such locks are generally not used and are in fact discouraged. However,
the user must not experience any exceptions or inconsistent behavior that would not be experienced if such
locks were used.
If this property is false, the behavior when using this class from multiple threads
simultaneously is undefined and may include inconsistent results and exceptions. Clients wishing to use
multiple threads should call CopyForAnotherThread.copy(T) to get a separate instance of the
object for each thread.
getIsThreadSafe in interface IThreadAwaregetIsThreadSafe in class Function2<Cartesian,Double>protected void dispose(boolean disposing)
public Double evaluate(@Nonnull Cartesian direction)
@Nonnull public Motion1<Double> evaluate(@Nonnull Cartesian direction, int order)
evaluate in class Function2<Cartesian,Double>direction - Cartesian which represents the direction at which the gain should be evaluated.order - The suggested order of the evaluation
(which for this method is ignored and the result will be zeroth order).@Nonnull public final List<Double> getPhiValues()
@Nonnull public final List<Double> getThetaValues()
public final double getGainDecibel(int phiIndex,
int thetaIndex)
This represents an exception in the library which otherwise uses linear units. The gain values are held in decibels because the interpolation scheme interpolates in decibels rather than linear units. The gain produced by the evaluate method is still in linear units.
phiIndex - The desired phi index.thetaIndex - the desired theta index.