public class ScalarOccultationCylindrical extends ScalarOccultation implements IPartialDifferentiable
Provides evaluators for percentage of occultation/eclipse at a position,
as well as EclipseType using the cylindrical shadow model.
The percentage runs from 0.0 (completely lit) to 1.0 (total eclipse).
This occultation model is not nearly as accurate as ScalarOccultationDualCone,
which should generally be used instead. However, this cylindrical model is included for completeness.
| Modifier | Constructor and Description |
|---|---|
|
ScalarOccultationCylindrical()
Creates a new Scalar with a
VectorType (get / set) of RadiationVectorType.CORRECT_FOR_LIGHT_TIME_DELAY_AND_ABERRATION. |
|
ScalarOccultationCylindrical(CentralBody illuminatingBody,
Point targetPoint,
CentralBody... occludingBodies)
Creates a new Scalar from the given illuminating body, target point, and occluding bodies.
|
|
ScalarOccultationCylindrical(CentralBody illuminatingBody,
Point targetPoint,
Iterable<CentralBody> occludingBodies)
Creates a new Scalar from the given illuminating body, target point, and occluding bodies.
|
protected |
ScalarOccultationCylindrical(ScalarOccultationCylindrical existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
checkForSameDefinition(ScalarOccultation other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
protected boolean |
checkForSameDefinition(ScalarOccultationCylindrical other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
Object |
clone(CopyContext context)
Clones this object using the specified context.
|
protected int |
computeCurrentDefinitionHashCode()
Computes a hash code based on the current properties of this object.
|
int |
getDimension()
Gets the dimension of the values produced by the object.
|
List<Evaluator<EclipseType>> |
getEclipseTypeEvaluators(EvaluatorGroup group)
Gets a list of evaluators that calculate eclipse types for each eclipsing body according to the cylindrical shadow model.
|
ScalarEvaluator |
getEvaluator(EvaluatorGroup group)
Gets an evaluator that calculates occultation according to the cylindrical shadow model.
|
PartialDerivativesEvaluator |
getPartialDerivativesEvaluator(List<IPartialDifferentiable> independentVariables,
EvaluatorGroup group)
This type does not have derivatives or partial derivatives with respect to any object except itself.
|
checkForSameDefinition, createEvaluatorHelper, eclipseAngles, enumerateDependencies, getEclipseTypeEvaluators, getIlluminatingBody, getInertialFrame, getOccludingBodies, getTargetPoint, getVectorType, setIlluminatingBody, setInertialFrame, setTargetPoint, setVectorTypeadd, add, add, add, add, checkForSameDefinition, createScalarDerivative, divide, divide, divide, divide, divide, getEvaluator, multiply, multiply, multiply, multiply, multiply, power, subtract, subtract, subtract, subtract, subtract, toScalarareSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetDefinitionHashCode, isSameDefinitionpublic ScalarOccultationCylindrical()
public ScalarOccultationCylindrical(CentralBody illuminatingBody, Point targetPoint, @Nonnull CentralBody... occludingBodies)
illuminatingBody - The illuminating body.targetPoint - The target point.occludingBodies - The occluding bodies.public ScalarOccultationCylindrical(CentralBody illuminatingBody, Point targetPoint, @Nonnull Iterable<CentralBody> occludingBodies)
illuminatingBody - The illuminating body.targetPoint - The target point.occludingBodies - The occluding bodies.protected ScalarOccultationCylindrical(@Nonnull ScalarOccultationCylindrical 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;clone in interface ICloneWithContextclone in class DefinitionalObjectcontext - The context to use to perform the copy.protected final boolean checkForSameDefinition(ScalarOccultation other)
true 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 false for all derived-class instances.
Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).checkForSameDefinition in class ScalarOccultationother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected boolean checkForSameDefinition(ScalarOccultationCylindrical other)
true 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 false for all derived-class instances.
Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).other - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected int computeCurrentDefinitionHashCode()
ScalarOccultationCylindrical.checkForSameDefinition(agi.foundation.celestial.ScalarOccultation) method.computeCurrentDefinitionHashCode in class ScalarOccultationpublic final int getDimension()
Vectors
would have a dimension of three, and Scalars of one. A PartialDerivativesEvaluator
created by this type will have a RowDimension (get) equal to this
property, and a ColumnDimension (get) equal to the summation
of the dimensions of the independent variables that this object is dependent on.getDimension in interface IPartialDifferentiablepublic ScalarEvaluator getEvaluator(EvaluatorGroup group)
getEvaluator in class Scalargroup - The group with which to associate the new evaluator. By grouping evaluators
that are often evaluated at the same Julian dates, common computations can be performed only once
for the entire group instead of multiple times for each evaluator.ArgumentNullException - Thrown when group is null.PropertyInvalidException - Thrown when the property TargetPoint (get / set),
IlluminatingBody (get / set), or
OccludingBodies (get) or any of its members is null.public List<Evaluator<EclipseType>> getEclipseTypeEvaluators(EvaluatorGroup group)
getEclipseTypeEvaluators in class ScalarOccultationgroup - The group with which to associate the new evaluator. By grouping evaluators
that are often evaluated at the same Julian dates, common computations can be performed only once
for the entire group instead of multiple times for each evaluator.EclipseType.ArgumentNullException - Thrown when group is null.PropertyInvalidException - Thrown when the property TargetPoint (get / set),
IlluminatingBody (get / set), or
OccludingBodies (get) or any of its members is null.public final PartialDerivativesEvaluator getPartialDerivativesEvaluator(List<IPartialDifferentiable> independentVariables, EvaluatorGroup group)
PartialDerivativesEvaluator has a
ColumnDimension (get) 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.getPartialDerivativesEvaluator in interface IPartialDifferentiableindependentVariables - The list of IPartialDifferentiable representing the independent
variables that the created partial derivative evaluator calculates partials with respect to.group - The EvaluatorGroup that will contain the created evaluator.PartialDerivativesEvaluator.