Container class for BundleAdjustment settings. More...

#include <BundleSettings.h>

Public Types
enum	ConvergenceCriteria { Sigma0, ParameterCorrections }
	This enum defines the options for the bundle adjustment's convergence. More...

enum	MaximumLikelihoodModel { NoMaximumLikelihoodEstimator, Huber, ModifiedHuber, Welsch, Chen }
	This enum defines the options for maximum likelihood estimation. More...

Public Member Functions
	BundleSettings ()
	Constructs a BundleSettings object. More...

	BundleSettings (const BundleSettings &other)
	This copy constructor sets this BundleSettings' member data to match that of the 'other' given BundleSettings. More...

	BundleSettings (Project project, XmlStackedHandlerReader xmlReader)
	Construct a BundleSettings object from member data read from an XML file. More...

	~BundleSettings ()
	Destroys the BundleSettings object. More...

BundleSettings &	operator= (const BundleSettings &other)
	Assignment operator to allow proper copying of the 'other' BundleSettings object to this one. More...

void	setValidateNetwork (bool validate)
	Sets the internal flag to indicate whether to validate the network before the bundle adjustment. More...

bool	validateNetwork () const
	This method is used to determine whether to validate the network before the bundle adjustment. More...

void	setSolveOptions (bool solveObservationMode=false, bool updateCubeLabel=false, bool errorPropagation=false, bool solveRadius=false, double globalLatitudeAprioriSigma=Isis::Null, double globalLongitudeAprioriSigma=Isis::Null, double globalRadiusAprioriSigma=Isis::Null)
	Set the solve options for the bundle adjustment. More...

void	setOutlierRejection (bool outlierRejection, double multiplier=1.0)
	Set the outlier rejection options for the bundle adjustment. More...

void	setObservationSolveOptions (QList< BundleObservationSolveSettings > obsSolveSettingsList)
	Add the list of solve options for each observation. More...

void	setCreateInverseMatrix (bool createMatrix)
	Turn the creation of the inverse correlation matrix file on or off. More...

bool	createInverseMatrix () const
	Indicates if the settings will allow the inverse correlation matrix to be created. More...

bool	solveObservationMode () const
	This method is used to determine whether this bundle adjustment will solve for observation mode. More...

bool	solveRadius () const
	This method is used to determine whether this bundle adjustment will solve for radius. More...

bool	updateCubeLabel () const
	This method is used to determine whether this bundle adjustment will update the cube labels. More...

bool	errorPropagation () const
	This method is used to determine whether this bundle adjustment will perform error propagation. More...

bool	outlierRejection () const
	This method is used to determine whether outlier rejection will be performed on this bundle adjustment. More...

double	outlierRejectionMultiplier () const
	Retrieves the outlier rejection multiplier for the bundle adjustment. More...

double	globalLatitudeAprioriSigma () const
	Retrieves the global a priori sigma latitude value for this bundle adjustment. More...

double	globalLongitudeAprioriSigma () const
	Retrieves the global a priori sigma longitude value for this bundle adjustment. More...

double	globalRadiusAprioriSigma () const
	Retrieves the global a priori sigma radius value for this bundle adjustment. More...

int	numberSolveSettings () const
	Retrieves the number of observation solve settings. More...

BundleObservationSolveSettings	observationSolveSettings (QString instrumentId) const
	Retrieves solve settings for the observation corresponding to the given observation number. More...

BundleObservationSolveSettings	observationSolveSettings (int n) const
	Retrieves solve settings for the observation corresponding to the given index. More...

void	setConvergenceCriteria (ConvergenceCriteria criteria, double threshold, int maximumIterations)
	Set the convergence criteria options for the bundle adjustment. More...

ConvergenceCriteria	convergenceCriteria () const
	Retrieves the convergence criteria to be used to solve the bundle adjustment. More...

double	convergenceCriteriaThreshold () const
	Retrieves the convergence threshold to be used to solve the bundle adjustment. More...

int	convergenceCriteriaMaximumIterations () const
	Retrieves the maximum number of iterations allowed to solve the bundle adjustment. More...

void	addMaximumLikelihoodEstimatorModel (MaximumLikelihoodWFunctions::Model model, double cQuantile)
	Add a maximum likelihood estimator (MLE) model to the bundle adjustment. More...

QList< QPair < MaximumLikelihoodWFunctions::Model, double > >	maximumLikelihoodEstimatorModels () const
	Retrieves the list of maximum likelihood estimator (MLE) models with their corresponding C-Quantiles. More...

void	setBundleTargetBody (BundleTargetBodyQsp bundleTargetBody)
	Sets the target body for the bundle adjustment. More...

BundleTargetBodyQsp	bundleTargetBody () const
	Retrieves a pointer to target body information for the bundle adjustment. More...

int	numberTargetBodyParameters () const
	This method is used to determine whether the bundle adjustment will solve for target body pole position. More...

bool	solveTargetBody () const
	This method is used to determine whether the bundle adjustment will solve for target body. More...

bool	solvePoleRA () const
	This method is used to determine whether the bundle adjustment will solve for target body pole right ascension. More...

bool	solvePoleRAVelocity () const
	This method is used to determine whether the bundle adjustment will solve for target body pole right ascension velocity. More...

bool	solvePoleDec () const
	This method is used to determine whether the bundle adjustment will solve for target body pole declination. More...

bool	solvePoleDecVelocity () const
	This method is used to determine whether the bundle adjustment will solve for target body pole declination velocity. More...

bool	solvePM () const
	This method is used to determine whether the bundle adjustment will solve for target body prime meridian. More...

bool	solvePMVelocity () const
	This method is used to determine whether the bundle adjustment will solve for target body prime meridian velocity. More...

bool	solvePMAcceleration () const
	This method is used to determine whether the bundle adjustment will solve for target body prime meridian acceleration. More...

bool	solveTriaxialRadii () const
	This method is used to determine whether the bundle adjustment will solve for target body triaxial radii. More...

bool	solveMeanRadius () const
	This method is used to determine whether the bundle adjustment will solve for target body mean radius. More...

void	setOutputFilePrefix (QString outputFilePrefix)
	Set the output file prefix for the bundle adjustment. More...

void	setSCPVLFilename (QString SCParamFilename)

QString	outputFilePrefix () const
	Retrieve the output file prefix. More...

QString	SCPVLFilename () const

PvlObject	pvlObject (QString name="BundleSettings") const
	Create PvlObject with the given name containing the BundleSettings information. More...

void	save (QXmlStreamWriter &stream, const Project *project) const
	This method is used to write a BundleSettings object to an XML format. More...

QDataStream &	write (QDataStream &stream) const
	Writes BundleSettings object to a binary data stream. More...

QDataStream &	read (QDataStream &stream)
	Reads BundleSettings object from a binary data stream. More...

void	createH5Group (hid_t locationId, QString locationName) const

void	parseH5Group (hid_t locationId, QString locationName)

void	createH5Group (H5::CommonFG &locationObject, QString locationName) const
	HDF5 - TBD. More...

H5::Group	createH5Group2 (H5::Group locationGroup, QString locationName)

void	openH5Group (H5::CommonFG &locationObject, QString locationName)
	HDF5 - TBD. More...

	BundleSettings (H5::CommonFG &locationObject, QString locationName)

Static Public Member Functions
static ConvergenceCriteria	stringToConvergenceCriteria (QString criteria)
	Converts the given string value to a BundleSettings::ConvergenceCriteria enumeration. More...

static QString	convergenceCriteriaToString (ConvergenceCriteria criteria)
	Converts the given BundleSettings::ConvergenceCriteria enumeration to a string. More...

Detailed Description

Container class for BundleAdjustment settings.

This class contains all of the settings needed to run a bundle adjustment. A BundleSettings object is passed into the BundleAdjustment constructor.

Author: 2014-05-14 Jeannie Backer

Member Enumeration Documentation

enum Isis::BundleSettings::ConvergenceCriteria

This enum defines the options for the bundle adjustment's convergence.

Enumerator
Sigma0	The value of sigma0 will be used to determine that the bundle adjustment has converged.
ParameterCorrections	All parameter corrections will be used to determine that the bundle adjustment has converged.

enum Isis::BundleSettings::MaximumLikelihoodModel

This enum defines the options for maximum likelihood estimation.

Enumerator
NoMaximumLikelihoodEstimator	Do not use a maximum likelihood model.
Huber	Use a Huber maximum likelihood model. This model approximates the L2 norm near zero and the L1 norm thereafter. This model has one continuous derivative.
ModifiedHuber	Use a modified Huber maximum likelihood model. This model approximates the L2 norm near zero and the L1 norm thereafter. This model has two continuous derivative.
Welsch	Use a Welsch maximum likelihood model. This model approximates the L2 norm near zero, but then decays exponentially to zero.
Chen	Use a Chen maximum likelihood model. This is a highly aggressive model that intentionally removes the largest few percent of residuals.????

Constructor & Destructor Documentation

Isis::BundleSettings::BundleSettings ( )

Constructs a BundleSettings object.

Default values are set for all member variables. By default, BundleSettings allows creation of the inverse correlation matrix file.

See Also: createInverseMatrix(); setCreateInverseMatrix()

References Isis::Null, and Sigma0.

Isis::BundleSettings::BundleSettings ( const BundleSettings & other )

This copy constructor sets this BundleSettings' member data to match that of the 'other' given BundleSettings.

Parameters

other The BundleSettings object to be copied.

Isis::BundleSettings::BundleSettings	(	Project *	project,
		XmlStackedHandlerReader *	xmlReader
	)

Construct a BundleSettings object from member data read from an XML file.

*   FileName xmlFile("bundleSettingsFileName.xml");
*  
*   QString xmlPath = xmlFile.expanded();
*   QFile file(xmlPath);
*   file.open(QFile::ReadOnly);
*   XmlStackedHandlerReader reader;
*   BundleSettings settings(project, reader);
* 

Parameters

project	A pointer to the project where the Settings will be saved.
xmlReader	An XML reader that's up to an <bundleSettings> tag.

References Isis::XmlStackedHandlerReader::pushContentHandler().

Isis::BundleSettings::~BundleSettings ( )

Destroys the BundleSettings object.

Isis::BundleSettings::BundleSettings	(	H5::CommonFG &	locationObject,
		QString	locationName
	)

Member Function Documentation

void Isis::BundleSettings::addMaximumLikelihoodEstimatorModel	(	MaximumLikelihoodWFunctions::Model	model,
		double	maxModelCQuantile
	)

Add a maximum likelihood estimator (MLE) model to the bundle adjustment.

Parameters

model	The enumeration for the model to be used.
maxModelCQuantile	The C-Quantile of the residual to be used to compute the tweaking constant.

Exceptions

Isis::Exception::Programmer "For bundle adjustments with multiple maximum likelihood estimators, the first model must be of type HUBER or HUBER_MODIFIED."

References _FILEINFO_, Isis::MaximumLikelihoodWFunctions::HuberModified, and Isis::IException::Programmer.

BundleTargetBodyQsp Isis::BundleSettings::bundleTargetBody ( ) const

Retrieves a pointer to target body information for the bundle adjustment.

Returns: BundleTargetBodyQsp A pointer to the BundleTargetBody object for the bundle adjustment to be run.

Referenced by setBundleTargetBody().

BundleSettings::ConvergenceCriteria Isis::BundleSettings::convergenceCriteria ( ) const

Retrieves the convergence criteria to be used to solve the bundle adjustment.

Returns: ConvergenceCriteria The enumeration of the convergence criteria.

Referenced by pvlObject(), read(), and save().

int Isis::BundleSettings::convergenceCriteriaMaximumIterations ( ) const

Retrieves the maximum number of iterations allowed to solve the bundle adjustment.

Parameters

maximumIterations The maximum number of iterations allowed before the bundle adjustment determines that the data is not converging.

Referenced by pvlObject(), read(), and save().

double Isis::BundleSettings::convergenceCriteriaThreshold ( ) const

Retrieves the convergence threshold to be used to solve the bundle adjustment.

Returns: double The threshold that determines convergence.

Referenced by pvlObject(), and save().

QString Isis::BundleSettings::convergenceCriteriaToString ( BundleSettings::ConvergenceCriteria criteria )

static

Converts the given BundleSettings::ConvergenceCriteria enumeration to a string.

This method is used to print the type of convergence criteria used in the bundle adjustment.

Parameters

criteria The ConvergenceCriteria enumeration to be converted.

Returns: QString The name associated with the given convergence criteria.

Exceptions

Isis::Exception::Programmer "Unknown bundle convergence criteria enum."

References _FILEINFO_, ParameterCorrections, Isis::IException::Programmer, Sigma0, and Isis::toString().

Referenced by createH5Group(), pvlObject(), and save().

void Isis::BundleSettings::createH5Group	(	hid_t	locationId,
		QString	locationName
	)		const

void Isis::BundleSettings::createH5Group	(	H5::CommonFG &	locationObject,
		QString	locationName
	)		const

HDF5 - TBD.

NOTE: Currently this method is not used and may be deleted. Documentation and testing to be completed if called. TargetBody info should be added also.

Parameters

@param

Exceptions

@throw
@throw
@throw
@throw

References _FILEINFO_, convergenceCriteriaToString(), and Isis::IException::Unknown.

H5::Group Isis::BundleSettings::createH5Group2	(	H5::Group	locationGroup,
		QString	locationName
	)

bool Isis::BundleSettings::createInverseMatrix ( ) const

Indicates if the settings will allow the inverse correlation matrix to be created.

This method is used to determine if the inverse correlation matrix file will be created when creating error propagation information in the bundle adjust. If error propagation is not turned on, then the inverse correlation matrix file will not be created.

Returns: bool Returns whether or now the inverse correlation matrix is allowed to be created.

See Also: BundleAdjust::errorPropagation()

Referenced by pvlObject(), and save().

bool Isis::BundleSettings::errorPropagation ( ) const

This method is used to determine whether this bundle adjustment will perform error propagation.

Returns: bool Indicates whether to perform error propagation.

Referenced by pvlObject(), save(), and setSolveOptions().

double Isis::BundleSettings::globalLatitudeAprioriSigma ( ) const

Retrieves the global a priori sigma latitude value for this bundle adjustment.

Returns: double The global a priori sigma for latitude.

Referenced by pvlObject(), save(), and setSolveOptions().

double Isis::BundleSettings::globalLongitudeAprioriSigma ( ) const

Retrieves the global a priori sigma longitude value for this bundle adjustment.

Returns: double The global a priori sigma for longitude.

Referenced by pvlObject(), save(), and setSolveOptions().

double Isis::BundleSettings::globalRadiusAprioriSigma ( ) const

Retrieves the global a priori sigma radius value for this bundle adjustment.

Returns: double The global a priori sigma for radius.

Referenced by pvlObject(), save(), and setSolveOptions().

QList< QPair< MaximumLikelihoodWFunctions::Model, double > > Isis::BundleSettings::maximumLikelihoodEstimatorModels ( ) const

Retrieves the list of maximum likelihood estimator (MLE) models with their corresponding C-Quantiles.

Returns: QList< QPair< MaximumLikelihoodWFunctions::Model, double > > The list of tuples of the form (model, quantile) to be used for the bundle adjustment.

int Isis::BundleSettings::numberSolveSettings ( ) const

Retrieves the number of observation solve settings.

Returns: int The number of solve settings object for this run of the bundle adjustment.

Referenced by observationSolveSettings(), pvlObject(), and save().

int Isis::BundleSettings::numberTargetBodyParameters ( ) const

This method is used to determine whether the bundle adjustment will solve for target body pole position.

Returns: bool Indicates whether to solve for target pole position. Retrieves the number of target body parameters. If the BundleTargetBody associated with this bundle adjustment is NULL, this method returns 0.; int The number of target body parameters.

Referenced by pvlObject().

BundleObservationSolveSettings Isis::BundleSettings::observationSolveSettings ( QString observationNumber ) const

Retrieves solve settings for the observation corresponding to the given observation number.

Parameters

observationNumber The observation number associated with the BundleObservationSolveSettings object to be accessed.

Returns: BundleObservationSolveSettings The observation settings object that contains the observation number passed.

Exceptions

IException::Unknown "Unable to find BundleObservationSolveSettings for given observation number"

References _FILEINFO_, numberSolveSettings(), and Isis::IException::Unknown.

Referenced by pvlObject().

BundleObservationSolveSettings Isis::BundleSettings::observationSolveSettings ( int n ) const

Retrieves solve settings for the observation corresponding to the given index.

Parameters

n	The index of the BundleObservationSolveSettings object to be accessed.

Returns: BundleObservationSolveSettings The observation settings object corresponding to the given index.

Exceptions

IException::Unknown "Unable to find BundleObservationSolveSettings with given index"

References _FILEINFO_, numberSolveSettings(), Isis::toString(), and Isis::IException::Unknown.

void Isis::BundleSettings::openH5Group	(	H5::CommonFG &	locationObject,
		QString	locationName
	)

HDF5 - TBD.

NOTE: Currently this method is not used and may be deleted. Documentation and testing to be completed if called. TargetBody info should be added also.

Parameters

@param

Exceptions

@throw
@throw
@throw
@throw

References _FILEINFO_, stringToConvergenceCriteria(), and Isis::IException::Unknown.

BundleSettings & Isis::BundleSettings::operator= ( const BundleSettings & other )

Assignment operator to allow proper copying of the 'other' BundleSettings object to this one.

Parameters

other The BundleSettings object to be copied.

Returns: BundleSettings& A reference to the copied BundleSettings object.

bool Isis::BundleSettings::outlierRejection ( ) const

This method is used to determine whether outlier rejection will be performed on this bundle adjustment.

Returns: bool Indicates whether to perform automatic outlier rejection during the bundle adjustment.

Referenced by pvlObject(), save(), and setOutlierRejection().

double Isis::BundleSettings::outlierRejectionMultiplier ( ) const

Retrieves the outlier rejection multiplier for the bundle adjustment.

Returns: double The outlier rejection multiplier.

Referenced by pvlObject(), and save().

QString Isis::BundleSettings::outputFilePrefix ( ) const

Retrieve the output file prefix.

This string will be appended to all of the output files created by the bundle adjustment.

Returns: QString A string containing a prefix and/or directory path to be appended to all output files.

Referenced by pvlObject(), save(), and setOutputFilePrefix().

void Isis::BundleSettings::parseH5Group	(	hid_t	locationId,
		QString	locationName
	)

PvlObject Isis::BundleSettings::pvlObject ( QString name = "BundleSettings" ) const

Create PvlObject with the given name containing the BundleSettings information.

Parameters

name	The name of the output PvlObject. Defaults to "BundleSettings".

Returns: PvlObject A PVL containing all of the BundleSettings information for this bundle adjustment.

References Isis::PvlKeyword::addValue(), convergenceCriteria(), convergenceCriteriaMaximumIterations(), convergenceCriteriaThreshold(), convergenceCriteriaToString(), createInverseMatrix(), errorPropagation(), globalLatitudeAprioriSigma(), globalLongitudeAprioriSigma(), globalRadiusAprioriSigma(), Isis::IsSpecial(), Isis::MaximumLikelihoodWFunctions::modelToString(), numberSolveSettings(), numberTargetBodyParameters(), observationSolveSettings(), outlierRejection(), outlierRejectionMultiplier(), outputFilePrefix(), Isis::BundleObservationSolveSettings::pvlObject(), solveMeanRadius(), solveObservationMode(), solvePM(), solvePMAcceleration(), solvePMVelocity(), solvePoleDec(), solvePoleDecVelocity(), solvePoleRA(), solvePoleRAVelocity(), solveRadius(), solveTargetBody(), solveTriaxialRadii(), Isis::toString(), updateCubeLabel(), and validateNetwork().

QDataStream & Isis::BundleSettings::read ( QDataStream & stream )

Reads BundleSettings object from a binary data stream.

May be used for HDF5.

NOTE: Currently this method is not used and may be deleted. Documentation and testing to be completed if called. TargetBody info should be added also.

References convergenceCriteria(), and convergenceCriteriaMaximumIterations().

Referenced by Isis::operator>>().

void Isis::BundleSettings::save	(	QXmlStreamWriter &	stream,
		const Project *	project
	)		const

This method is used to write a BundleSettings object to an XML format.

NOTE: Currently this method is not used and may be deleted. Documentation and testing to be completed if called. TargetBody info should be added also.

References convergenceCriteria(), convergenceCriteriaMaximumIterations(), convergenceCriteriaThreshold(), convergenceCriteriaToString(), createInverseMatrix(), errorPropagation(), globalLatitudeAprioriSigma(), globalLongitudeAprioriSigma(), globalRadiusAprioriSigma(), Isis::IsSpecial(), Isis::MaximumLikelihoodWFunctions::modelToString(), numberSolveSettings(), outlierRejection(), outlierRejectionMultiplier(), outputFilePrefix(), solveObservationMode(), solveRadius(), Isis::toString(), updateCubeLabel(), and validateNetwork().

QString Isis::BundleSettings::SCPVLFilename ( ) const

void Isis::BundleSettings::setBundleTargetBody ( BundleTargetBodyQsp bundleTargetBody )

Sets the target body for the bundle adjustment.

Parameters

bundleTargetBody A pointer to the BundleTargetBody object for the bundle adjustment to be run.

References bundleTargetBody().

void Isis::BundleSettings::setConvergenceCriteria	(	BundleSettings::ConvergenceCriteria	criteria,
		double	threshold,
		int	maximumIterations
	)

Set the convergence criteria options for the bundle adjustment.

Parameters

criteria	An enumeration for the convergence criteria to be used for this bundle adjustment.
threshold	The convergence threshold for this bundle adjustment.
maximumIterations	The maximum number of iterations allowed before the bundle adjustment determines that the data is not converging.

void Isis::BundleSettings::setCreateInverseMatrix ( bool createMatrixFile )

Turn the creation of the inverse correlation matrix file on or off.

Note that the inverse correlation matrix is created in BundleAdjust, and will only be created if error propagation is turned on. By default, BundleSettings allows the inverse matrix to be created. This requires stand-alone applications (e.g. jigsaw) to call this method to turn of the correlation matrix creation.

Parameters

createMatrixFile Boolean indicating whether or not to allow the inverse matrix file to be created.

See Also: BundleAdjust::errorPropagation()

void Isis::BundleSettings::setObservationSolveOptions ( QList< BundleObservationSolveSettings > obsSolveSettingsList )

Add the list of solve options for each observation.

Parameters

observationSolveSettings A list of BundleObservationSolveSettings objects to indicate the settings for each observation of the bundle adjustment.

void Isis::BundleSettings::setOutlierRejection	(	bool	outlierRejection,
		double	multiplier = `1.0`
	)

Set the outlier rejection options for the bundle adjustment.

Parameters

outlierRejection	Indicates whether to perform automatic outlier rejection during the bundle adjustment.
mutliplier	The outlier rejection multiplier.

References outlierRejection().

void Isis::BundleSettings::setOutputFilePrefix ( QString outputFilePrefix )

Set the output file prefix for the bundle adjustment.

Parameters

outputFilePrefix A string containing a prefix and/or directory path

References outputFilePrefix().

void Isis::BundleSettings::setSCPVLFilename ( QString SCParamFilename )

void Isis::BundleSettings::setSolveOptions	(	bool	solveObservationMode = `false`,
		bool	updateCubeLabel = `false`,
		bool	errorPropagation = `false`,
		bool	solveRadius = `false`,
		double	globalLatitudeAprioriSigma = `Isis::Null`,
		double	globalLongitudeAprioriSigma = `Isis::Null`,
		double	globalRadiusAprioriSigma = `Isis::Null`
	)

Set the solve options for the bundle adjustment.

Parameters

solveObservationMode	A boolean value indicating whether to solve for observation mode.
updateCubeLabel	A boolean value indicating whether to update the cube labels after the bundle adjustment is completed.
errorPropagation	A boolean value indicating whether to use the cholmod library's error propagation.
solveRadius	A boolean value indicating whether to solve for radius.
globalLatitudeAprioriSigma	The global a priori sigma for latitude.
globalLongitudeAprioriSigma	The global a priori sigma for longitude.
globalRadiusAprioriSigma	The global a priori sigma for radius.

References errorPropagation(), globalLatitudeAprioriSigma(), globalLongitudeAprioriSigma(), globalRadiusAprioriSigma(), Isis::Null, solveObservationMode(), solveRadius(), and updateCubeLabel().

void Isis::BundleSettings::setValidateNetwork ( bool validate )

Sets the internal flag to indicate whether to validate the network before the bundle adjustment.

See Also: BundleAdjust::validateNetwork()

Parameters

validate Indicates whether the network should be validated by BundleAdjust.

References Isis::validate().

bool Isis::BundleSettings::solveMeanRadius ( ) const

This method is used to determine whether the bundle adjustment will solve for target body mean radius.

See Also: BundleTargetBody::solveMeanRadius()

Returns: bool Indicates whether to solve for target mean radius.

Referenced by pvlObject().

bool Isis::BundleSettings::solveObservationMode ( ) const

This method is used to determine whether this bundle adjustment will solve for observation mode.

Returns: bool Indicates whether to solve for observation mode.

Referenced by pvlObject(), save(), and setSolveOptions().

bool Isis::BundleSettings::solvePM ( ) const

This method is used to determine whether the bundle adjustment will solve for target body prime meridian.

See Also: BundleTargetBody::solvePM()

Returns: bool Indicates whether to solve for target PM.

Referenced by pvlObject().

bool Isis::BundleSettings::solvePMAcceleration ( ) const

This method is used to determine whether the bundle adjustment will solve for target body prime meridian acceleration.

See Also: BundleTargetBody::solvePMAcceleration()

Returns: bool Indicates whether to solve for target PM acceleration.

Referenced by pvlObject().

bool Isis::BundleSettings::solvePMVelocity ( ) const

This method is used to determine whether the bundle adjustment will solve for target body prime meridian velocity.

See Also: BundleTargetBody::solvePMVelocity()

Returns: bool Indicates whether to solve for target PM velocity.

Referenced by pvlObject().

bool Isis::BundleSettings::solvePoleDec ( ) const

This method is used to determine whether the bundle adjustment will solve for target body pole declination.

See Also: BundleTargetBody::solvePoleDeclination()

Returns: bool Indicates whether to solve for target pole declination.

Referenced by pvlObject().

bool Isis::BundleSettings::solvePoleDecVelocity ( ) const

This method is used to determine whether the bundle adjustment will solve for target body pole declination velocity.

See Also: BundleTargetBody::solvePoleDeclinationVelocity()

Returns: bool Indicates whether to solve for target pole declination velocity.

Referenced by pvlObject().

bool Isis::BundleSettings::solvePoleRA ( ) const

This method is used to determine whether the bundle adjustment will solve for target body pole right ascension.

See Also: BundleTargetBody::solvePoleRA()

Returns: bool Indicates whether to solve for target pole RA.

Referenced by pvlObject().

bool Isis::BundleSettings::solvePoleRAVelocity ( ) const

This method is used to determine whether the bundle adjustment will solve for target body pole right ascension velocity.

See Also: BundleTargetBody::solvePoleRAVelocity()

Returns: bool Indicates whether to solve for target pole RA velocity.

Referenced by pvlObject().

bool Isis::BundleSettings::solveRadius ( ) const

This method is used to determine whether this bundle adjustment will solve for radius.

Returns: bool Indicates whether to solve for radius.

Referenced by pvlObject(), save(), and setSolveOptions().

bool Isis::BundleSettings::solveTargetBody ( ) const

This method is used to determine whether the bundle adjustment will solve for target body.

Returns: bool Indicates whether to solve for target body.

Referenced by pvlObject().

bool Isis::BundleSettings::solveTriaxialRadii ( ) const

This method is used to determine whether the bundle adjustment will solve for target body triaxial radii.

See Also: BundleTargetBody::solveTriaxialRadii()

Returns: bool Indicates whether to solve for target triaxial radii.

Referenced by pvlObject().

BundleSettings::ConvergenceCriteria Isis::BundleSettings::stringToConvergenceCriteria ( QString criteria )

static

Converts the given string value to a BundleSettings::ConvergenceCriteria enumeration.

Currently accepted inputs are listed below. This method is case insensitive.

Sigma0
ParameterCorrections

Parameters

criteria Convergence criteria name to be converted.

Returns: ConvergenceCriteria The enumeration corresponding to the given name.

Exceptions

Isis::Exception::Programmer "Unknown bundle convergence criteria."

References _FILEINFO_, ParameterCorrections, Isis::IException::Programmer, and Sigma0.

Referenced by openH5Group().

bool Isis::BundleSettings::updateCubeLabel ( ) const

This method is used to determine whether this bundle adjustment will update the cube labels.

Returns: bool Indicates whether to update the cube labels after the bundle adjustment is completed.

Referenced by pvlObject(), save(), and setSolveOptions().

bool Isis::BundleSettings::validateNetwork ( ) const

This method is used to determine whether to validate the network before the bundle adjustment.

See Also: BundleAdjust::validateNetwork()

Returns: bool Indicates whether the network should be validated by BundleAdjust.

Referenced by pvlObject(), and save().

QDataStream & Isis::BundleSettings::write ( QDataStream & stream ) const

Writes BundleSettings object to a binary data stream.

May be used for HDF5.

NOTE: Currently this method is not used and may be deleted. Documentation and testing to be completed if called. TargetBody info should be added also.

Referenced by Isis::operator<<().

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

src/control/objs/BundleSettings/BundleSettings.h
src/control/objs/BundleSettings/BundleSettings.cpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation