FOUND
Loading...
Searching...
No Matches
found::LOSTVectorGenerationAlgorithm Class Reference

The LOSTVectorGenerationAlgorithm class houses the a Vector Assembly Algorithm that calculates the position of the satellite using orientation information determined from LOST. More...

#include <vectorize.hpp>

Inheritance diagram for found::LOSTVectorGenerationAlgorithm:
Collaboration diagram for found::LOSTVectorGenerationAlgorithm:

Public Member Functions

 LOSTVectorGenerationAlgorithm (Quaternion relativeOrientation, Quaternion referenceOrientation)
 Creates a LOSTVectorGenerationAlgorithm object.
 
 LOSTVectorGenerationAlgorithm (Quaternion orientation)
 Creates a LOSTVectorGenerationAlgorithm object.
 
 ~LOSTVectorGenerationAlgorithm ()=default
 
PositionVector Run (const PositionVector &x_E) override
 Runs the Vector Assembly Algorithm, which finds the vector of the satellite with respect to Earth's center using information from LOST.
 
- Public Member Functions inherited from found::VectorGenerationAlgorithm
 VectorGenerationAlgorithm ()=default
 
virtual ~VectorGenerationAlgorithm ()
 
- Public Member Functions inherited from found::Stage< PositionVector, PositionVector >
 Stage ()=default
 Constructs a new Stage.
 
virtual ~Stage ()=default
 Destroys this.
 
void DoAction () override
 Executes Run (with a stored input and storing the output)
 
PositionVectorGetResource ()
 Returns the stored input of this.
 
PositionVector *& GetProduct ()
 Returns the stored output of this.
 

Private Attributes

Quaternion orientation
 Orientation from LOST.
 

Additional Inherited Members

- Protected Attributes inherited from found::Stage< PositionVector, PositionVector >
PositionVector resource
 The stored input for this.
 
PositionVectorproduct
 The pointer to the stored output for this.
 

Detailed Description

The LOSTVectorGenerationAlgorithm class houses the a Vector Assembly Algorithm that calculates the position of the satellite using orientation information determined from LOST.

Constructor & Destructor Documentation

◆ LOSTVectorGenerationAlgorithm() [1/2]

found::LOSTVectorGenerationAlgorithm::LOSTVectorGenerationAlgorithm ( Quaternion  relativeOrientation,
Quaternion  referenceOrientation 
)
inlineexplicit

Creates a LOSTVectorGenerationAlgorithm object.

Parameters
relativeOrientationThe orientation of the FOUND camera with respect to the reference Orientation
referenceOrientationThe orientation of the reference orientation
Precondition
If using EulerAngles to generate the parameters, use SphericalToQuaternion, which provides the backwards rotation quaternions for both Euler angles. Using the normal quaternion will result in the opposite behavior (i.e. Run(x_E) will rotate the position vector away from its celestial equivalent instead of to it)

◆ LOSTVectorGenerationAlgorithm() [2/2]

found::LOSTVectorGenerationAlgorithm::LOSTVectorGenerationAlgorithm ( Quaternion  orientation)
inlineexplicit

Creates a LOSTVectorGenerationAlgorithm object.

Parameters
orientationThe absolute orientation of the FOUND camera
Precondition
If using EulerAngles to generate the parameters, use SphericalToQuaternion, which provides the backwards rotation quaternions for both Euler angles. Using the normal quaternion will result in the opposite behavior (i.e. Run(x_E) will rotate the position vector away from its celestial equivalent instead of to it)
Note
We take the conjugate to turn this back into a forward rotation

◆ ~LOSTVectorGenerationAlgorithm()

found::LOSTVectorGenerationAlgorithm::~LOSTVectorGenerationAlgorithm ( )
default

Member Function Documentation

◆ Run()

PositionVector found::LOSTVectorGenerationAlgorithm::Run ( const PositionVector x_E)
overridevirtual

Runs the Vector Assembly Algorithm, which finds the vector of the satellite with respect to Earth's center using information from LOST.

Parameters
x_EThe distance from Earth
Returns
A PositionVector that represents the 3D Vector of the satellite relative to Earth's center

Implements found::Stage< PositionVector, PositionVector >.

Member Data Documentation

◆ orientation

Quaternion found::LOSTVectorGenerationAlgorithm::orientation
private

Orientation from LOST.


The documentation for this class was generated from the following files: