Class for bundle observations. More...

#include <BundleObservation.h>

Inheritance diagram for Isis::BundleObservation:

Collaboration diagram for Isis::BundleObservation:

Public Member Functions
	BundleObservation ()
	Constructs a BundleObservation initialized to a default state. More...

	BundleObservation (BundleImageQsp image, QString observationNumber, QString instrumentId, BundleTargetBodyQsp bundleTargetBody)
	Constructs a BundleObservation from an BundleImage, an instrument id, an observation number to assign to this BundleObservation, and a target body. More...

	BundleObservation (const BundleObservation &src)
	Creates a copy of another BundleObservation. More...

	~BundleObservation ()
	Destructor. More...

BundleObservation &	operator= (const BundleObservation &src)
	Assignment operator. More...

void	copy (const BundleObservation &src)

void	append (const BundleImageQsp &value)
	Appends a BundleImage shared pointer to the BundleObservation. More...

BundleImageQsp	imageByCubeSerialNumber (QString cubeSerialNumber)
	Returns the BundleImage shared pointer associated with the given serial number. More...

bool	setSolveSettings (BundleObservationSolveSettings solveSettings)
	Set solve parameters. More...

void	setIndex (int n)
	Sets the index for the observation. More...

int	index ()
	Accesses the observation's index. More...

int	numberPositionParameters ()
	Returns the number of position parameters there are. More...

int	numberPointingParameters ()
	Returns the number of pointing parameters being solved for. More...

int	numberParameters ()
	Returns the number of total parameters there are for solving. More...

QString	instrumentId ()
	Accesses the instrument id. More...

SpiceRotation *	spiceRotation ()
	Accesses the instrument's spice rotation. More...

SpicePosition *	spicePosition ()
	Accesses the instrument's spice position. More...

LinearAlgebra::Vector &	parameterWeights ()
	Accesses the solve parameter weights. More...

LinearAlgebra::Vector &	parameterCorrections ()
	Accesses the parameter corrections. More...

LinearAlgebra::Vector &	aprioriSigmas ()
	Accesses the a priori sigmas. More...

LinearAlgebra::Vector &	adjustedSigmas ()
	Accesses the adjusted sigmas. More...

const BundleObservationSolveSettingsQsp	solveSettings ()
	Accesses the solve settings. More...

bool	applyParameterCorrections (LinearAlgebra::Vector corrections)
	Applies the parameter corrections. More...

bool	initializeExteriorOrientation ()
	Initializes the exterior orientation. More...

void	initializeBodyRotation ()
	Intializes the body rotation. More...

void	updateBodyRotation ()
	Updates the body rotation. More...

void	bundleOutputFetchData (QVector< double > &finalParameterValues, int &nPositionCoefficients, int &nPointingCoefficients, bool &useDefaultPosition, bool &useDefaultPointing, bool &useDefaultTwist)
	Fetches data for the log file output methods. More...

void	bundleOutputString (std::ostream &fpOut, bool errorPropagation)
	Takes in an open std::ofstream and writes out information which goes into the bundleout.txt file. More...

QString	bundleOutputCSV (bool errorPropagation)
	Creates and returns a formatted QString representing the bundle coefficients and parameters in csv format. More...

QString	formatBundleOutputString (bool errorPropagation, bool imageCSV=false)
	Creates and returns a formatted QString representing the bundle coefficients and parameters More...

QStringList	parameterList ()
	Access to parameters for CorrelationMatrix to use. More...

QStringList	imageNames ()
	Access to image names for CorrelationMatrix to use. More...

Detailed Description

Class for bundle observations.

This class is used for creating a bundle observation. Contained BundleImages are stored as shared pointers, so they will be automatically deleted when all shared pointers are deleted.

Author: 2014-07-09 Ken Edmundson

Constructor & Destructor Documentation

◆ BundleObservation() [1/3]

Isis::BundleObservation::BundleObservation ( )

Constructs a BundleObservation initialized to a default state.

◆ BundleObservation() [2/3]

Isis::BundleObservation::BundleObservation	(	BundleImageQsp	image,
		QString	observationNumber,
		QString	instrumentId,
		BundleTargetBodyQsp	bundleTargetBody
	)

Constructs a BundleObservation from an BundleImage, an instrument id, an observation number to assign to this BundleObservation, and a target body.

Parameters

image	QSharedPointer to the primary image in the observation
observationNumber	Observation number of the observation
instrumentId	Id of the instrument for the observation
bundleTargetBody	QSharedPointer to the target body of the observation

◆ BundleObservation() [3/3]

Isis::BundleObservation::BundleObservation ( const BundleObservation & src )

Creates a copy of another BundleObservation.

Parameters

src	Reference to the BundleObservation to copy

◆ ~BundleObservation()

Isis::BundleObservation::~BundleObservation ( )

Destructor.

Contained BundleImages will remain until all shared pointers are deleted.

Member Function Documentation

◆ adjustedSigmas()

LinearAlgebra::Vector & Isis::BundleObservation::adjustedSigmas ( )

Accesses the adjusted sigmas.

Returns: LinearAlgebra::Vector Returns the adjusted sigmas

◆ append()

void Isis::BundleObservation::append ( const BundleImageQsp & value )

Appends a BundleImage shared pointer to the BundleObservation.

If the pointer is valid, then the BundleImage and its serial number will be inserted into the serial number to BundleImage map.

Parameters

value The BundleImage to be appended.

See also: QVector::append()

◆ applyParameterCorrections()

bool Isis::BundleObservation::applyParameterCorrections ( LinearAlgebra::Vector corrections )

Applies the parameter corrections.

Parameters

corrections Vector of corrections to apply

Exceptions

IException::Unknown	"Instrument position is NULL, but position solve option is [not NoPositionFactors]"
IException::Unknown	"Instrument position is NULL, but pointing solve option is [not NoPointingFactors]"
IException::Unknown	"Unable to apply parameter corrections to BundleObservation."

Returns: bool Returns true upon successful application of corrections

References _FILEINFO_, Isis::SpicePosition::SetPolynomial(), and Isis::SpiceRotation::SetPolynomial().

◆ aprioriSigmas()

LinearAlgebra::Vector & Isis::BundleObservation::aprioriSigmas ( )

Accesses the a priori sigmas.

Returns: LinearAlgebra::Vector Returns the a priori sigmas

◆ bundleOutputCSV()

QString Isis::BundleObservation::bundleOutputCSV ( bool errorPropagation )

Creates and returns a formatted QString representing the bundle coefficients and parameters in csv format.

Parameters

errorPropagation Boolean indicating whether or not to attach more information (corrections, sigmas, adjusted sigmas...) to the output QString

Returns: QString Returns a formatted QString representing the BundleObservation in csv format

References Isis::IsSpecial(), Isis::RAD2DEG, and Isis::toString().

◆ bundleOutputFetchData()

void Isis::BundleObservation::bundleOutputFetchData	(	QVector< double > &	finalParameterValues,
		int &	nPositionCoefficients,
		int &	nPointingCoefficients,
		bool &	useDefaultPosition,
		bool &	useDefaultPointing,
		bool &	useDefaultTwist
	)

Fetches data for the log file output methods.

Parameters

finalParameterValues	Reference to QVector<double> of calculated position and pointing
nPositionCoefficients	Reference to int of the number of position coefficients
nPointingCoefficients	Reference to int of the number of pointing coefficients
useDefaultPosition	Reference to boolean of whether to use default position
useDefaultPointing	Reference to boolean of whether to use default pointing
useDefaultTwist	Reference to bollean of whether to use defualt twist

◆ bundleOutputString()

void Isis::BundleObservation::bundleOutputString	(	std::ostream &	fpOut,
		bool	errorPropagation
	)

Takes in an open std::ofstream and writes out information which goes into the bundleout.txt file.

Parameters

fpOut	The open std::ofstream object which is passed in from BundleSolutionInfo::outputText()
errorPropagation	Boolean indicating whether or not to attach more information (corrections, sigmas, adjusted sigmas...) to the output.

References Isis::IsSpecial(), Isis::RAD2DEG, and Isis::toString().

◆ copy()

void Isis::BundleObservation::copy ( const BundleObservation & src )

◆ formatBundleOutputString()

QString Isis::BundleObservation::formatBundleOutputString	(	bool	errorPropagation,
		bool	imageCSV = `false`
	)

Creates and returns a formatted QString representing the bundle coefficients and parameters

The function formatBundleOutputString is depricated as of ISIS 3.9 and will be removed in ISIS 4.0

Parameters

errorPropagation	Boolean indicating whether or not to attach more information (corrections, sigmas, adjusted sigmas...) to the output QString
imageCSV	Boolean which is set to true if the function is being called from BundleSolutionInfo::outputImagesCSV(). It is set to false by default for backwards compatibility.

Returns: QString Returns a formatted QString representing the BundleObservation

References Isis::IsSpecial(), Isis::RAD2DEG, and Isis::toString().

◆ imageByCubeSerialNumber()

BundleImageQsp Isis::BundleObservation::imageByCubeSerialNumber ( QString cubeSerialNumber )

Returns the BundleImage shared pointer associated with the given serial number.

If no BundleImage with that serial number is contained a NULL pointer is returned.

Parameters

cubeSerialNumber The serial number of the cube to be returned.

Returns: BundleImageQsp A shared pointer to the BundleImage (NULL if not found).

◆ imageNames()

QStringList Isis::BundleObservation::imageNames ( )

Access to image names for CorrelationMatrix to use.

Returns: QStringList Returns a QStringList of the image names

◆ index()

int Isis::BundleObservation::index ( )

Accesses the observation's index.

Returns: int Returns the observation's index

◆ initializeBodyRotation()

void Isis::BundleObservation::initializeBodyRotation ( )

Intializes the body rotation.

◆ initializeExteriorOrientation()

bool Isis::BundleObservation::initializeExteriorOrientation ( )

Initializes the exterior orientation.

Returns: bool Returns true upon successful intialization

References Isis::SpiceRotation::GetBaseTime(), Isis::SpiceRotation::GetPolynomial(), Isis::SpiceRotation::GetTimeScale(), Isis::SpicePosition::SetOverrideBaseTime(), Isis::SpiceRotation::SetOverrideBaseTime(), Isis::SpicePosition::SetPolynomial(), Isis::SpiceRotation::SetPolynomial(), Isis::SpicePosition::SetPolynomialDegree(), and Isis::SpiceRotation::SetPolynomialDegree().

◆ instrumentId()

QString Isis::BundleObservation::instrumentId ( )

Accesses the instrument id.

Returns: QString Returns the instrument id of the observation

◆ numberParameters()

int Isis::BundleObservation::numberParameters ( )

Returns the number of total parameters there are for solving.

The total number of parameters is equal to the number of position parameters and number of pointing parameters

Returns: int Returns the number of parameters there are

◆ numberPointingParameters()

int Isis::BundleObservation::numberPointingParameters ( )

Returns the number of pointing parameters being solved for.

Returns: int Returns the number of pointing parameters

◆ numberPositionParameters()

int Isis::BundleObservation::numberPositionParameters ( )

Returns the number of position parameters there are.

Returns: int Returns the number of position parameters

◆ operator=()

BundleObservation & Isis::BundleObservation::operator= ( const BundleObservation & src )

Assignment operator.

Assigns the state of the source BundleObservation to this BundleObservation

Parameters

BundleObservation Reference to the source BundleObservation to assign from

Returns: BundleObservation& Reference to this BundleObservation

◆ parameterCorrections()

LinearAlgebra::Vector & Isis::BundleObservation::parameterCorrections ( )

Accesses the parameter corrections.

Returns: LinearAlgebra::Vector Returns the parameter corrections

◆ parameterList()

QStringList Isis::BundleObservation::parameterList ( )

Access to parameters for CorrelationMatrix to use.

Returns: QStringList Returns a QStringList of the names of the parameters

◆ parameterWeights()

LinearAlgebra::Vector & Isis::BundleObservation::parameterWeights ( )

Accesses the solve parameter weights.

Returns: LinearAlgebra::Vector Returns the parameter weights for solving

◆ setIndex()

void Isis::BundleObservation::setIndex ( int n )

Sets the index for the observation.

Parameters

n	Value to set the index of the observation to

◆ setSolveSettings()

bool Isis::BundleObservation::setSolveSettings ( BundleObservationSolveSettings solveSettings )

Set solve parameters.

Parameters

solveSettings The solve settings to use

Returns: bool Returns true if settings were successfully set

References Isis::Null.

◆ solveSettings()

const BundleObservationSolveSettingsQsp Isis::BundleObservation::solveSettings ( )

Accesses the solve settings.

Returns: const BundleObservationSolveSettingsQsp Returns a pointer to the solve settings for this BundleObservation

◆ spicePosition()

SpicePosition * Isis::BundleObservation::spicePosition ( )

Accesses the instrument's spice position.

Returns: SpicePosition* Returns the SpicePosition for this observation

◆ spiceRotation()

SpiceRotation * Isis::BundleObservation::spiceRotation ( )

Accesses the instrument's spice rotation.

Returns: SpiceRotation* Returns the SpiceRotation for this observation

◆ updateBodyRotation()

void Isis::BundleObservation::updateBodyRotation ( )

Updates the body rotation.

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

/usgs/pkgs/isis3.9.0_docs/ISIS3/isis/src/control/objs/BundleUtilities/BundleObservation.h
/usgs/pkgs/isis3.9.0_docs/ISIS3/isis/src/control/objs/BundleUtilities/BundleObservation.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ BundleObservation() [1/3]

◆ BundleObservation() [2/3]

◆ BundleObservation() [3/3]

◆ ~BundleObservation()

Member Function Documentation

◆ adjustedSigmas()

◆ append()

◆ applyParameterCorrections()

◆ aprioriSigmas()

◆ bundleOutputCSV()

◆ bundleOutputFetchData()

◆ bundleOutputString()

◆ copy()

◆ formatBundleOutputString()

◆ imageByCubeSerialNumber()

◆ imageNames()

◆ index()

◆ initializeBodyRotation()

◆ initializeExteriorOrientation()

◆ instrumentId()

◆ numberParameters()

◆ numberPointingParameters()

◆ numberPositionParameters()

◆ operator=()

◆ parameterCorrections()

◆ parameterList()

◆ parameterWeights()

◆ setIndex()

◆ setSolveSettings()

◆ solveSettings()

◆ spicePosition()

◆ spiceRotation()

◆ updateBodyRotation()