Isis 3.0
Home
Isis::BundleResults Class Reference

A container class for statistical results from a BundleAdjust solution. More...

#include <BundleResults.h>

Inherits QObject.

Public Member Functions

 BundleResults (QObject *parent=0)
 Constructs a BundleSettings object. More...
 
 BundleResults (Project *project, XmlStackedHandlerReader *xmlReader, QObject *parent=0)
 Construct this BundleSettings object from XML. More...
 
 BundleResults (const BundleResults &src)
 Copy constructor for BundleResults. More...
 
 ~BundleResults ()
 Destroys this BundleResults object. More...
 
BundleResultsoperator= (const BundleResults &src)
 Assignment operator for BundleResults. More...
 
void initialize ()
 Initializes the BundleResults to a default state where all numeric members are set to 0 or another default value, all QString members are set to empty, all QVectors and QLists are cleared, and all other members are set to NULL. More...
 
void resizeSigmaStatisticsVectors (int numberImages)
 Resizes all image sigma vectors. More...
 
void setRmsImageResidualLists (QList< Statistics > rmsImageLineResiduals, QList< Statistics > rmsImageSampleResiduals, QList< Statistics > rmsImageResiduals)
 Sets the root mean square image residual Statistics lists. More...
 
void setRmsImageResidualLists (QVector< Statistics > rmsImageLineResiduals, QVector< Statistics > rmsImageSampleResiduals, QVector< Statistics > rmsImageResiduals)
 
void setSigmaLatitudeRange (Distance minLatDist, Distance maxLatDist, QString minLatPointId, QString maxLatPointId)
 Sets the min and max sigma latitude distances and point ids. More...
 
void setSigmaLongitudeRange (Distance minLonDist, Distance maxLonDist, QString minLonPointId, QString maxLonPointId)
 Sets the min and max sigma longitude distances and point ids. More...
 
void setSigmaRadiusRange (Distance minRadDist, Distance maxRadDist, QString minRadPointId, QString maxRadPointId)
 Sets the min and max sigma radius distances and point ids. More...
 
void setRmsFromSigmaStatistics (double rmsFromSigmaLatStats, double rmsFromSigmaLonStats, double rmsFromSigmaRadStats)
 Sets the root mean square values of the adjusted latitiude sigmas, adjusted longitude sigmas, and adjusted radius sigmas. More...
 
void maximumLikelihoodSetUp (QList< QPair< MaximumLikelihoodWFunctions::Model, double > > modelsWithQuantiles)
 This method steps up the maximum likelihood estimation solution. More...
 
void printMaximumLikelihoodTierInformation ()
 Prints out information about which tier the solution is in and the status of the residuals. More...
 
void initializeResidualsProbabilityDistribution (unsigned int nodes=20)
 Initializes or resets the cumulative probability distribution of residuals used for reporting. More...
 
void initializeProbabilityDistribution (unsigned int nodes=20)
 Initializes or resets the cumulative probability distribution of |R^2 residuals|. More...
 
void addResidualsProbabilityDistributionObservation (double obsValue)
 Adds an observation to the cumulative probability distribution of residuals used for reporting. More...
 
void addProbabilityDistributionObservation (double obsValue)
 Adds an observation to the cumulative probability distribution of |R^2 residuals|. More...
 
void addProbabilityDistributionObservation (double obsValue, bool residuals)
 
void incrementMaximumLikelihoodModelIndex ()
 Increases the value that indicates which stage the maximum likelihood adjustment is currently on. More...
 
void incrementFixedPoints ()
 Increase the number of 'fixed' (ground) points. More...
 
int numberFixedPoints () const
 Returns the number of 'fixed' (ground) points. More...
 
void incrementHeldImages ()
 Increases the number of 'held' images. More...
 
int numberHeldImages () const
 Returns the number of 'held' images. More...
 
void incrementIgnoredPoints ()
 Increase the number of ignored points. More...
 
int numberIgnoredPoints () const
 Returns the number of ignored points. More...
 
void setRejectionLimit (double rejectionLimit)
 Sets the rejection limit. More...
 
void setRmsXYResiduals (double rx, double ry, double rxy)
 Sets the root mean square of the x and y residuals. More...
 
void setNumberRejectedObservations (int numberObservations)
 Sets the number of rejected observations. More...
 
void setNumberObservations (int numberObservations)
 Sets the number of observations. More...
 
void setNumberImageParameters (int numberParameters)
 Sets the number of image parameters. More...
 
void resetNumberConstrainedPointParameters ()
 Resets the number of contrained point parameters to 0. More...
 
void incrementNumberConstrainedPointParameters (int incrementAmount)
 Increase the number of contrained point parameters. More...
 
void resetNumberConstrainedImageParameters ()
 Resets the number of constrained image parameters to 0. More...
 
void incrementNumberConstrainedImageParameters (int incrementAmount)
 Increase the number of constrained image parameters. More...
 
void resetNumberConstrainedTargetParameters ()
 Resets the number of constrained target parameters to 0. More...
 
void incrementNumberConstrainedTargetParameters (int incrementAmount)
 Increases the number of constrained target parameters. More...
 
void setNumberUnknownParameters (int numberParameters)
 Sets the total number of parameters to solve for. More...
 
void computeDegreesOfFreedom ()
 Computes the degrees of freedom of the bundle adjustment and stores it internally. More...
 
void computeSigma0 (double dvtpv, BundleSettings::ConvergenceCriteria criteria)
 Computes the sigma0 and stores it internally. More...
 
void setDegreesOfFreedom (double degreesOfFreedom)
 Sets the degrees of freedom. More...
 
void setSigma0 (double sigma0)
 Sets the sigma0. More...
 
void setElapsedTime (double time)
 Sets the elapsed time for the bundle adjustment. More...
 
void setElapsedTimeErrorProp (double time)
 Sets the elapsed time for error propegation. More...
 
void setRadiansToMeters (double rtm)
 Sets the radians to meters conversion constant for the target body. More...
 
void setConverged (bool converged)
 Sets if the bundle adjustment converged. More...
 
void setBundleControlPoints (QVector< BundleControlPointQsp > controlPoints)
 Sets the bundle control point vector. More...
 
void setOutputControlNet (ControlNetQsp outNet)
 Sets the output ControlNet. More...
 
void setIterations (int iterations)
 Sets the number of iterations taken by the BundleAdjust. More...
 
void setObservations (BundleObservationVector observations)
 Sets the vector of BundleObservations. More...
 
QList< StatisticsrmsImageSampleResiduals () const
 Returns the list of RMS image sample residuals statistics. More...
 
QList< StatisticsrmsImageLineResiduals () const
 Returns the list of RMS image line residuals statistics. More...
 
QList< StatisticsrmsImageResiduals () const
 Returns the list of RMS image residuals statistics. More...
 
QVector< StatisticsrmsImageXSigmas () const
 Returns the list of RMS image x sigma statistics. More...
 
QVector< StatisticsrmsImageYSigmas () const
 Returns the list of RMS image y sigma statistics. More...
 
QVector< StatisticsrmsImageZSigmas () const
 Returns the list of RMS image z sigma statistics. More...
 
QVector< StatisticsrmsImageRASigmas () const
 Returns the list of RMS image right ascension sigma statistics. More...
 
QVector< StatisticsrmsImageDECSigmas () const
 Returns the list of RMS image declination sigma statistics. More...
 
QVector< StatisticsrmsImageTWISTSigmas () const
 Returns the list of RMS image twist sigma statistics. More...
 
Distance minSigmaLatitudeDistance () const
 Returns the minimum sigma latitude distance. More...
 
Distance maxSigmaLatitudeDistance () const
 Returns the maximum sigma latitude distance. More...
 
Distance minSigmaLongitudeDistance () const
 Returns the minimum sigma longitude distance. More...
 
Distance maxSigmaLongitudeDistance () const
 Returns the maximum sigma longitude distance. More...
 
Distance minSigmaRadiusDistance () const
 Returns the minimum sigma redius distance. More...
 
Distance maxSigmaRadiusDistance () const
 Returns the maximum sigma redius distance. More...
 
QString maxSigmaLatitudePointId () const
 Returns the maximum sigma latitude point id. More...
 
QString minSigmaLatitudePointId () const
 Returns the minimum sigma latitude point id. More...
 
QString minSigmaLongitudePointId () const
 Returns the minimum sigma longitude point id. More...
 
QString maxSigmaLongitudePointId () const
 Returns the maximum sigma longitude point id. More...
 
QString minSigmaRadiusPointId () const
 Returns the minimum sigma radius point id. More...
 
QString maxSigmaRadiusPointId () const
 Returns the maximum sigma radius point id. More...
 
double sigmaLatitudeStatisticsRms () const
 Returns the RMS of the adjusted latitude sigmas. More...
 
double sigmaLongitudeStatisticsRms () const
 Returns the RMS of the adjusted longitude sigmas. More...
 
double sigmaRadiusStatisticsRms () const
 Returns the RMS of the adjusted raidus sigmas. More...
 
double rmsRx () const
 Returns the RMS of the x residuals. More...
 
double rmsRy () const
 Returns the RMS of the y residuals. More...
 
double rmsRxy () const
 Returns the RMS of the x and y residuals. More...
 
double rejectionLimit () const
 Returns the rejection limit. More...
 
double radiansToMeters () const
 Returns the radians to meters conversion factor for the target body. More...
 
int numberRejectedObservations () const
 Returns the number of observation that were rejected. More...
 
int numberObservations () const
 Returns the number of observations. More...
 
int numberImageParameters () const
 Returns the total number of image parameters. More...
 
int numberConstrainedPointParameters () const
 Returns the number of constrained point parameters. More...
 
int numberConstrainedImageParameters () const
 Returns the number of constrained image parameters. More...
 
int numberConstrainedTargetParameters () const
 Return the number of constrained target parameters. More...
 
int numberUnknownParameters () const
 Returns the number of unknown parameters. More...
 
int degreesOfFreedom () const
 Returns the degrees of freedom. More...
 
double sigma0 () const
 Returns the Sigma0 of the bundle adjustment. More...
 
double elapsedTime () const
 Returns the elapsed time for the bundle adjustment. More...
 
double elapsedTimeErrorProp () const
 Returns the elapsed time for error propagation. More...
 
bool converged () const
 Returns whether or not the bundle adjustment converged. More...
 
QVector< BundleControlPointQsp > & bundleControlPoints ()
 Returns a reference to the BundleControlPoint vector. More...
 
ControlNetQsp outputControlNet () const
 Returns a shared pointer to the output control network. More...
 
int iterations () const
 Returns the number of iterations taken by the BundleAdjust. More...
 
const BundleObservationVectorobservations () const
 Returns a reference to the observations used by the BundleAdjust. More...
 
int numberMaximumLikelihoodModels () const
 Returns how many maximum likelihood models were used in the bundle adjustment. More...
 
int maximumLikelihoodModelIndex () const
 Returns which step the bundle adjustment is on. More...
 
StatCumProbDistDynCalc cumulativeProbabilityDistribution () const
 Returns the cumulative probability distribution of the |R^2 residuals|. More...
 
StatCumProbDistDynCalc residualsCumulativeProbabilityDistribution () const
 Returns the cumulative probability distribution of the residuals used for reporting. More...
 
double maximumLikelihoodMedianR2Residuals () const
 Returns the median of the |R^2 residuals|. More...
 
MaximumLikelihoodWFunctions maximumLikelihoodModelWFunc (int modelIndex) const
 Returns the maximum likelihood model at the given index. More...
 
double maximumLikelihoodModelQuantile (int modelIndex) const
 Returns the quantile of the maximum likelihood model at the given index. More...
 
QList< QPair
< MaximumLikelihoodWFunctions,
double > > 
maximumLikelihoodModels () const
 
bool setNumberHeldImages (SerialNumberList pHeldSnList, SerialNumberList *pSnList)
 
PvlObject pvlObject (QString name="BundleResults") const
 Saves the BundleResults object as a PvlObject. More...
 
CorrelationMatrix correlationMatrix () const
 Returns the Correlation Matrix. More...
 
void setCorrMatCovFileName (FileName name)
 Set the covariance file name for the matrix used to calculate the correlation matrix. More...
 
void setCorrMatImgsAndParams (QMap< QString, QStringList > imgsAndParams)
 Set the images and their associated parameters of the correlation matrix. More...
 
void save (QXmlStreamWriter &stream, const Project *project) const
 Saves the BundleResults object to an XML file. More...
 
QDataStream & write (QDataStream &stream) const
 Writes the BundleResults object to a QDataStream. More...
 
QDataStream & read (QDataStream &stream)
 Reads the data from a QDataStream into the BundleResults object. More...
 
void createH5Group (hid_t locationId, QString locationName) const
 
void parseH5Group (hid_t locationId, QString locationName)
 
void createH5Group (H5::CommonFG &locationObject, QString locationName) const
 Saves an hdf5 group. More...
 
void openH5Group (H5::CommonFG &locationObject, QString locationName)
 Reads from an hdf5 group. More...
 
 BundleResults (H5::CommonFG &locationObject, QString locationName)
 Constructs this BundleSettings object from Hdf5. More...
 

Detailed Description

A container class for statistical results from a BundleAdjust solution.

Author
2014-07-01 Jeannie Backer

Constructor & Destructor Documentation

Isis::BundleResults::BundleResults ( QObject parent = 0)

Constructs a BundleSettings object.

Parameters
parentThe Qt-relationship parent.

References initialize(), and initializeResidualsProbabilityDistribution().

Isis::BundleResults::BundleResults ( Project project,
XmlStackedHandlerReader xmlReader,
QObject parent = 0 
)

Construct this BundleSettings object from XML.

Parameters
bundleSettingsFolderWhere the settings XML for this bundle adjustment resides - /work/.../projectRoot/images/import1
xmlReaderAn XML reader that's up to a <bundleSettings> tag.
parentThe Qt-relationship parent.

References initialize(), and Isis::XmlStackedHandlerReader::pushContentHandler().

Isis::BundleResults::BundleResults ( const BundleResults src)

Copy constructor for BundleResults.

Creates this BundleSettings object as a copy of another BundleResults object.

Parameters
srcThe other BundleResults object to be copied.
Isis::BundleResults::~BundleResults ( )

Destroys this BundleResults object.

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

Constructs this BundleSettings object from Hdf5.

Parameters
locationObjectThe Hdf5 project file to be used.
locationNameThe name of the project file containing the BundleResults.
See Also
openH5Group

References openH5Group().

Member Function Documentation

void Isis::BundleResults::addProbabilityDistributionObservation ( double  observationValue)

Adds an observation to the cumulative probability distribution of |R^2 residuals|.

Parameters
observationValueThe value of the added observation.

References Isis::StatCumProbDistDynCalc::addObs().

void Isis::BundleResults::addProbabilityDistributionObservation ( double  obsValue,
bool  residuals 
)
void Isis::BundleResults::addResidualsProbabilityDistributionObservation ( double  observationValue)

Adds an observation to the cumulative probability distribution of residuals used for reporting.

Parameters
observationValueThe value of the added observation.

References Isis::StatCumProbDistDynCalc::addObs().

void Isis::BundleResults::computeDegreesOfFreedom ( )

Computes the degrees of freedom of the bundle adjustment and stores it internally.

Referenced by computeSigma0().

void Isis::BundleResults::computeSigma0 ( double  dvtpv,
BundleSettings::ConvergenceCriteria  criteria 
)

Computes the sigma0 and stores it internally.

Parameters
dvtpvThe weighted sum of the squares of the residuals. Computed by V transpose * P * V, where V is the vector of residuals and P is the weight matrix.
criteriaThe convergence criteria for the bundle adjustment.
Exceptions
IException::Io"Computed degrees of freedom is invalid."

References _FILEINFO_, computeDegreesOfFreedom(), Isis::IException::Io, Isis::BundleSettings::ParameterCorrections, and Isis::toString().

bool Isis::BundleResults::converged ( ) const

Returns whether or not the bundle adjustment converged.

Returns
bool If the bundle adjustment converged.

Referenced by Isis::JigsawDialog::bundleFinished(), createH5Group(), Isis::BundleSolutionInfo::outputImagesCSV(), Isis::BundleSolutionInfo::outputText(), pvlObject(), save(), and setConverged().

CorrelationMatrix Isis::BundleResults::correlationMatrix ( ) const

Returns the Correlation Matrix.

Returns
CorrelationMatrix The correlation matrix.
Exceptions
IException::Unknown"Correlation matrix for this bundle is NULL."

References _FILEINFO_, and Isis::IException::Unknown.

Referenced by createH5Group(), Isis::ProjectItem::ProjectItem(), pvlObject(), read(), save(), setCorrMatCovFileName(), and setCorrMatImgsAndParams().

void Isis::BundleResults::createH5Group ( hid_t  locationId,
QString  locationName 
) const
void Isis::BundleResults::createH5Group ( H5::CommonFG &  locationObject,
QString  locationName 
) const

Saves an hdf5 group.

Parameters
locationObjectThe hdf5 group.
localNameThe filename for the hdf5 group.
Exceptions
IException::Unknown"H5 ATTRIBUTE exception handler has detected an error when invoking the function"
IException::Unknown"Unable to save bundle results information to an HDF5 group."

References _FILEINFO_, Isis::Statistics::compoundH5DataType(), converged(), Isis::CorrelationMatrix::correlationFileName(), correlationMatrix(), Isis::CorrelationMatrix::covarianceFileName(), Isis::FileName::expanded(), and Isis::IException::Unknown.

StatCumProbDistDynCalc Isis::BundleResults::cumulativeProbabilityDistribution ( ) const

Returns the cumulative probability distribution of the |R^2 residuals|.

Returns
StatCumProbDistDynCalc The cumulative probability distribution of the |R^2 residuals|.

Referenced by save().

int Isis::BundleResults::degreesOfFreedom ( ) const

Returns the degrees of freedom.

Returns
int the degrees of freedom.

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

double Isis::BundleResults::elapsedTime ( ) const

Returns the elapsed time for the bundle adjustment.

Returns
double The elapsed time for the bundle adjustment.

Referenced by Isis::BundleSolutionInfo::outputHeader(), pvlObject(), and save().

double Isis::BundleResults::elapsedTimeErrorProp ( ) const

Returns the elapsed time for error propagation.

Returns
double The elapsed time for error propagation.

Referenced by Isis::BundleSolutionInfo::outputHeader(), pvlObject(), and save().

void Isis::BundleResults::incrementFixedPoints ( )

Increase the number of 'fixed' (ground) points.

void Isis::BundleResults::incrementHeldImages ( )

Increases the number of 'held' images.

void Isis::BundleResults::incrementIgnoredPoints ( )

Increase the number of ignored points.

void Isis::BundleResults::incrementMaximumLikelihoodModelIndex ( )

Increases the value that indicates which stage the maximum likelihood adjustment is currently on.

void Isis::BundleResults::incrementNumberConstrainedImageParameters ( int  incrementAmount)

Increase the number of constrained image parameters.

Parameters
incrementAmountThe amount to increase by.
void Isis::BundleResults::incrementNumberConstrainedPointParameters ( int  incrementAmount)

Increase the number of contrained point parameters.

Parameters
incrementAmountThe amount to increase by.
void Isis::BundleResults::incrementNumberConstrainedTargetParameters ( int  incrementAmount)

Increases the number of constrained target parameters.

Parameters
incrementAmountThe amount to increase by.
void Isis::BundleResults::initialize ( )

Initializes the BundleResults to a default state where all numeric members are set to 0 or another default value, all QString members are set to empty, all QVectors and QLists are cleared, and all other members are set to NULL.

References Isis::Distance::setMeters().

Referenced by BundleResults().

void Isis::BundleResults::initializeProbabilityDistribution ( unsigned int  nodes = 20)

Initializes or resets the cumulative probability distribution of |R^2 residuals|.

Parameters
nodesThe number of quantiles in the cumulative probability distribution.

References Isis::StatCumProbDistDynCalc::setQuantiles().

Referenced by maximumLikelihoodSetUp(), and printMaximumLikelihoodTierInformation().

void Isis::BundleResults::initializeResidualsProbabilityDistribution ( unsigned int  nodes = 20)

Initializes or resets the cumulative probability distribution of residuals used for reporting.

Parameters
nodesThe number of quantiles in the cumulative probability distribution.

References Isis::StatCumProbDistDynCalc::setQuantiles().

Referenced by BundleResults(), and maximumLikelihoodSetUp().

int Isis::BundleResults::iterations ( ) const

Returns the number of iterations taken by the BundleAdjust.

Returns
int The number of iterations.

Referenced by Isis::BundleSolutionInfo::outputHeader(), pvlObject(), and setIterations().

double Isis::BundleResults::maximumLikelihoodMedianR2Residuals ( ) const

Returns the median of the |R^2 residuals|.

Returns
double The median of the |R^2 residuals|.

Referenced by save().

int Isis::BundleResults::maximumLikelihoodModelIndex ( ) const

Returns which step the bundle adjustment is on.

Returns
int The maximum likelihood model that the bundle adjustment is currently using.

Referenced by save().

double Isis::BundleResults::maximumLikelihoodModelQuantile ( int  modelIndex) const

Returns the quantile of the maximum likelihood model at the given index.

Parameters
modelIndexThe index of the maximum likelihood model whose quantile will be returned.
Returns
double The quantile of the desired maximum likelihood model.

Referenced by Isis::BundleSolutionInfo::outputHeader().

QList< QPair< MaximumLikelihoodWFunctions, double > > Isis::BundleResults::maximumLikelihoodModels ( ) const
MaximumLikelihoodWFunctions Isis::BundleResults::maximumLikelihoodModelWFunc ( int  modelIndex) const

Returns the maximum likelihood model at the given index.

Parameters
modelIndexThe index of the maximum likelihood model to be returned.
Returns
MaximumLikelihoodWFunctions The maximum likelihood model at the input index.

Referenced by Isis::BundleSolutionInfo::outputHeader().

void Isis::BundleResults::maximumLikelihoodSetUp ( QList< QPair< MaximumLikelihoodWFunctions::Model, double > >  modelsWithQuantiles)

This method steps up the maximum likelihood estimation solution.

Up to three successive solutions models are available.

Parameters
modelsWithQuantilesThe maixmum likelihood models and their quantiles. If empty, then maximum likelihood estimation will not be used.

References initializeProbabilityDistribution(), and initializeResidualsProbabilityDistribution().

Distance Isis::BundleResults::maxSigmaLatitudeDistance ( ) const

Returns the maximum sigma latitude distance.

Returns
Distance The maximum sigma latitude.

Referenced by Isis::BundleSolutionInfo::outputText(), pvlObject(), read(), and save().

QString Isis::BundleResults::maxSigmaLatitudePointId ( ) const

Returns the maximum sigma latitude point id.

Returns
The maximum sigma latitude point id.

Referenced by Isis::BundleSolutionInfo::outputText(), pvlObject(), and save().

Distance Isis::BundleResults::maxSigmaLongitudeDistance ( ) const

Returns the maximum sigma longitude distance.

Returns
Distance The maximum sigma longitude.

Referenced by Isis::BundleSolutionInfo::outputText(), pvlObject(), read(), and save().

QString Isis::BundleResults::maxSigmaLongitudePointId ( ) const

Returns the maximum sigma longitude point id.

Returns
The maximum sigma longitude point id.

Referenced by Isis::BundleSolutionInfo::outputText(), pvlObject(), and save().

Distance Isis::BundleResults::maxSigmaRadiusDistance ( ) const

Returns the maximum sigma redius distance.

Returns
Distance The maximum sigma radius.

Referenced by Isis::BundleSolutionInfo::outputText(), pvlObject(), read(), and save().

QString Isis::BundleResults::maxSigmaRadiusPointId ( ) const

Returns the maximum sigma radius point id.

Returns
The maximum sigma radius point id.

Referenced by Isis::BundleSolutionInfo::outputText(), pvlObject(), and save().

Distance Isis::BundleResults::minSigmaLatitudeDistance ( ) const

Returns the minimum sigma latitude distance.

Returns
Distance The minimum sigma latitude.

Referenced by Isis::BundleSolutionInfo::outputText(), pvlObject(), read(), and save().

QString Isis::BundleResults::minSigmaLatitudePointId ( ) const

Returns the minimum sigma latitude point id.

Returns
The minimum sigma latitude point id.

Referenced by Isis::BundleSolutionInfo::outputText(), pvlObject(), and save().

Distance Isis::BundleResults::minSigmaLongitudeDistance ( ) const

Returns the minimum sigma longitude distance.

Returns
Distance The minimum sigma longitude.

Referenced by Isis::BundleSolutionInfo::outputText(), pvlObject(), read(), and save().

QString Isis::BundleResults::minSigmaLongitudePointId ( ) const

Returns the minimum sigma longitude point id.

Returns
The minimum sigma longitude point id.

Referenced by Isis::BundleSolutionInfo::outputText(), pvlObject(), and save().

Distance Isis::BundleResults::minSigmaRadiusDistance ( ) const

Returns the minimum sigma redius distance.

Returns
Distance The minimum sigma redius.

Referenced by Isis::BundleSolutionInfo::outputText(), pvlObject(), read(), and save().

QString Isis::BundleResults::minSigmaRadiusPointId ( ) const

Returns the minimum sigma radius point id.

Returns
The minimum sigma radius point id.

Referenced by Isis::BundleSolutionInfo::outputText(), pvlObject(), and save().

int Isis::BundleResults::numberConstrainedImageParameters ( ) const

Returns the number of constrained image parameters.

Returns
int The number of constrained image parameters.

Referenced by Isis::BundleSolutionInfo::outputHeader(), pvlObject(), read(), and save().

int Isis::BundleResults::numberConstrainedPointParameters ( ) const

Returns the number of constrained point parameters.

Returns
int The number of constrained point parameters.

Referenced by Isis::BundleSolutionInfo::outputHeader(), pvlObject(), read(), and save().

int Isis::BundleResults::numberConstrainedTargetParameters ( ) const

Return the number of constrained target parameters.

Returns
int The number of constrained target parameters.

Referenced by Isis::BundleSolutionInfo::outputHeader(), pvlObject(), read(), and save().

int Isis::BundleResults::numberFixedPoints ( ) const

Returns the number of 'fixed' (ground) points.

Returns
int The number of fixed points.

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

int Isis::BundleResults::numberHeldImages ( ) const

Returns the number of 'held' images.

Returns
int The number of held images.

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

int Isis::BundleResults::numberIgnoredPoints ( ) const

Returns the number of ignored points.

Returns
int The number of ignored points.

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

int Isis::BundleResults::numberImageParameters ( ) const

Returns the total number of image parameters.

Returns
int The total number of image parameters.

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

int Isis::BundleResults::numberMaximumLikelihoodModels ( ) const

Returns how many maximum likelihood models were used in the bundle adjustment.

Returns
int The number fo maximum likelihood models.

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

int Isis::BundleResults::numberObservations ( ) const

Returns the number of observations.

Returns
int The number of observations.

Referenced by Isis::BundleSolutionInfo::outputHeader(), pvlObject(), read(), save(), and setNumberObservations().

int Isis::BundleResults::numberRejectedObservations ( ) const

Returns the number of observation that were rejected.

Returns
int The number of rejected observations.

Referenced by Isis::BundleSolutionInfo::outputHeader(), pvlObject(), read(), save(), and setNumberRejectedObservations().

int Isis::BundleResults::numberUnknownParameters ( ) const

Returns the number of unknown parameters.

Returns
int The number of unknown parameters.

Referenced by Isis::BundleSolutionInfo::outputHeader(), pvlObject(), read(), and save().

const BundleObservationVector & Isis::BundleResults::observations ( ) const

Returns a reference to the observations used by the BundleAdjust.

Returns
BundleObservationVector& A reference to the observation vector.

Referenced by Isis::BundleSolutionInfo::outputHeader(), Isis::BundleSolutionInfo::outputImagesCSV(), Isis::BundleSolutionInfo::outputText(), and setObservations().

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

Reads from an hdf5 group.

Parameters
locationObjectThe hdf5 group.
locationNameThe filename of the hdf5 group.
Exceptions
IException::Unknown"H5 GENERAL exception handler has detected an error when invoking the function"
IException::Unknown"Unable to read bundle results information to an HDF5 group."

References _FILEINFO_, Isis::Statistics::compoundH5DataType(), Isis::CorrelationMatrix::setCorrelationFileName(), Isis::CorrelationMatrix::setCovarianceFileName(), and Isis::IException::Unknown.

Referenced by BundleResults(), and Isis::BundleSolutionInfo::openH5File().

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

Assignment operator for BundleResults.

Overwrites this BundleResults object with another BundleResults object.

Parameters
srcThe other BundleResults object to be copied from.
ControlNetQsp Isis::BundleResults::outputControlNet ( ) const

Returns a shared pointer to the output control network.

Returns
ControlNetQsp A shared pointer to the output control network.
Exceptions
IException::Programmer"Output Control Network has not been set."

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

Referenced by Isis::BundleSolutionInfo::outputHeader().

void Isis::BundleResults::parseH5Group ( hid_t  locationId,
QString  locationName 
)
void Isis::BundleResults::printMaximumLikelihoodTierInformation ( )

Prints out information about which tier the solution is in and the status of the residuals.

References initializeProbabilityDistribution(), numberMaximumLikelihoodModels(), and Isis::StatCumProbDistDynCalc::value().

double Isis::BundleResults::radiansToMeters ( ) const

Returns the radians to meters conversion factor for the target body.

Returns
double The conversion factor.

Referenced by Isis::BundleSolutionInfo::outputPointsCSV(), Isis::BundleSolutionInfo::outputText(), and pvlObject().

double Isis::BundleResults::rejectionLimit ( ) const

Returns the rejection limit.

Returns
double The rejection limit.

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

void Isis::BundleResults::resetNumberConstrainedImageParameters ( )

Resets the number of constrained image parameters to 0.

void Isis::BundleResults::resetNumberConstrainedPointParameters ( )

Resets the number of contrained point parameters to 0.

void Isis::BundleResults::resetNumberConstrainedTargetParameters ( )

Resets the number of constrained target parameters to 0.

StatCumProbDistDynCalc Isis::BundleResults::residualsCumulativeProbabilityDistribution ( ) const

Returns the cumulative probability distribution of the residuals used for reporting.

Returns
StatCumProbDistDynCalc the cumulative probability distribution of the residuals.

Referenced by Isis::BundleSolutionInfo::outputHeader(), and save().

void Isis::BundleResults::resizeSigmaStatisticsVectors ( int  numberImages)

Resizes all image sigma vectors.

Parameters
numberImagesThe new size for the image sigma vectors.
QVector< Statistics > Isis::BundleResults::rmsImageDECSigmas ( ) const

Returns the list of RMS image declination sigma statistics.

Returns
QList<Statistics> The RMS image declination sigma statistics.

Referenced by save().

QList< Statistics > Isis::BundleResults::rmsImageLineResiduals ( ) const

Returns the list of RMS image line residuals statistics.

Returns
QList<Statistics> The RMS image line residual statistics.

Referenced by Isis::BundleSolutionInfo::outputImagesCSV(), save(), and setRmsImageResidualLists().

QVector< Statistics > Isis::BundleResults::rmsImageRASigmas ( ) const

Returns the list of RMS image right ascension sigma statistics.

Returns
QList<Statistics> The RMS image right ascension sigma statistics.

Referenced by save().

QList< Statistics > Isis::BundleResults::rmsImageResiduals ( ) const

Returns the list of RMS image residuals statistics.

Returns
QList<Statistics> The RMS image residual statistics.

Referenced by Isis::BundleSolutionInfo::outputImagesCSV(), save(), and setRmsImageResidualLists().

QList< Statistics > Isis::BundleResults::rmsImageSampleResiduals ( ) const

Returns the list of RMS image sample residuals statistics.

Returns
QList<Statistics> The RMS image sample residual statistics.

Referenced by Isis::BundleSolutionInfo::outputImagesCSV(), save(), and setRmsImageResidualLists().

QVector< Statistics > Isis::BundleResults::rmsImageTWISTSigmas ( ) const

Returns the list of RMS image twist sigma statistics.

Returns
QList<Statistics> The RMS image twist sigma statistics.

Referenced by save().

QVector< Statistics > Isis::BundleResults::rmsImageXSigmas ( ) const

Returns the list of RMS image x sigma statistics.

Returns
QList<Statistics> The RMS image x sigma statistics.

Referenced by save().

QVector< Statistics > Isis::BundleResults::rmsImageYSigmas ( ) const

Returns the list of RMS image y sigma statistics.

Returns
QList<Statistics> The RMS image y sigma statistics.

Referenced by save().

QVector< Statistics > Isis::BundleResults::rmsImageZSigmas ( ) const

Returns the list of RMS image z sigma statistics.

Returns
QList<Statistics> The RMS image z sigma statistics.

Referenced by save().

double Isis::BundleResults::rmsRx ( ) const

Returns the RMS of the x residuals.

Returns
double The RMS of the x residuals.

Referenced by pvlObject(), and save().

double Isis::BundleResults::rmsRxy ( ) const

Returns the RMS of the x and y residuals.

Returns
double The RMS of the x and y residuals.

Referenced by pvlObject(), and save().

double Isis::BundleResults::rmsRy ( ) const

Returns the RMS of the y residuals.

Returns
double The RMS of the y residuals.

Referenced by pvlObject(), and save().

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

Saves the BundleResults object to an XML file.

Parameters
streamThe QXMLStreamWriter that will be used to write out the XML file.
projectThe project that the BundleResults object belongs to.

References converged(), correlationMatrix(), cumulativeProbabilityDistribution(), degreesOfFreedom(), elapsedTime(), elapsedTimeErrorProp(), maximumLikelihoodMedianR2Residuals(), maximumLikelihoodModelIndex(), maxSigmaLatitudeDistance(), maxSigmaLatitudePointId(), maxSigmaLongitudeDistance(), maxSigmaLongitudePointId(), maxSigmaRadiusDistance(), maxSigmaRadiusPointId(), minSigmaLatitudeDistance(), minSigmaLatitudePointId(), minSigmaLongitudeDistance(), minSigmaLongitudePointId(), minSigmaRadiusDistance(), minSigmaRadiusPointId(), Isis::MaximumLikelihoodWFunctions::modelToString(), numberConstrainedImageParameters(), numberConstrainedPointParameters(), numberConstrainedTargetParameters(), numberFixedPoints(), numberHeldImages(), numberIgnoredPoints(), numberImageParameters(), numberMaximumLikelihoodModels(), numberObservations(), numberRejectedObservations(), numberUnknownParameters(), rejectionLimit(), residualsCumulativeProbabilityDistribution(), rmsImageDECSigmas(), rmsImageLineResiduals(), rmsImageRASigmas(), rmsImageResiduals(), rmsImageSampleResiduals(), rmsImageTWISTSigmas(), rmsImageXSigmas(), rmsImageYSigmas(), rmsImageZSigmas(), rmsRx(), rmsRxy(), rmsRy(), Isis::StatCumProbDistDynCalc::save(), sigma0(), sigmaLatitudeStatisticsRms(), sigmaLongitudeStatisticsRms(), sigmaRadiusStatisticsRms(), and Isis::toString().

Referenced by Isis::BundleSolutionInfo::save().

void Isis::BundleResults::setBundleControlPoints ( QVector< BundleControlPointQsp controlPoints)

Sets the bundle control point vector.

Parameters
controlPointsThe vector of BundleControlPointQsps.
void Isis::BundleResults::setConverged ( bool  converged)

Sets if the bundle adjustment converged.

Parameters
convergedIf the bundle adjustment converged.

References converged().

void Isis::BundleResults::setCorrMatCovFileName ( FileName  name)

Set the covariance file name for the matrix used to calculate the correlation matrix.

Parameters
nameThe name of the file used to store the covariance matrix.

References correlationMatrix(), and Isis::CorrelationMatrix::setCovarianceFileName().

void Isis::BundleResults::setCorrMatImgsAndParams ( QMap< QString, QStringList imgsAndParams)

Set the images and their associated parameters of the correlation matrix.

Parameters
imgsAndParamsThe QMap with all the images and parameters used for this bundle.

References correlationMatrix(), and Isis::CorrelationMatrix::setImagesAndParameters().

Referenced by Isis::BundleSolutionInfo::outputText().

void Isis::BundleResults::setDegreesOfFreedom ( double  degreesOfFreedom)

Sets the degrees of freedom.

Parameters
degreesOfFreedomThe degrees of freedom.

References degreesOfFreedom().

void Isis::BundleResults::setElapsedTime ( double  time)

Sets the elapsed time for the bundle adjustment.

Parameters
timeThe elapsed time.
void Isis::BundleResults::setElapsedTimeErrorProp ( double  time)

Sets the elapsed time for error propegation.

Parameters
timeThe elapsed time.
void Isis::BundleResults::setIterations ( int  iterations)

Sets the number of iterations taken by the BundleAdjust.

Parameters
iterationsThe number of iterations.

References iterations().

bool Isis::BundleResults::setNumberHeldImages ( SerialNumberList  pHeldSnList,
SerialNumberList pSnList 
)
void Isis::BundleResults::setNumberImageParameters ( int  numberParameters)

Sets the number of image parameters.

Parameters
numberParametersThe number of image parameters.
void Isis::BundleResults::setNumberObservations ( int  numberObservations)

Sets the number of observations.

Parameters
numberObservationsThe number of observations.

References numberObservations().

void Isis::BundleResults::setNumberRejectedObservations ( int  numberRejectedObservations)

Sets the number of rejected observations.

Parameters
numberRejectedObservationsThe number of rejected observations.

References numberRejectedObservations().

void Isis::BundleResults::setNumberUnknownParameters ( int  numberParameters)

Sets the total number of parameters to solve for.

Parameters
numberParametersThe number of parameters to solve for.
void Isis::BundleResults::setObservations ( BundleObservationVector  observations)

Sets the vector of BundleObservations.

Parameters
observationsThe vector of BundleObservations.

References observations().

void Isis::BundleResults::setOutputControlNet ( ControlNetQsp  outNet)

Sets the output ControlNet.

Parameters
outNetA QSharedPointer to the output ControlNet.
void Isis::BundleResults::setRadiansToMeters ( double  rtm)

Sets the radians to meters conversion constant for the target body.

Parameters
rtmThe (double) conversion factor.
void Isis::BundleResults::setRejectionLimit ( double  rejectionLimit)

Sets the rejection limit.

Parameters
rejectionLimitThe rejection limit.

References rejectionLimit().

void Isis::BundleResults::setRmsFromSigmaStatistics ( double  rmsFromSigmaLatStats,
double  rmsFromSigmaLonStats,
double  rmsFromSigmaRadStats 
)

Sets the root mean square values of the adjusted latitiude sigmas, adjusted longitude sigmas, and adjusted radius sigmas.

Parameters
rmsFromSigmaLatStatsThe new RMS value of the adjusted latitude sigmas.
rmsFromSigmaLonStatsThe new RMS value of the adjusted longitude sigmas.
rmsFromSigmaRadStatsThe new RMS value of the adjusted radius sigmas.
void Isis::BundleResults::setRmsImageResidualLists ( QList< Statistics rmsImageLineResiduals,
QList< Statistics rmsImageSampleResiduals,
QList< Statistics rmsImageResiduals 
)

Sets the root mean square image residual Statistics lists.

Parameters
rmsImageLineResidualsThe new image line residuals list.
rmsImageSampleResidualsThe new image sample residuals list.
rmsImageResidualsThe new image residuals list.

References rmsImageLineResiduals(), rmsImageResiduals(), and rmsImageSampleResiduals().

void Isis::BundleResults::setRmsImageResidualLists ( QVector< Statistics rmsImageLineResiduals,
QVector< Statistics rmsImageSampleResiduals,
QVector< Statistics rmsImageResiduals 
)
void Isis::BundleResults::setRmsXYResiduals ( double  rx,
double  ry,
double  rxy 
)

Sets the root mean square of the x and y residuals.

Parameters
rxThe RMS value of the x residuals.
ryThe RMS value of the y residuals.
rxyThe RMS value of both the x and y residuals.
void Isis::BundleResults::setSigma0 ( double  sigma0)

Sets the sigma0.

Parameters
sigma0The sigma0.

References sigma0().

void Isis::BundleResults::setSigmaLatitudeRange ( Distance  minLatDist,
Distance  maxLatDist,
QString  minLatPointId,
QString  maxLatPointId 
)

Sets the min and max sigma latitude distances and point ids.

Parameters
minLatDistThe new minimum sigma latitude distance.
maxLatDistThe new maximum sigma latitude distance.
minLatPointIdThe new minimum sigma latitude point id.
maxLatPointIdThe new maximum sigma latitude point id.
void Isis::BundleResults::setSigmaLongitudeRange ( Distance  minLonDist,
Distance  maxLonDist,
QString  minLonPointId,
QString  maxLonPointId 
)

Sets the min and max sigma longitude distances and point ids.

Parameters
minLonDistThe new minimum sigma longitude distance.
maxLonDistThe new maximum sigma longitude distance.
minLonPointIdThe new minimum sigma longitude point id.
maxLonPointIdThe new maximum sigma longitude point id.
void Isis::BundleResults::setSigmaRadiusRange ( Distance  minRadDist,
Distance  maxRadDist,
QString  minRadPointId,
QString  maxRadPointId 
)

Sets the min and max sigma radius distances and point ids.

Parameters
minRadDistThe new minimum sigma radius distance.
maxRadDistThe new maximum sigma radius distance.
minRadPointIdThe new minimum sigma radius point id.
maxRadPointIdThe new maximum sigma radius point id.
double Isis::BundleResults::sigma0 ( ) const

Returns the Sigma0 of the bundle adjustment.

Returns
double The Sigma0.

Referenced by Isis::BundleSolutionInfo::outputHeader(), pvlObject(), save(), and setSigma0().

double Isis::BundleResults::sigmaLatitudeStatisticsRms ( ) const

Returns the RMS of the adjusted latitude sigmas.

Returns
double The RMS of the adjusted latitude sigmas.

Referenced by Isis::BundleSolutionInfo::outputText(), pvlObject(), and save().

double Isis::BundleResults::sigmaLongitudeStatisticsRms ( ) const

Returns the RMS of the adjusted longitude sigmas.

Returns
double The RMS of the adjusted longitude sigmas.

Referenced by Isis::BundleSolutionInfo::outputText(), pvlObject(), and save().

double Isis::BundleResults::sigmaRadiusStatisticsRms ( ) const

Returns the RMS of the adjusted raidus sigmas.

Returns
double The RMS of the adjusted radius sigmas.

Referenced by Isis::BundleSolutionInfo::outputText(), pvlObject(), and save().

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

Writes the BundleResults object to a QDataStream.

Parameters
streamThe QDataStream that the BundleResults will be written to.
Returns
QDataStream& A reference to the QDataStream that the BundleResults where written to.

References Isis::Distance::meters().

Referenced by Isis::operator<<().


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