ScalarOccultationDualCone.Occultation Method |
Returns the fraction of light from an illuminating body that an eclipsing body
is occulting based on the dual cone shadow model.
Namespace:
AGI.Foundation.Celestial
Assembly:
AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 25.1.421.0 (25.1.421.0)
Syntaxprotected static double Occultation(
EclipseType shadow,
double relAngle,
double eclipseAngle,
double illumAngle,
bool useWithCorrector
)
Protected Shared Function Occultation (
shadow As EclipseType,
relAngle As Double,
eclipseAngle As Double,
illumAngle As Double,
useWithCorrector As Boolean
) As Double
protected:
static double Occultation(
EclipseType shadow,
double relAngle,
double eclipseAngle,
double illumAngle,
bool useWithCorrector
)
static member Occultation :
shadow : EclipseType *
relAngle : float *
eclipseAngle : float *
illumAngle : float *
useWithCorrector : bool -> float
Parameters
- shadow
- Type: AGI.Foundation.Celestial.EclipseType
The EclipseType of the current situation. - relAngle
- Type: System.Double
The angular separation from the center of the eclipsing body
to the center of the illuminating body - eclipseAngle
- Type: System.Double
The angular separation from the center to the edge
of the eclipsing body. - illumAngle
- Type: System.Double
The angular separation from the center to the edge
of the illuminating body. - useWithCorrector
- Type: System.Boolean
This parameter specified whether this call is being made for a Scalar that is being corrected.
Return Value
Type:
DoubleThe occultation, from 0.0 to 1.0.
See Also