PolarizationComputeEfficiency Method |
Computes the polarization efficiency.
Namespace:
AGI.Foundation.Communications
Assembly:
AGI.Foundation.Communications (in AGI.Foundation.Communications.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax public static double ComputeEfficiency(
Polarization source,
Polarization sink,
UnitQuaternion sourceToSinkRotation,
UnitCartesian sinkToSourceDirection,
double crossPolarizationLeakage
)
Public Shared Function ComputeEfficiency (
source As Polarization,
sink As Polarization,
sourceToSinkRotation As UnitQuaternion,
sinkToSourceDirection As UnitCartesian,
crossPolarizationLeakage As Double
) As Double
public:
static double ComputeEfficiency(
Polarization^ source,
Polarization^ sink,
UnitQuaternion sourceToSinkRotation,
UnitCartesian sinkToSourceDirection,
double crossPolarizationLeakage
)
static member ComputeEfficiency :
source : Polarization *
sink : Polarization *
sourceToSinkRotation : UnitQuaternion *
sinkToSourceDirection : UnitCartesian *
crossPolarizationLeakage : float -> float
Parameters
- source
- Type: AGI.Foundation.CommunicationsPolarization
The polarization associated with the source or the transmission. - sink
- Type: AGI.Foundation.CommunicationsPolarization
The polarization associated with the sink or receiver of the transmission. - sourceToSinkRotation
- Type: AGI.Foundation.CoordinatesUnitQuaternion
The unit quaternion which represents the rotation from the source axes to the sink axes. - sinkToSourceDirection
- Type: AGI.Foundation.CoordinatesUnitCartesian
The direction from the sink to the source. - crossPolarizationLeakage
- Type: SystemDouble
The cross polarization leakage. The value which corresponds to complete mismatch between the source and sink polarizations.
Return Value
Type:
DoubleThe polarization efficiency.
Remarks
The maximum value of 1.0 returned from this function corresponds to no mismatch between the source and sink polarization.
The minimum value returned will be governed by the crossPolarizationLeakage value and
corresponds to complete mismatch between the source and sink polarization.
See Also