Container class for BundleAdjustment settings. More...

#include <BundleSettings.h>

Collaboration diagram for Isis::BundleSettings:

Classes
struct	MaximumLikelihoodModelTableRecord
	This struct is needed to write the m_maximumLikelihood variable as an HDF5 table. More...

class	XmlHandler
	This class is needed to read/write BundleSettings from/to an XML formateed file. More...

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

Private Attributes
QUuid *	m_id
	A unique ID for this BundleSettings object. More...

bool	m_validateNetwork
	Indicates whether the network should be validated. More...

bool	m_solveObservationMode
	Indicates whether to solve for observation mode. More...

bool	m_solveRadius
	Indicates whether to solve for point radii. More...

bool	m_updateCubeLabel
	Indicates whether to update cubes. More...

bool	m_errorPropagation
	Indicates whether to perform error propagation. More...

bool	m_createInverseMatrix
	Indicates whether to create the inverse matrix file. More...

bool	m_outlierRejection
	Indicates whether to perform automatic outlier detection/rejection. More...

double	m_outlierRejectionMultiplier
	The multiplier value for outlier rejection. More...

double	m_globalLatitudeAprioriSigma
	The global a priori sigma for latitude. More...

double	m_globalLongitudeAprioriSigma
	The global a priori sigma for longitude. More...

double	m_globalRadiusAprioriSigma
	The global a priori sigma for radius. More...

QList < BundleObservationSolveSettings >	m_observationSolveSettings

ConvergenceCriteria	m_convergenceCriteria
	Enumeration used to indicate what criteria to use to determine bundle adjustment convergence. More...

double	m_convergenceCriteriaThreshold
	Tolerance value corresponding to the selected convergence criteria. More...

int	m_convergenceCriteriaMaximumIterations
	Maximum number of iterations before quitting the bundle adjustment if it has not yet converged to the given threshold. More...

QList< QPair < MaximumLikelihoodWFunctions::Model, double > >	m_maximumLikelihood
	Model and C-Quantile for each of the three maximum likelihood estimations. More...

bool	m_solveTargetBody
	Indicates whether to solve for target body. More...

BundleTargetBodyQsp	m_bundleTargetBody
	A pointer to the target body settings and information. More...

QString	m_outputFilePrefix
	The prefix for all output files. 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

History:

2014-05-14 Jeannie Backer - Original version.

2014-07-16 Jeannie Backer - Removed redundant mutators. Moved implementation for numberSolveSettings() and observationSolveSettings() to cpp file. Removed static methods to convert MaximumLikelihoodWFunctions::Model enum to QString since these methods now exist in MaximumLikelihoodWFunctions class. Changed pvlGroup() method to pvlObject(). Added unitTest.

2014-07-23 Jeannie Backer - Added QDataStream >> and << operators and read/write methods. Created unitTest.

2014-07-25 Jeannie Backer - Improved unitTest coverage to 100% scope/line/function.

2014-11-17 Jeannie Backer - Added xml read/write capabilities. XmlHandler constructor/destructor is not shown as covered by unitTest. Current test code coverage is (scope 98.79%, line 98.698%, function 96.0%).

2015-09-03 Jeannie Backer - Changed a priori sigma defaults from -1.0 to Isis::Null.

2015-09-03 Jeannie Backer - Added preliminary hdf5 read/write capabilities.

2015-10-14 Jeffrey Covington - Declared BundleSettingsQsp as a Qt metatype for use with QVariant.

2016-06-30 Jeannie Backer - Changed method name from "getBundleTargetBody" to "bundleTargetBody" to comply with ISIS coding standards. Added documentation. Updated test. References #3976. Fixes #.

2016-08-15 Jesse Mapel - Added methods to check if solving for triaxial radii, mean radius, or Prime Meridian Acceleration. Fixes #4159.

2016-08-18 Jesse Mapel - Changed to no longer inherit from QObject. Fixes #4192.

2016-08-18 Jeannie Backer - Removed the SolveMethod enum and all references to it. This option was deprecated because the Sparse option is faster than the other options (OldSparse and SpecialK) and gets identical results. Fixes #4162.

2016-08-23 Jesse Mapel - Modified to no longer determine which output files BundleAdjust and BundleSolutionInfo create. Fixes #4279.

2016-09-02 Jesse Mapel - Added m_SCPVLFilename member for storing multi-sensor settings from jigsaw. Fixes #4316.

2016-10-05 Ian Humphrey - Added m_createInverseMatrix, createInverseMatrix(), and setCreateInverseMatrix() so that bundle settings stores whether or not the inverse correlation matrix file (inverseMatrix.dat) will be generated during error propagation in the adjustment. Fixes #4315.

2016-10-13 Ian Humphrey - Updated documentation and variable names for observationSolveSettings(), as BundleObservationSolveSettings are acquired by an associated observation number. References #4293.

2016-10-17 Jesse Mapel - Removed m_SCPVLFilename parameter in accordance with USEPVL being removed from jigsaw. References #4316.

Todo:

Determine which XmlStackedHandlerReader constructor is preferred

Determine which XmlStackedHandler needs a Project pointer (see constructors)

Determine whether QList<BundleObservationSolveSettings> m_observationSolveSettings should be a list of pointers, or a pointer to a list, or a pointer to a list of pointers, etc...

Determine whether QList< QPair< MaximumLikelihoodWFunctions::Model, double > > m_maximumLikelihood should be a list of pointers, or a pointer to a list, or a pointer to a list of pointers, etc... ;

Determine which to use or delete: XML or HDF5. Whichever is used needs to be fully documented, tested

Definition at line 119 of file BundleSettings.h.

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.

Definition at line 185 of file BundleSettings.h.

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

Definition at line 218 of file BundleSettings.h.

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

Definition at line 37 of file BundleSettings.cpp.

References m_convergenceCriteria, m_convergenceCriteriaMaximumIterations, m_convergenceCriteriaThreshold, m_createInverseMatrix, m_errorPropagation, m_globalLatitudeAprioriSigma, m_globalLongitudeAprioriSigma, m_globalRadiusAprioriSigma, m_id, m_maximumLikelihood, m_outlierRejection, m_outlierRejectionMultiplier, m_outputFilePrefix, m_solveObservationMode, m_solveRadius, m_solveTargetBody, m_updateCubeLabel, m_validateNetwork, 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.

Definition at line 173 of file BundleSettings.cpp.

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.

Definition at line 98 of file BundleSettings.cpp.

References m_id.

Isis::BundleSettings::~BundleSettings ( )

Destroys the BundleSettings object.

Definition at line 200 of file BundleSettings.cpp.

References m_id.

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

Definition at line 700 of file BundleSettings.cpp.

References _FILEINFO_, Isis::MaximumLikelihoodWFunctions::HuberModified, m_maximumLikelihood, 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.

Definition at line 752 of file BundleSettings.cpp.

References m_bundleTargetBody.

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.

Definition at line 633 of file BundleSettings.cpp.

References m_convergenceCriteria.

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.

Definition at line 657 of file BundleSettings.cpp.

References m_convergenceCriteriaMaximumIterations.

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.

Definition at line 644 of file BundleSettings.cpp.

References m_convergenceCriteriaThreshold.

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

Definition at line 598 of file BundleSettings.cpp.

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

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

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

Definition at line 1649 of file BundleSettings.cpp.

References _FILEINFO_, convergenceCriteriaToString(), m_convergenceCriteria, m_convergenceCriteriaMaximumIterations, m_convergenceCriteriaThreshold, m_createInverseMatrix, m_errorPropagation, m_globalLatitudeAprioriSigma, m_globalLongitudeAprioriSigma, m_globalRadiusAprioriSigma, m_outlierRejection, m_outlierRejectionMultiplier, m_outputFilePrefix, m_solveObservationMode, m_solveRadius, m_updateCubeLabel, m_validateNetwork, and Isis::IException::Unknown.

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

Definition at line 370 of file BundleSettings.cpp.

References m_createInverseMatrix, and m_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.

Definition at line 427 of file BundleSettings.cpp.

References m_errorPropagation.

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.

Definition at line 466 of file BundleSettings.cpp.

References m_globalLatitudeAprioriSigma.

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.

Definition at line 477 of file BundleSettings.cpp.

References m_globalLongitudeAprioriSigma.

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.

Definition at line 488 of file BundleSettings.cpp.

References m_globalRadiusAprioriSigma.

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.

Definition at line 722 of file BundleSettings.cpp.

References m_maximumLikelihood.

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.

Definition at line 499 of file BundleSettings.cpp.

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.

Definition at line 774 of file BundleSettings.cpp.

References m_bundleTargetBody.

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"

Definition at line 518 of file BundleSettings.cpp.

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"

Definition at line 543 of file BundleSettings.cpp.

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

Definition at line 1855 of file BundleSettings.cpp.

References _FILEINFO_, m_convergenceCriteria, m_convergenceCriteriaMaximumIterations, m_convergenceCriteriaThreshold, m_createInverseMatrix, m_errorPropagation, m_globalLatitudeAprioriSigma, m_globalLongitudeAprioriSigma, m_globalRadiusAprioriSigma, m_outlierRejection, m_outlierRejectionMultiplier, m_outputFilePrefix, m_solveObservationMode, m_solveRadius, m_updateCubeLabel, m_validateNetwork, 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.

Definition at line 214 of file BundleSettings.cpp.

References m_bundleTargetBody, m_convergenceCriteria, m_convergenceCriteriaMaximumIterations, m_convergenceCriteriaThreshold, m_createInverseMatrix, m_errorPropagation, m_globalLatitudeAprioriSigma, m_globalLongitudeAprioriSigma, m_globalRadiusAprioriSigma, m_id, m_maximumLikelihood, m_outlierRejection, m_outlierRejectionMultiplier, m_outputFilePrefix, m_solveObservationMode, m_solveRadius, m_solveTargetBody, m_updateCubeLabel, and m_validateNetwork.

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.

Definition at line 382 of file BundleSettings.cpp.

References m_outlierRejection.

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.

Definition at line 455 of file BundleSettings.cpp.

References m_outlierRejectionMultiplier.

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.

Definition at line 1009 of file BundleSettings.cpp.

References m_outputFilePrefix.

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

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.

Definition at line 1023 of file BundleSettings.cpp.

References Isis::PvlKeyword::addValue(), convergenceCriteria(), convergenceCriteriaMaximumIterations(), convergenceCriteriaThreshold(), convergenceCriteriaToString(), createInverseMatrix(), errorPropagation(), globalLatitudeAprioriSigma(), globalLongitudeAprioriSigma(), globalRadiusAprioriSigma(), Isis::IsSpecial(), m_maximumLikelihood, m_outlierRejection, m_solveRadius, 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.

Definition at line 1570 of file BundleSettings.cpp.

References convergenceCriteria(), convergenceCriteriaMaximumIterations(), m_convergenceCriteria, m_convergenceCriteriaMaximumIterations, m_convergenceCriteriaThreshold, m_createInverseMatrix, m_errorPropagation, m_globalLatitudeAprioriSigma, m_globalLongitudeAprioriSigma, m_globalRadiusAprioriSigma, m_id, m_maximumLikelihood, m_outlierRejection, m_outlierRejectionMultiplier, m_outputFilePrefix, m_solveObservationMode, m_solveRadius, m_updateCubeLabel, and m_validateNetwork.

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.

Definition at line 1120 of file BundleSettings.cpp.

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

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.

Definition at line 741 of file BundleSettings.cpp.

References bundleTargetBody(), and m_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.

Definition at line 618 of file BundleSettings.cpp.

References m_convergenceCriteria, m_convergenceCriteriaMaximumIterations, and m_convergenceCriteriaThreshold.

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

Definition at line 445 of file BundleSettings.cpp.

References m_createInverseMatrix.

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.

Definition at line 353 of file BundleSettings.cpp.

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.

Definition at line 335 of file BundleSettings.cpp.

References m_outlierRejection, m_outlierRejectionMultiplier, and 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

Definition at line 995 of file BundleSettings.cpp.

References m_outputFilePrefix, and outputFilePrefix().

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.

Definition at line 293 of file BundleSettings.cpp.

References errorPropagation(), globalLatitudeAprioriSigma(), globalLongitudeAprioriSigma(), globalRadiusAprioriSigma(), m_errorPropagation, m_globalLatitudeAprioriSigma, m_globalLongitudeAprioriSigma, m_globalRadiusAprioriSigma, m_solveObservationMode, m_solveRadius, m_updateCubeLabel, 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.

Definition at line 254 of file BundleSettings.cpp.

References m_validateNetwork, and 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.

Definition at line 934 of file BundleSettings.cpp.

References m_bundleTargetBody.

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.

Definition at line 393 of file BundleSettings.cpp.

References m_solveObservationMode.

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.

Definition at line 870 of file BundleSettings.cpp.

References m_bundleTargetBody.

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.

Definition at line 902 of file BundleSettings.cpp.

References m_bundleTargetBody.

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.

Definition at line 886 of file BundleSettings.cpp.

References m_bundleTargetBody.

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.

Definition at line 838 of file BundleSettings.cpp.

References m_bundleTargetBody.

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.

Definition at line 854 of file BundleSettings.cpp.

References m_bundleTargetBody.

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.

Definition at line 806 of file BundleSettings.cpp.

References m_bundleTargetBody.

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.

Definition at line 822 of file BundleSettings.cpp.

References m_bundleTargetBody.

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.

Definition at line 404 of file BundleSettings.cpp.

References m_solveRadius.

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.

Definition at line 788 of file BundleSettings.cpp.

References m_bundleTargetBody.

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.

Definition at line 918 of file BundleSettings.cpp.

References m_bundleTargetBody.

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

Definition at line 574 of file BundleSettings.cpp.

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

Referenced by openH5Group(), and Isis::BundleSettings::XmlHandler::startElement().

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.

Definition at line 416 of file BundleSettings.cpp.

References m_updateCubeLabel.

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.

Definition at line 269 of file BundleSettings.cpp.

References m_validateNetwork.

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.

Definition at line 1536 of file BundleSettings.cpp.

References m_convergenceCriteria, m_convergenceCriteriaMaximumIterations, m_convergenceCriteriaThreshold, m_createInverseMatrix, m_errorPropagation, m_globalLatitudeAprioriSigma, m_globalLongitudeAprioriSigma, m_globalRadiusAprioriSigma, m_id, m_maximumLikelihood, m_outlierRejection, m_outlierRejectionMultiplier, m_outputFilePrefix, m_solveObservationMode, m_solveRadius, m_updateCubeLabel, and m_validateNetwork.

Referenced by Isis::operator<<().

Member Data Documentation

BundleTargetBodyQsp Isis::BundleSettings::m_bundleTargetBody

private

A pointer to the target body settings and information.

Definition at line 394 of file BundleSettings.h.

Referenced by bundleTargetBody(), numberTargetBodyParameters(), operator=(), setBundleTargetBody(), solveMeanRadius(), solvePM(), solvePMAcceleration(), solvePMVelocity(), solvePoleDec(), solvePoleDecVelocity(), solvePoleRA(), solvePoleRAVelocity(), solveTargetBody(), and solveTriaxialRadii().

ConvergenceCriteria Isis::BundleSettings::m_convergenceCriteria

private

Enumeration used to indicate what criteria to use to determine bundle adjustment convergence.

Definition at line 371 of file BundleSettings.h.

Referenced by BundleSettings(), convergenceCriteria(), createH5Group(), openH5Group(), operator=(), read(), setConvergenceCriteria(), and write().

int Isis::BundleSettings::m_convergenceCriteriaMaximumIterations

private

Maximum number of iterations before quitting the bundle adjustment if it has not yet converged to the given threshold.

Definition at line 376 of file BundleSettings.h.

Referenced by BundleSettings(), convergenceCriteriaMaximumIterations(), createH5Group(), openH5Group(), operator=(), read(), setConvergenceCriteria(), and write().

double Isis::BundleSettings::m_convergenceCriteriaThreshold

private

Tolerance value corresponding to the selected convergence criteria.

Definition at line 374 of file BundleSettings.h.

Referenced by BundleSettings(), convergenceCriteriaThreshold(), createH5Group(), openH5Group(), operator=(), read(), setConvergenceCriteria(), and write().

bool Isis::BundleSettings::m_createInverseMatrix

private

Indicates whether to create the inverse matrix file.

Definition at line 356 of file BundleSettings.h.

Referenced by BundleSettings(), createH5Group(), createInverseMatrix(), openH5Group(), operator=(), read(), setCreateInverseMatrix(), and write().

bool Isis::BundleSettings::m_errorPropagation

private

Indicates whether to perform error propagation.

Definition at line 355 of file BundleSettings.h.

Referenced by BundleSettings(), createH5Group(), createInverseMatrix(), errorPropagation(), openH5Group(), operator=(), read(), setSolveOptions(), and write().

double Isis::BundleSettings::m_globalLatitudeAprioriSigma

private

The global a priori sigma for latitude.

Definition at line 363 of file BundleSettings.h.

Referenced by BundleSettings(), createH5Group(), globalLatitudeAprioriSigma(), openH5Group(), operator=(), read(), setSolveOptions(), and write().

double Isis::BundleSettings::m_globalLongitudeAprioriSigma

private

The global a priori sigma for longitude.

Definition at line 364 of file BundleSettings.h.

Referenced by BundleSettings(), createH5Group(), globalLongitudeAprioriSigma(), openH5Group(), operator=(), read(), setSolveOptions(), and write().

double Isis::BundleSettings::m_globalRadiusAprioriSigma

private

The global a priori sigma for radius.

Definition at line 365 of file BundleSettings.h.

Referenced by BundleSettings(), createH5Group(), globalRadiusAprioriSigma(), openH5Group(), operator=(), read(), setSolveOptions(), and write().

QUuid* Isis::BundleSettings::m_id

private

A unique ID for this BundleSettings object.

Used to reference this object when saving to disk.

Definition at line 349 of file BundleSettings.h.

Referenced by BundleSettings(), operator=(), read(), save(), write(), and ~BundleSettings().

QList< QPair< MaximumLikelihoodWFunctions::Model, double > > Isis::BundleSettings::m_maximumLikelihood

private

Model and C-Quantile for each of the three maximum likelihood estimations.

The C-Quantile is the quantile of the residual used to compute the tweaking constant. Note that this is an ordered list and that the Welsch and Chen models can not be used for the first model.

Definition at line 388 of file BundleSettings.h.

Referenced by addMaximumLikelihoodEstimatorModel(), BundleSettings(), maximumLikelihoodEstimatorModels(), operator=(), pvlObject(), read(), save(), and write().