Click or drag to resize

ConstantCovariance3By3 Class

Represents position covariance with standard deviations which remain constant in the given axes.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Geometry
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.3.420.0 (24.3.420.0)
Syntax
public class ConstantCovariance3By3 : DynamicCovariance3By3

The ConstantCovariance3By3 type exposes the following members.

Constructors
  NameDescription
Public methodConstantCovariance3By3
Initializes a new instance. The user must set OrientationAxes with SetOrientationAxes(Axes). Sigmas is initialized to Zero.
Public methodConstantCovariance3By3(Cartesian, Axes)
Creates a new instance from the specified constant size and the orientation axes.
Protected methodConstantCovariance3By3(ConstantCovariance3By3, CopyContext)
Initializes a new instance as a copy of an existing instance.
Top
Properties
  NameDescription
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 propertyOrientationAxes
Gets the time-varying axes of the covariance ellipsoid. This property can be set with SetOrientationAxes(Axes).
(Overrides DynamicCovariance3By3OrientationAxes.)
Public propertySigmas
Gets or sets the Cartesian representing the constant Sigmas for the location point uncertainty described by this instance. These are equal to the square root of the standard deviation of the covariances, and are the semi-axes lengths of the covariance ellipsoid at one standard deviation of uncertainty.
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(ConstantCovariance3By3)
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).
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 DynamicCovariance3By3.)
Protected methodCheckForSameDefinition(DynamicCovariance3By3)
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 DynamicCovariance3By3CheckForSameDefinition(DynamicCovariance3By3).)
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 DynamicCovariance3By3ComputeCurrentDefinitionHashCode.)
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.
(Overrides DefinitionalObjectEnumerateDependencies(DependencyEnumerator).)
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 methodGetEllipsoidSizeEvaluator(Scalar)

Constructs an evaluator that calculates dimensions of the ellipsoid containing the uncertainty of a position over time. This is created from the standard deviation (or sigma) of the position variance over time, as well as the given Scalar factor of how many standard deviations of uncertainty to use.

These sigmas correspond to the OrientationAxes.

(Inherited from DynamicCovariance3By3.)
Public methodGetEllipsoidSizeEvaluator(Scalar, EvaluatorGroup)

Constructs an evaluator that calculates dimensions of the ellipsoid containing the uncertainty of a position over time. This is created from the standard deviation (or sigma) of the position variance over time, as well as the given Scalar factor of how many standard deviations of uncertainty to use.

These sigmas correspond to the OrientationAxes.

(Inherited from DynamicCovariance3By3.)
Public methodGetEvaluator
Constructs an evaluator that calculates the size and orientation of the position covariance over time.
(Inherited from DynamicCovariance3By3.)
Public methodGetEvaluator(Axes)
Constructs an evaluator that calculates the size and orientation of the position covariance over time.
(Inherited from DynamicCovariance3By3.)
Public methodGetEvaluator(EvaluatorGroup)
Constructs an evaluator that calculates the size and orientation of the position covariance over time.
(Overrides DynamicCovariance3By3GetEvaluator(EvaluatorGroup).)
Public methodGetEvaluator(Axes, EvaluatorGroup)
Constructs an evaluator that calculates the size and orientation of the position covariance over time.
(Overrides DynamicCovariance3By3GetEvaluator(Axes, EvaluatorGroup).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetService
Gets the service object of the specified type.
(Inherited from DynamicCovariance3By3.)
Public methodGetStandardDeviationEvaluator

Constructs an evaluator that calculates the standard deviation (or sigma) of the position variance over time. These sigmas correspond to the OrientationAxes.

This is equivalent to calling GetEllipsoidSizeEvaluator(Scalar) with a sigma factor of 1.0.

(Inherited from DynamicCovariance3By3.)
Public methodGetStandardDeviationEvaluator(EvaluatorGroup)

Constructs an evaluator that calculates the standard deviation (or sigma) of the position variance over time. These sigmas correspond to the OrientationAxes.

This is equivalent to calling GetEllipsoidSizeEvaluator(Scalar, EvaluatorGroup) with a sigma factor of 1.0.

(Inherited from DynamicCovariance3By3.)
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 methodSetOrientationAxes
Sets the OrientationAxes.
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