Click or drag to resize

ScalarOccultationDualCone Class

Provides evaluators for percentage of occultation/eclipse at a position, as well as EclipseType using the dual cone shadow model.

The percentage runs from 0.0 (completely lit) to 1.0 (total eclipse).

This occultation model is much more accurate than ScalarOccultationCylindrical and is the one which should be used in most cases.

Inheritance Hierarchy

Namespace:  AGI.Foundation.Celestial
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 19.2.399.0 (19.2.399.0)
Syntax
public class ScalarOccultationDualCone : ScalarOccultation, 
	IPartialDifferentiable, IEquatableDefinition

The ScalarOccultationDualCone type exposes the following members.

Constructors
  NameDescription
Public methodScalarOccultationDualCone
Creates a new Scalar with a VectorType of CorrectForLightTimeDelayAndAberration. IlluminatingBody and TargetPoint must be set before an Evaluator is created, and generally at least one body should be added to OccludingBodies.
Protected methodScalarOccultationDualCone(ScalarOccultationDualCone, CopyContext)
Initializes a new instance as a copy of an existing instance.
Public methodScalarOccultationDualCone(CentralBody, Point, CentralBody)
Creates a new Scalar from the given illuminating body, target point, and occluding bodies.
Top
Properties
  NameDescription
Public propertyDimension
Gets the dimension of the values produced by the object. For example, Vectors would have a dimension of three, and Scalars of one. A PartialDerivativesEvaluator created by this type will have a "RowDimension" equal to this property, and a "ColumnDimension equal to the summation of the dimensions of the independent variables that this object is dependent on.
Public propertyIlluminatingBody
Gets or sets the body to use for the illuminating body (commonly the sun).
(Inherited from ScalarOccultation.)
Public propertyInertialFrame
Gets or sets an alternate inertial reference frame. This property is by default, and if it remains then the Inertial Frame of the IlluminatingBody will be used.

The inertial frame is used to correct the position vectors for light time delay and aberration if the appropriate RadiationVectorType is set.

(Inherited from ScalarOccultation.)
Public propertyIsFrozen
Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so.
(Inherited from DefinitionalObject.)
Public propertyOccludingBodies
Gets a list of bodies which obscure the illuminating body.
(Inherited from ScalarOccultation.)
Public propertyTargetPoint
Gets or sets the Point representing the location at which the occultation factor is being calculated.
(Inherited from ScalarOccultation.)
Public propertyVectorType
Gets or sets whether or not to use true position to calculate the occultation, or apparent position adjusted for aberration. By default set to CorrectForLightTimeDelayAndAberration.
(Inherited from ScalarOccultation.)
Top
Methods
  NameDescription
Public methodAdd(Double)
Adds a fixed scalar to this one.
(Inherited from Scalar.)
Public methodAdd(Scalar)
Adds another scalar to this one.
(Inherited from Scalar.)
Protected methodStatic memberCalculateEclipseType
Calculates the type of shadow a platform is in using a dual cone shadow model.
Protected methodCheckForSameDefinition(DefinitionalObject)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from Scalar.)
Protected methodCheckForSameDefinition(Scalar)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from ScalarOccultation.)
Protected methodCheckForSameDefinition(ScalarOccultation)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Overrides ScalarOccultationCheckForSameDefinition(ScalarOccultation).)
Protected methodCheckForSameDefinition(ScalarOccultationDualCone)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Protected methodComputeCurrentDefinitionHashCode
Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the CheckForSameDefinition(DefinitionalObject) method.
(Overrides ScalarOccultationComputeCurrentDefinitionHashCode.)
Protected methodCreateEvaluatorHelper
Checks all properties and creates the vectors required to evaluate occultation fractions.
(Inherited from ScalarOccultation.)
Public methodCreateScalarDerivative
Constructs a scalar which represents a derivative of this scalar.
(Inherited from Scalar.)
Public methodDivide(Double)
Divides this scalar (numerator) by a fixed value (denominator).
(Inherited from Scalar.)
Public methodDivide(Scalar)
Divides this scalar (numerator) by another one (denominator).
(Inherited from Scalar.)
Public methodEnumerateDependencies
Enumerates the dependencies of this object by calling EnumerateT(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.
(Inherited from ScalarOccultation.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
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 methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
Called by Freeze to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.
(Inherited from DefinitionalObject.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetEclipseTypeEvaluators
Gets an evaluator to calculate EclipseType for every CentralBody in OccludingBodies.
(Inherited from ScalarOccultation.)
Public methodGetEclipseTypeEvaluators(EvaluatorGroup)
Gets a list of evaluators that calculate eclipse types for each eclipsing body according to the dual cone shadow model.
(Overrides ScalarOccultationGetEclipseTypeEvaluators(EvaluatorGroup).)
Public methodGetEvaluator
Gets an evaluator that can be used to find the value of this scalar function at a given JulianDate.
(Inherited from Scalar.)
Public methodGetEvaluator(EvaluatorGroup)
Gets an evaluator that calculates occultation according to the dual cone shadow model. The occultation factor ranges from 0.0 (fully lit) to 1.0 (full occultation).
(Overrides ScalarGetEvaluator(EvaluatorGroup).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetPartialDerivativesEvaluator
This type does not have derivatives or partial derivatives with respect to any object with the exception of itself. Because of that the created PartialDerivativesEvaluator has a ColumnDimension of zero if this ScalarOccultation is not in the generalized state, and if it is in the generalized state it returns a 1x1 identity matrix.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMultiply(Double)
Multiplies this scalar with a fixed value.
(Inherited from Scalar.)
Public methodMultiply(Scalar)
Multiplies another scalar with this one.
(Inherited from Scalar.)
Protected methodStatic memberOccultation
Returns the fraction of light from an illuminating body that an eclipsing body is occulting based on the dual cone shadow model.
Public methodPower
Raises this scalar to the given fixed exponent.
(Inherited from Scalar.)
Public methodSubtract(Double)
Subtracts a fixed scalar from this one.
(Inherited from Scalar.)
Public methodSubtract(Scalar)
Subtracts another scalar from this one.
(Inherited from Scalar.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also