Click or drag to resize

SphericalTabularGainData Class

A function class for computing gain using tabular data provided in a spherical coordinate system. This class can be used in conjunction with the CustomGainPattern class to model an antenna pattern using measured gain data.
Inheritance Hierarchy
SystemObject
  AGI.FoundationFunctionCartesian, Double
    AGI.Foundation.Communications.AntennasSphericalTabularGainData

Namespace:  AGI.Foundation.Communications.Antennas
Assembly:  AGI.Foundation.Communications (in AGI.Foundation.Communications.dll) Version: 24.1.418.0 (24.1.418.0)
Syntax
public class SphericalTabularGainData : Function<Cartesian, double>

The SphericalTabularGainData type exposes the following members.

Constructors
  NameDescription
Protected methodSphericalTabularGainData(SphericalTabularGainData, CopyContext)
Initializes a new instance as a copy of an existing instance.
Public methodSphericalTabularGainData(Double, Double, Double, Boolean)
Initializes an instance given an array of theta values, an array of phi values, and a multidimensional array of gain 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. Theta is defined as the zenith angle from the positive z-axis to the point. The gain values array must be arranged such that the rows of the array represent phi cuts through the antenna pattern and the columns represent theta cuts. Therefore, the first dimension of the gain values array must be the same size as the phi values array and the second dimension of the gain values array must be the same size as the theta values array. If duplicate phi/theta points are found, the first one that is found will be kept and subsequent phi/theta points are ignored. For example, if the phi array contains a value of 0 degrees and a value of 360 degrees (same cut through the sphere) all of the theta values at phi equal to 360 degrees will be ignored.
Top
Properties
  NameDescription
Public propertyIsThreadSafe
Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.
(Overrides FunctionTIndependent, TDependentIsThreadSafe.)
Public propertyPhiValues
Gets the list of phi values that specify the azimuthal angle measured from the x-axis in the x-y plane.
Public propertyThetaValues
Gets the list of theta values that specify the zenith angle measured from the z-axis.
Top
Methods
  NameDescription
Public methodClone
Clones this object using the specified context.
(Overrides FunctionTIndependent, TDependentClone(CopyContext).)
Public methodDispose
Releases any resources associated with this instance.
(Inherited from FunctionTIndependent, TDependent.)
Protected methodDispose(Boolean)
Releases any resources associated with this instance.
(Overrides FunctionTIndependent, TDependentDispose(Boolean).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodEvaluate(Cartesian)
Evaluate the gain given the cartesian direction expressed in the antennas axes.
(Overrides FunctionTIndependent, TDependentEvaluate(TIndependent).)
Public methodEvaluate(Cartesian, Int32)
Evaluate the gain given the cartesian direction expressed in the antennas axes.
(Overrides FunctionTIndependent, TDependentEvaluate(TIndependent, Int32).)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetGainDecibel
Gets the gain value in decibel units at the given phi, theta indices.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetNextSampleSuggestion
Gets a suggestion for the next independent variable value at which to sample this function.
(Inherited from FunctionTIndependent, TDependent.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also