Isis 3 Programmer Reference
|
Container class for BundleAdjustment settings. More...
#include <BundleSettings.h>
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, SurfacePoint::CoordinateType coordTypeBundle=SurfacePoint::Latitudinal, SurfacePoint::CoordinateType coordTypeReports=SurfacePoint::Latitudinal, double globalPointCoord1AprioriSigma=Isis::Null, double globalPointCoord2AprioriSigma=Isis::Null, double globalPointCoord3AprioriSigma=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... | |
SurfacePoint::CoordinateType | controlPointCoordTypeReports () const |
Indicates the control point coordinate type for reports. More... | |
SurfacePoint::CoordinateType | controlPointCoordTypeBundle () const |
Indicates the control point coordinate type for the actual bundle adjust. 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 | globalPointCoord1AprioriSigma () const |
Retrieves global a priori sigma for 1st coordinate of points for this bundle. More... | |
double | globalPointCoord2AprioriSigma () const |
Retrieves the global a priori sigma for 2nd coordinate of points for this bundle. More... | |
double | globalPointCoord3AprioriSigma () const |
Retrieves the global a priori sigma 3rd coordinate of points for this bundle. 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... | |
QList< BundleObservationSolveSettings > | observationSolveSettings () 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... | |
void | setCubeList (QString fileName) |
BundleSettings::setCubeList. More... | |
QString | cubeList () const |
BundleSettings::cubeList. More... | |
QString | SCPVLFilename () const |
void | save (QXmlStreamWriter &stream, const Project *project) const |
This method is used to write a BundleSettings object in an XML format. More... | |
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 Member Functions | |
void | init () |
Set Default vales for a BundleSettings object. More... | |
Private Attributes | |
bool | m_validateNetwork |
Indicates whether the network should be validated. More... | |
QString | m_cubeList |
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_globalPointCoord1AprioriSigma |
The global a priori sigma for latitude or X. More... | |
double | m_globalPointCoord2AprioriSigma |
The global a priori sigma for longitude or Y. More... | |
double | m_globalPointCoord3AprioriSigma |
The global a priori sigma for radius or Z. 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... | |
SurfacePoint::CoordinateType | m_cpCoordTypeReports |
Indicates the coordinate type for outputting control points in reports. More... | |
SurfacePoint::CoordinateType | m_cpCoordTypeBundle |
Indicates the coordinate type used for control points in the bundle adjustment. More... | |
QString | m_outputFilePrefix |
The prefix for all output files. More... | |
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.
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.
2017-04-24 Ian Humphrey - Removed pvlObject(). Fixes #4797.
2018-03-20 Ken Edmundson 1) Temporarily set default for m_createInverseMatrix to false. This is for creating and displaying the correlation matrix, which is currently not working. 2) commented out hdf5 header includes in cpp
2018-06-28 Christopher Combs - Added observationSolveSettings() method to retrieve m_observationSolveSettings. Fixes #497.
2019-05-17 Tyler Wilson - Added QString m_cubeList member function as well as get/set member functions. References #3267.
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...
TargetBody information is not being serialized. A determination needs to be made as to where it will be stored.
Definition at line 138 of file BundleSettings.h.
This enum defines the options for the bundle adjustment's convergence.
Definition at line 210 of file BundleSettings.h.
This enum defines the options for maximum likelihood estimation.
Definition at line 243 of file BundleSettings.h.
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.
Definition at line 31 of file BundleSettings.cpp.
References init().
Isis::BundleSettings::BundleSettings | ( | const BundleSettings & | other | ) |
This copy constructor sets this BundleSettings' member data to match that of the 'other' given BundleSettings.
other | The BundleSettings object to be copied. |
Definition at line 116 of file BundleSettings.cpp.
Isis::BundleSettings::BundleSettings | ( | Project * | project, |
XmlStackedHandlerReader * | xmlReader | ||
) |
Construct a BundleSettings object from member data read from an XML file.
project | A pointer to the project where the Settings will be saved. |
xmlReader | The Content handler to parse the BundleSettings XML |
Definition at line 102 of file BundleSettings.cpp.
References init(), and Isis::XmlStackedHandlerReader::pushContentHandler().
Isis::BundleSettings::~BundleSettings | ( | ) |
Destroys the BundleSettings object.
Definition at line 145 of file BundleSettings.cpp.
void Isis::BundleSettings::addMaximumLikelihoodEstimatorModel | ( | MaximumLikelihoodWFunctions::Model | model, |
double | maxModelCQuantile | ||
) |
Add a maximum likelihood estimator (MLE) model to the bundle adjustment.
model | The enumeration for the model to be used. |
maxModelCQuantile | The C-Quantile of the residual to be used to compute the tweaking constant. |
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 722 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.
Definition at line 774 of file BundleSettings.cpp.
References m_bundleTargetBody.
Referenced by setBundleTargetBody().
SurfacePoint::CoordinateType Isis::BundleSettings::controlPointCoordTypeBundle | ( | ) | const |
Indicates the control point coordinate type for the actual bundle adjust.
This method returns the control point coordinate setting for performing the bundle adjust.
Definition at line 367 of file BundleSettings.cpp.
References m_cpCoordTypeBundle.
Referenced by save().
SurfacePoint::CoordinateType Isis::BundleSettings::controlPointCoordTypeReports | ( | ) | const |
Indicates the control point coordinate type for reports.
This method returns the control point coordinate setting for reporting control points.
Definition at line 353 of file BundleSettings.cpp.
References m_cpCoordTypeReports.
Referenced by save().
BundleSettings::ConvergenceCriteria Isis::BundleSettings::convergenceCriteria | ( | ) | const |
Retrieves the convergence criteria to be used to solve the bundle adjustment.
Definition at line 655 of file BundleSettings.cpp.
References m_convergenceCriteria.
Referenced by save().
int Isis::BundleSettings::convergenceCriteriaMaximumIterations | ( | ) | const |
Retrieves the maximum number of iterations allowed to solve the bundle adjustment.
maximumIterations | The maximum number of iterations allowed before the bundle adjustment determines that the data is not converging. |
Definition at line 679 of file BundleSettings.cpp.
References m_convergenceCriteriaMaximumIterations.
Referenced by save().
double Isis::BundleSettings::convergenceCriteriaThreshold | ( | ) | const |
Retrieves the convergence threshold to be used to solve the bundle adjustment.
Definition at line 666 of file BundleSettings.cpp.
References m_convergenceCriteriaThreshold.
Referenced by save().
|
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.
criteria | The ConvergenceCriteria enumeration to be converted. |
Isis::Exception::Programmer | "Unknown bundle convergence criteria enum." |
Definition at line 620 of file BundleSettings.cpp.
References _FILEINFO_, ParameterCorrections, Isis::IException::Programmer, Sigma0, and Isis::toString().
Referenced by save().
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.
Definition at line 383 of file BundleSettings.cpp.
References m_createInverseMatrix, and m_errorPropagation.
Referenced by save().
QString Isis::BundleSettings::cubeList | ( | ) | const |
Definition at line 236 of file BundleSettings.cpp.
Referenced by setCubeList().
bool Isis::BundleSettings::errorPropagation | ( | ) | const |
This method is used to determine whether this bundle adjustment will perform error propagation.
Definition at line 440 of file BundleSettings.cpp.
References m_errorPropagation.
Referenced by save(), and setSolveOptions().
double Isis::BundleSettings::globalPointCoord1AprioriSigma | ( | ) | const |
Retrieves global a priori sigma for 1st coordinate of points for this bundle.
Definition at line 478 of file BundleSettings.cpp.
References m_globalPointCoord1AprioriSigma.
Referenced by save(), and setSolveOptions().
double Isis::BundleSettings::globalPointCoord2AprioriSigma | ( | ) | const |
Retrieves the global a priori sigma for 2nd coordinate of points for this bundle.
Definition at line 488 of file BundleSettings.cpp.
References m_globalPointCoord2AprioriSigma.
Referenced by save(), and setSolveOptions().
double Isis::BundleSettings::globalPointCoord3AprioriSigma | ( | ) | const |
Retrieves the global a priori sigma 3rd coordinate of points for this bundle.
Definition at line 498 of file BundleSettings.cpp.
References m_globalPointCoord3AprioriSigma.
Referenced by save(), and setSolveOptions().
|
private |
Set Default vales for a BundleSettings object.
Note we call the default constructor to initialize the TargetBody information that is not currently in the XML.
Definition at line 42 of file BundleSettings.cpp.
References Isis::SurfacePoint::Latitudinal, m_convergenceCriteria, m_convergenceCriteriaMaximumIterations, m_convergenceCriteriaThreshold, m_cpCoordTypeBundle, m_cpCoordTypeReports, m_createInverseMatrix, m_errorPropagation, m_globalPointCoord1AprioriSigma, m_globalPointCoord2AprioriSigma, m_globalPointCoord3AprioriSigma, m_maximumLikelihood, m_outlierRejection, m_outlierRejectionMultiplier, m_outputFilePrefix, m_solveObservationMode, m_solveRadius, m_solveTargetBody, m_updateCubeLabel, m_validateNetwork, Isis::Null, and Sigma0.
Referenced by BundleSettings().
QList< QPair< MaximumLikelihoodWFunctions::Model, double > > Isis::BundleSettings::maximumLikelihoodEstimatorModels | ( | ) | const |
Retrieves the list of maximum likelihood estimator (MLE) models with their corresponding C-Quantiles.
Definition at line 744 of file BundleSettings.cpp.
References m_maximumLikelihood.
int Isis::BundleSettings::numberSolveSettings | ( | ) | const |
Retrieves the number of observation solve settings.
Definition at line 509 of file BundleSettings.cpp.
Referenced by observationSolveSettings().
int Isis::BundleSettings::numberTargetBodyParameters | ( | ) | const |
This method is used to determine whether the bundle adjustment will solve for target body pole position.
Definition at line 796 of file BundleSettings.cpp.
References m_bundleTargetBody.
BundleObservationSolveSettings Isis::BundleSettings::observationSolveSettings | ( | QString | observationNumber | ) | const |
Retrieves solve settings for the observation corresponding to the given observation number.
If no corresponding settings object exists, return a new solve settings with no related observation numbers.
observationNumber | The observation number associated with the BundleObservationSolveSettings object to be accessed. |
Definition at line 526 of file BundleSettings.cpp.
References numberSolveSettings().
BundleObservationSolveSettings Isis::BundleSettings::observationSolveSettings | ( | int | n | ) | const |
Retrieves solve settings for the observation corresponding to the given index.
n | The index of the BundleObservationSolveSettings object to be accessed. |
IException::Unknown | "Unable to find BundleObservationSolveSettings with given index" |
Definition at line 554 of file BundleSettings.cpp.
References _FILEINFO_, numberSolveSettings(), Isis::toString(), and Isis::IException::Unknown.
QList< BundleObservationSolveSettings > Isis::BundleSettings::observationSolveSettings | ( | ) | const |
Retrieves solve settings for the observation corresponding to the given index.
Definition at line 571 of file BundleSettings.cpp.
BundleSettings & Isis::BundleSettings::operator= | ( | const BundleSettings & | other | ) |
Assignment operator to allow proper copying of the 'other' BundleSettings object to this one.
other | The BundleSettings object to be copied. |
Definition at line 161 of file BundleSettings.cpp.
References m_bundleTargetBody, m_convergenceCriteria, m_convergenceCriteriaMaximumIterations, m_convergenceCriteriaThreshold, m_cpCoordTypeBundle, m_cpCoordTypeReports, m_createInverseMatrix, m_errorPropagation, m_globalPointCoord1AprioriSigma, m_globalPointCoord2AprioriSigma, m_globalPointCoord3AprioriSigma, 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.
Definition at line 395 of file BundleSettings.cpp.
References m_outlierRejection.
Referenced by save(), and setOutlierRejection().
double Isis::BundleSettings::outlierRejectionMultiplier | ( | ) | const |
Retrieves the outlier rejection multiplier for the bundle adjustment.
Definition at line 468 of file BundleSettings.cpp.
References m_outlierRejectionMultiplier.
Referenced by 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.
Definition at line 1031 of file BundleSettings.cpp.
References m_outputFilePrefix.
Referenced by save(), and setOutputFilePrefix().
void Isis::BundleSettings::save | ( | QXmlStreamWriter & | stream, |
const Project * | project | ||
) | const |
This method is used to write a BundleSettings object in an XML format.
stream | The stream to write serialized XML output |
project | The project that contains the settings |
Definition at line 1045 of file BundleSettings.cpp.
References controlPointCoordTypeBundle(), controlPointCoordTypeReports(), convergenceCriteria(), convergenceCriteriaMaximumIterations(), convergenceCriteriaThreshold(), convergenceCriteriaToString(), createInverseMatrix(), errorPropagation(), globalPointCoord1AprioriSigma(), globalPointCoord2AprioriSigma(), globalPointCoord3AprioriSigma(), Isis::IsSpecial(), m_maximumLikelihood, Isis::MaximumLikelihoodWFunctions::modelToString(), outlierRejection(), outlierRejectionMultiplier(), outputFilePrefix(), solveObservationMode(), solveRadius(), Isis::toString(), updateCubeLabel(), and validateNetwork().
void Isis::BundleSettings::setBundleTargetBody | ( | BundleTargetBodyQsp | bundleTargetBody | ) |
Sets the target body for the bundle adjustment.
bundleTargetBody | A pointer to the BundleTargetBody object for the bundle adjustment to be run. |
Definition at line 763 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.
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 640 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.
createMatrixFile | Boolean indicating whether or not to allow the inverse matrix file to be created. |
Definition at line 458 of file BundleSettings.cpp.
References m_createInverseMatrix.
void Isis::BundleSettings::setCubeList | ( | QString | cubeList | ) |
void Isis::BundleSettings::setObservationSolveOptions | ( | QList< BundleObservationSolveSettings > | obsSolveSettingsList | ) |
Add the list of solve options for each observation.
observationSolveSettings | A list of BundleObservationSolveSettings objects to indicate the settings for each observation of the bundle adjustment. |
Definition at line 339 of file BundleSettings.cpp.
void Isis::BundleSettings::setOutlierRejection | ( | bool | outlierRejection, |
double | multiplier = 1.0 |
||
) |
Set the outlier rejection options for the bundle adjustment.
outlierRejection | Indicates whether to perform automatic outlier rejection during the bundle adjustment. |
mutliplier | The outlier rejection multiplier. |
Definition at line 321 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.
outputFilePrefix | A string containing a prefix and/or directory path |
Definition at line 1017 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 , |
||
SurfacePoint::CoordinateType | coordTypeBundle = SurfacePoint::Latitudinal , |
||
SurfacePoint::CoordinateType | coordTypeReports = SurfacePoint::Latitudinal , |
||
double | globalPointCoord1AprioriSigma = Isis::Null , |
||
double | globalPointCoord2AprioriSigma = Isis::Null , |
||
double | globalPointCoord3AprioriSigma = Isis::Null |
||
) |
Set the solve options for the bundle adjustment.
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. |
coordType | The type of coordinates used for control points |
globalPointCoord1AprioriSigma | The global a priori sigma for latitude. |
globalPointCoord2AprioriSigma | The global a priori sigma for longitude. |
globalPointCoord3AprioriSigma | The global a priori sigma for radius. |
Definition at line 261 of file BundleSettings.cpp.
References errorPropagation(), globalPointCoord1AprioriSigma(), globalPointCoord2AprioriSigma(), globalPointCoord3AprioriSigma(), Isis::SurfacePoint::Latitudinal, m_cpCoordTypeBundle, m_cpCoordTypeReports, m_errorPropagation, m_globalPointCoord1AprioriSigma, m_globalPointCoord2AprioriSigma, m_globalPointCoord3AprioriSigma, m_solveObservationMode, m_solveRadius, m_updateCubeLabel, Isis::Null, Isis::SurfacePoint::Rectangular, 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.
validate | Indicates whether the network should be validated by BundleAdjust. |
Definition at line 200 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.
Definition at line 956 of file BundleSettings.cpp.
References m_bundleTargetBody.
bool Isis::BundleSettings::solveObservationMode | ( | ) | const |
This method is used to determine whether this bundle adjustment will solve for observation mode.
Definition at line 406 of file BundleSettings.cpp.
References m_solveObservationMode.
Referenced by 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.
Definition at line 892 of file BundleSettings.cpp.
References m_bundleTargetBody.
bool Isis::BundleSettings::solvePMAcceleration | ( | ) | const |
This method is used to determine whether the bundle adjustment will solve for target body prime meridian acceleration.
Definition at line 924 of file BundleSettings.cpp.
References m_bundleTargetBody.
bool Isis::BundleSettings::solvePMVelocity | ( | ) | const |
This method is used to determine whether the bundle adjustment will solve for target body prime meridian velocity.
Definition at line 908 of file BundleSettings.cpp.
References m_bundleTargetBody.
bool Isis::BundleSettings::solvePoleDec | ( | ) | const |
This method is used to determine whether the bundle adjustment will solve for target body pole declination.
Definition at line 860 of file BundleSettings.cpp.
References m_bundleTargetBody.
bool Isis::BundleSettings::solvePoleDecVelocity | ( | ) | const |
This method is used to determine whether the bundle adjustment will solve for target body pole declination velocity.
Definition at line 876 of file BundleSettings.cpp.
References m_bundleTargetBody.
bool Isis::BundleSettings::solvePoleRA | ( | ) | const |
This method is used to determine whether the bundle adjustment will solve for target body pole right ascension.
Definition at line 828 of file BundleSettings.cpp.
References m_bundleTargetBody.
bool Isis::BundleSettings::solvePoleRAVelocity | ( | ) | const |
This method is used to determine whether the bundle adjustment will solve for target body pole right ascension velocity.
Definition at line 844 of file BundleSettings.cpp.
References m_bundleTargetBody.
bool Isis::BundleSettings::solveRadius | ( | ) | const |
This method is used to determine whether this bundle adjustment will solve for radius.
Definition at line 417 of file BundleSettings.cpp.
References m_solveRadius.
Referenced by save(), and setSolveOptions().
bool Isis::BundleSettings::solveTargetBody | ( | ) | const |
This method is used to determine whether the bundle adjustment will solve for target body.
Definition at line 810 of file BundleSettings.cpp.
References m_bundleTargetBody.
bool Isis::BundleSettings::solveTriaxialRadii | ( | ) | const |
This method is used to determine whether the bundle adjustment will solve for target body triaxial radii.
Definition at line 940 of file BundleSettings.cpp.
References m_bundleTargetBody.
|
static |
Converts the given string value to a BundleSettings::ConvergenceCriteria enumeration.
Currently accepted inputs are listed below. This method is case insensitive.
criteria | Convergence criteria name to be converted. |
Isis::Exception::Programmer | "Unknown bundle convergence criteria." |
Definition at line 596 of file BundleSettings.cpp.
References _FILEINFO_, ParameterCorrections, Isis::IException::Programmer, and Sigma0.
Referenced by Isis::BundleSettings::XmlHandler::startElement().
bool Isis::BundleSettings::updateCubeLabel | ( | ) | const |
This method is used to determine whether this bundle adjustment will update the cube labels.
Definition at line 429 of file BundleSettings.cpp.
References m_updateCubeLabel.
Referenced by save(), and setSolveOptions().
bool Isis::BundleSettings::validateNetwork | ( | ) | const |
This method is used to determine whether to validate the network before the bundle adjustment.
Definition at line 215 of file BundleSettings.cpp.
References m_validateNetwork.
Referenced by save().
|
private |
A pointer to the target body settings and information.
Definition at line 403 of file BundleSettings.h.
Referenced by bundleTargetBody(), numberTargetBodyParameters(), operator=(), setBundleTargetBody(), solveMeanRadius(), solvePM(), solvePMAcceleration(), solvePMVelocity(), solvePoleDec(), solvePoleDecVelocity(), solvePoleRA(), solvePoleRAVelocity(), solveTargetBody(), and solveTriaxialRadii().
|
private |
Enumeration used to indicate what criteria to use to determine bundle adjustment convergence.
Definition at line 380 of file BundleSettings.h.
Referenced by convergenceCriteria(), init(), operator=(), and setConvergenceCriteria().
|
private |
Maximum number of iterations before quitting the bundle adjustment if it has not yet converged to the given threshold.
Definition at line 385 of file BundleSettings.h.
Referenced by convergenceCriteriaMaximumIterations(), init(), operator=(), and setConvergenceCriteria().
|
private |
Tolerance value corresponding to the selected convergence criteria.
Definition at line 383 of file BundleSettings.h.
Referenced by convergenceCriteriaThreshold(), init(), operator=(), and setConvergenceCriteria().
|
private |
Indicates the coordinate type used for control points in the bundle adjustment.
Definition at line 408 of file BundleSettings.h.
Referenced by controlPointCoordTypeBundle(), init(), operator=(), and setSolveOptions().
|
private |
Indicates the coordinate type for outputting control points in reports.
Definition at line 406 of file BundleSettings.h.
Referenced by controlPointCoordTypeReports(), init(), operator=(), and setSolveOptions().
|
private |
Indicates whether to create the inverse matrix file.
Definition at line 365 of file BundleSettings.h.
Referenced by createInverseMatrix(), init(), operator=(), and setCreateInverseMatrix().
|
private |
Indicates whether to perform error propagation.
Definition at line 364 of file BundleSettings.h.
Referenced by createInverseMatrix(), errorPropagation(), init(), operator=(), and setSolveOptions().
|
private |
The global a priori sigma for latitude or X.
Definition at line 372 of file BundleSettings.h.
Referenced by globalPointCoord1AprioriSigma(), init(), operator=(), and setSolveOptions().
|
private |
The global a priori sigma for longitude or Y.
Definition at line 373 of file BundleSettings.h.
Referenced by globalPointCoord2AprioriSigma(), init(), operator=(), and setSolveOptions().
|
private |
The global a priori sigma for radius or Z.
Definition at line 374 of file BundleSettings.h.
Referenced by globalPointCoord3AprioriSigma(), init(), operator=(), and setSolveOptions().
|
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 397 of file BundleSettings.h.
Referenced by addMaximumLikelihoodEstimatorModel(), init(), maximumLikelihoodEstimatorModels(), operator=(), and save().
|
private |
Indicates whether to perform automatic outlier detection/rejection.
Definition at line 366 of file BundleSettings.h.
Referenced by init(), operator=(), outlierRejection(), and setOutlierRejection().
|
private |
The multiplier value for outlier rejection.
Defaults to 1, so no change if rejection = false.
Definition at line 368 of file BundleSettings.h.
Referenced by init(), operator=(), outlierRejectionMultiplier(), and setOutlierRejection().
|
private |
The prefix for all output files.
If the user does not want output files to be written to the current directory, the output directory path should be included in this prefix.
Definition at line 411 of file BundleSettings.h.
Referenced by init(), operator=(), outputFilePrefix(), and setOutputFilePrefix().
|
private |
Indicates whether to solve for observation mode.
Definition at line 361 of file BundleSettings.h.
Referenced by init(), operator=(), setSolveOptions(), and solveObservationMode().
|
private |
Indicates whether to solve for point radii.
Definition at line 362 of file BundleSettings.h.
Referenced by init(), operator=(), setSolveOptions(), and solveRadius().
|
private |
Indicates whether to solve for target body.
Definition at line 402 of file BundleSettings.h.
Referenced by init(), and operator=().
|
private |
Indicates whether to update cubes.
Definition at line 363 of file BundleSettings.h.
Referenced by init(), operator=(), setSolveOptions(), and updateCubeLabel().
|
private |
Indicates whether the network should be validated.
Definition at line 359 of file BundleSettings.h.
Referenced by init(), operator=(), setValidateNetwork(), and validateNetwork().