Class for bundle observations. More...

#include <BundleObservation.h>

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...

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

Isis::BundleObservation::BundleObservation ( )

Constructs a BundleObservation initialized to a default state.

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

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

Creates a copy of another BundleObservation.

Parameters

src	Reference to the BundleObservation to copy

Isis::BundleObservation::~BundleObservation ( )

Destructor.

Contained BundleImages will remain until all shared pointers are deleted.

Member Function Documentation

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

Accesses the adjusted sigmas.

Returns: LinearAlgebra::Vector Returns the adjusted sigmas

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()

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().

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

Accesses the a priori sigmas.

Returns: LinearAlgebra::Vector Returns the a priori sigmas

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

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

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

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().

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).

QStringList Isis::BundleObservation::imageNames ( )

Access to image names for CorrelationMatrix to use.

Returns: QStringList Returns a QStringList of the image names

int Isis::BundleObservation::index ( )

Accesses the observation's index.

Returns: int Returns the observation's index

void Isis::BundleObservation::initializeBodyRotation ( )

Intializes the body rotation.

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().

QString Isis::BundleObservation::instrumentId ( )

Accesses the instrument id.

Returns: QString Returns the instrument id of the observation

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

int Isis::BundleObservation::numberPointingParameters ( )

Returns the number of pointing parameters being solved for.

Returns: int Returns the number of pointing parameters

int Isis::BundleObservation::numberPositionParameters ( )

Returns the number of position parameters there are.

Returns: int Returns the number of position parameters

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

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

Accesses the parameter corrections.

Returns: LinearAlgebra::Vector Returns the parameter corrections

QStringList Isis::BundleObservation::parameterList ( )

Access to parameters for CorrelationMatrix to use.

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

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

Accesses the solve parameter weights.

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

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

Sets the index for the observation.

Parameters

n	Value to set the index of the observation to

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.

const BundleObservationSolveSettingsQsp Isis::BundleObservation::solveSettings ( )

Accesses the solve settings.

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

SpicePosition * Isis::BundleObservation::spicePosition ( )

Accesses the instrument's spice position.

Returns: SpicePosition* Returns the SpicePosition for this observation

SpiceRotation * Isis::BundleObservation::spiceRotation ( )

Accesses the instrument's spice rotation.

Returns: SpiceRotation* Returns the SpiceRotation for this observation

void Isis::BundleObservation::updateBodyRotation ( )

Updates the body rotation.

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

src/control/objs/BundleUtilities/BundleObservation.h
src/control/objs/BundleUtilities/BundleObservation.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation