This is a container for the correlation matrix that comes from a bundle adjust. More...

#include <CorrelationMatrix.h>

Collaboration diagram for Isis::CorrelationMatrix:

Public Member Functions
	CorrelationMatrix ()
	Default Constructor.

	CorrelationMatrix (PvlObject storedMatrixData)
	This constructor will create a CorrelationMatrix object given a pvl.

	CorrelationMatrix (const CorrelationMatrix &other)
	Copy Constructor.

	~CorrelationMatrix ()
	Destructor.

CorrelationMatrix &	operator= (const CorrelationMatrix &other)
	Equal Operator.

void	computeCorrelationMatrix ()
	Read covariance matrix and compute correlation values This method reads the covariance matrix in from a file, one SparseBlockColumnMatrix at a time.

void	retrieveVisibleElements (int x, int y)
	Extract requested area from correlation matrix This method will open the correlation matrix file and read in the blocks that apply to the requested area.

bool	isValid ()
	This is the public accessor for the list of elements that should be displayed in the current view.

bool	hasCovMat ()
	Check if the correlation matrix has a covariance matrix This is used to make sure the covariance matrix exists.

void	setCorrelationFileName (FileName correlationFileName)
	Set the qmap of images and parameters.

void	setCovarianceFileName (FileName covarianceFileName)
	Set the qmap of images and parameters.

void	setImagesAndParameters (QMap< QString, QStringList > imagesAndParameters)
	Set the qmap of images and parameters.

SparseBlockColumnMatrix	correlationMatrixFromFile (QDataStream inStream)

FileName	correlationFileName ()
	Public access for the correlation matrix file name.

FileName	covarianceFileName ()
	Public access for the covariance matrix file name.

QMap< QString, QStringList > *	imagesAndParameters ()
	Public access for the qmap of images and parameters.

void	retrieveWholeMatrix ()
	This method will read the matrix in from the file and hold on to the whole thing.

void	retrieveThreeVisibleBlocks ()
	Display only part of a matrix This method will be used when the matrix is too big to display the whole thing.

QList< SparseBlockColumnMatrix > *	visibleBlocks ()
	Get the visible part of the matrix.

PvlObject	pvlObject ()
	This method creates a Pvl group with the information necessary to recreate this correlation matrix.

Private Attributes
QMap< QString, QStringList > *	m_imagesAndParameters
	This map holds the images used to create this matrix and their associated parameters.

FileName *	m_covarianceFileName
	FileName of the covariance matrix calculated when the bundle was run.

FileName *	m_correlationFileName
	FileName of the correlation matrix.

QList< double > *	m_diagonals
	List of the parameter values.

QList< SparseBlockColumnMatrix > *	m_visibleBlocks
	This will be the three blocks (or whole matrix depending on size) that apply to the given area.

Detailed Description

This is a container for the correlation matrix that comes from a bundle adjust.

The bundle adjust will output the covariance matrix to a file. This class will read that file in and compute the correlation matrix. The entire correlation matrix will be written to a file and values will be read/displayed on an as-needed basis.

Author: 2014-05-02 Kimberly Oyama

History

2014-05-02 Kimberly Oyama - Original version.

2014-07-23 Jeannie Backer - Added QDataStream >> and << operators and read/write methods. Created unitTest. Added new operators to assignments in copy constructor and operator= methods.

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

2016-06-06 Tyler Wilson - Fixed a problem with a PvlKeywordIterator not being incremented in the constructor which accepts a PvlObject. There was also an issue with a QMap data structure not being initialized, resulting in a segmentation fault. Also added testing for exceptions being thrown in this constructor, as well as the function computeCorrelationMatrix. Fixes #3997,3999.

2016-07-11 Jesse Mapel - Updated method names to meet coding standards. Fixes #4112.

2016-08-10 Jeannie Backer - Replaced boost matrix with Isis::LinearAlgebra::Matrix. References #4163.

Definition at line 61 of file CorrelationMatrix.h.

Constructor & Destructor Documentation

◆ CorrelationMatrix() [1/3]

Isis::CorrelationMatrix::CorrelationMatrix ( )

Default Constructor.

Definition at line 29 of file CorrelationMatrix.cpp.

References m_correlationFileName, m_covarianceFileName, m_diagonals, m_imagesAndParameters, and m_visibleBlocks.

◆ CorrelationMatrix() [2/3]

Isis::CorrelationMatrix::CorrelationMatrix ( PvlObject storedMatrixData )

This constructor will create a CorrelationMatrix object given a pvl.

Object = CorrelationMatrix

CovarianceFileName = fileName.dat CorrelationFileName = fileName.dat

Group = ImagesAndParameters Image1 = "Parameter1", "Parameter2", "..." Image2 = "Parameter1", "Parameter2", "..." Image3 = "Parameter1", "Parameter2", "..." End_Group

End_Object

Parameters

storedMatrixData A PvlObject containing data about the covariance/correlation matrix.

Exceptions

IException::User	"This Pvl Object does not have the correct correlation information. The Object you are looking for is called CorrelationMatrixData"
IException::User	"Could not find the Covariance Matrix .dat file name."
IException::User	"Could not find the Correlation Matrix .dat file name."
IException::User	"Could not get Images and Parameters from ImagesAndParameters group."

Definition at line 67 of file CorrelationMatrix.cpp.

References m_correlationFileName, m_covarianceFileName, m_diagonals, m_imagesAndParameters, m_visibleBlocks, and Isis::IException::User.

◆ CorrelationMatrix() [3/3]

Isis::CorrelationMatrix::CorrelationMatrix ( const CorrelationMatrix & other )

Copy Constructor.

Parameters

other The CorrelationMatrix to copy.

Definition at line 125 of file CorrelationMatrix.cpp.

References m_correlationFileName, m_covarianceFileName, m_diagonals, m_imagesAndParameters, and m_visibleBlocks.

◆ ~CorrelationMatrix()

Isis::CorrelationMatrix::~CorrelationMatrix ( )

Destructor.

Definition at line 137 of file CorrelationMatrix.cpp.

References m_correlationFileName, m_covarianceFileName, m_diagonals, m_imagesAndParameters, and m_visibleBlocks.

Member Function Documentation

◆ computeCorrelationMatrix()

void Isis::CorrelationMatrix::computeCorrelationMatrix ( )

Read covariance matrix and compute correlation values This method reads the covariance matrix in from a file, one SparseBlockColumnMatrix at a time.

It then stores the diagonal values from that column and computes the correlation values. The resulting SparseBlockMatrix is written to a new file, one SparseBlockColumnMatrix at a time.

Exceptions

IException::Progammer "Cannot compute correlation matrix without a specified file name. Use setCorrelationFileName(FileName) before calling computeCorrelationMatrix()."

Definition at line 203 of file CorrelationMatrix.cpp.

References Isis::FileName::expanded(), isValid(), m_correlationFileName, m_covarianceFileName, m_diagonals, m_visibleBlocks, and Isis::IException::Programmer.

◆ correlationFileName()

FileName Isis::CorrelationMatrix::correlationFileName ( )

Public access for the correlation matrix file name.

Returns: FileName The FileName of the correlation matrix data file.

Definition at line 396 of file CorrelationMatrix.cpp.

References m_correlationFileName.

Referenced by setCorrelationFileName().

◆ covarianceFileName()

FileName Isis::CorrelationMatrix::covarianceFileName ( )

Public access for the covariance matrix file name.

Returns: FileName The FileName of the covariance data file.

Definition at line 406 of file CorrelationMatrix.cpp.

References m_covarianceFileName.

Referenced by setCovarianceFileName().

◆ hasCovMat()

bool Isis::CorrelationMatrix::hasCovMat ( )

Check if the correlation matrix has a covariance matrix This is used to make sure the covariance matrix exists.

If it doesn't this class is not valid. If this file exists, we can compute the correlation matrix.

Returns: bool Returns True if the covariance matrix exists, and False if it does not.

Definition at line 335 of file CorrelationMatrix.cpp.

References m_covarianceFileName, and Isis::FileName::name().

◆ imagesAndParameters()

QMap< QString, QStringList > * Isis::CorrelationMatrix::imagesAndParameters ( )

Public access for the qmap of images and parameters.

Returns: *QMap<QString,QStringList> A pointer to the QMap structure containing a list of images (the keys) and their associated parameter values.

Definition at line 417 of file CorrelationMatrix.cpp.

References m_imagesAndParameters.

Referenced by Isis::MatrixOptions::matrixImgsAndParams(), and setImagesAndParameters().

◆ isValid()

bool Isis::CorrelationMatrix::isValid ( )

This is the public accessor for the list of elements that should be displayed in the current view.

Returns: QList<MatrixElement*> The list of currently visible elements.

See if the correlation matrix has already been calculated by checking to see if the correlation matrix file has been created.

Returns: bool Returns True if the correlation matrix has already been set.

Definition at line 321 of file CorrelationMatrix.cpp.

References m_correlationFileName, m_covarianceFileName, and Isis::FileName::name().

Referenced by computeCorrelationMatrix(), Isis::MatrixViewWorkOrder::isExecutable(), and setCovarianceFileName().

◆ operator=()

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

Equal Operator.

Should this call the copy constructor???

Parameters

other The matrix to assign to this matrix.

Returns: CorrelationMatrix Returns the new matrix.

Definition at line 163 of file CorrelationMatrix.cpp.

References m_correlationFileName, m_covarianceFileName, m_diagonals, m_imagesAndParameters, and m_visibleBlocks.

◆ pvlObject()

PvlObject Isis::CorrelationMatrix::pvlObject ( )

This method creates a Pvl group with the information necessary to recreate this correlation matrix.

Object = CorrelationMatrixData CovarianceMatrixFileName = /location/covarianceTmpFileName.dat CorrelationMatrixFileName = /location/correlationTmpFileName.dat

Group = ImagesAndParameters Image1Name = "Param1, Param2, ..., ParamN" ... ImageNName = "..." End_Group End_Object

Returns: PvlGroup Returns the information needed to recreate this correlation matrix.

Definition at line 476 of file CorrelationMatrix.cpp.

References Isis::FileName::expanded(), m_correlationFileName, m_covarianceFileName, and m_imagesAndParameters.

◆ retrieveThreeVisibleBlocks()

void Isis::CorrelationMatrix::retrieveThreeVisibleBlocks ( )

Display only part of a matrix This method will be used when the matrix is too big to display the whole thing.

It will read in the block we want to see and the two blocks for the diagonals that belong to the right images.

Definition at line 446 of file CorrelationMatrix.cpp.

◆ retrieveVisibleElements()

void Isis::CorrelationMatrix::retrieveVisibleElements	(	int	x,
		int	y )

Extract requested area from correlation matrix This method will open the correlation matrix file and read in the blocks that apply to the requested area.

It will populate m_visibleElements.

Parameters

x	first coordinate of the location in the matrix that the user wants to see.
y	second coordinate of the location in the matrix that the user wants to see.

Definition at line 289 of file CorrelationMatrix.cpp.

◆ retrieveWholeMatrix()

void Isis::CorrelationMatrix::retrieveWholeMatrix ( )

This method will read the matrix in from the file and hold on to the whole thing.

This will only be used when the matrix is small enough that this will be useful.

Definition at line 427 of file CorrelationMatrix.cpp.

◆ setCorrelationFileName()

void Isis::CorrelationMatrix::setCorrelationFileName ( FileName correlationFileName )

Set the qmap of images and parameters.

Parameters

correlationFileName The FileName of the stored correlation matrix data.

Definition at line 345 of file CorrelationMatrix.cpp.

References correlationFileName(), and m_correlationFileName.

Referenced by setCovarianceFileName().

◆ setCovarianceFileName()

void Isis::CorrelationMatrix::setCovarianceFileName ( FileName covarianceFileName )

Set the qmap of images and parameters.

Parameters

covarianceFileName The FileName of the stored covariance matrix data.

Definition at line 359 of file CorrelationMatrix.cpp.

References covarianceFileName(), Isis::FileName::expanded(), isValid(), m_covarianceFileName, and setCorrelationFileName().

Referenced by Isis::BundleResults::setCorrMatCovFileName().

◆ setImagesAndParameters()

void Isis::CorrelationMatrix::setImagesAndParameters ( QMap< QString, QStringList > imagesAndParameters )

Set the qmap of images and parameters.

Parameters

imagesAndParameters a QMap structure indexed by image keys, with an arbitrary set of parameters for each image.

Definition at line 381 of file CorrelationMatrix.cpp.

References imagesAndParameters(), and m_imagesAndParameters.

Referenced by Isis::BundleResults::setCorrMatImgsAndParams().

◆ visibleBlocks()

QList< SparseBlockColumnMatrix > * Isis::CorrelationMatrix::visibleBlocks ( )

Get the visible part of the matrix.

Returns: QList Returns a list of the non-empty diagonal blocks of the correlation matrix.

Definition at line 454 of file CorrelationMatrix.cpp.

References m_visibleBlocks.

Member Data Documentation

◆ m_correlationFileName

FileName* Isis::CorrelationMatrix::m_correlationFileName

private

FileName of the correlation matrix.

Definition at line 107 of file CorrelationMatrix.h.

Referenced by computeCorrelationMatrix(), correlationFileName(), CorrelationMatrix(), CorrelationMatrix(), CorrelationMatrix(), isValid(), operator=(), pvlObject(), setCorrelationFileName(), and ~CorrelationMatrix().

◆ m_covarianceFileName

FileName* Isis::CorrelationMatrix::m_covarianceFileName

private

FileName of the covariance matrix calculated when the bundle was run.

Definition at line 104 of file CorrelationMatrix.h.

Referenced by computeCorrelationMatrix(), CorrelationMatrix(), CorrelationMatrix(), CorrelationMatrix(), covarianceFileName(), hasCovMat(), isValid(), operator=(), pvlObject(), setCovarianceFileName(), and ~CorrelationMatrix().

◆ m_diagonals

QList<double>* Isis::CorrelationMatrix::m_diagonals

private

List of the parameter values.

Stored so we don't need to store all the SBCMs when calculating the correlation values.

Definition at line 113 of file CorrelationMatrix.h.

Referenced by computeCorrelationMatrix(), CorrelationMatrix(), CorrelationMatrix(), CorrelationMatrix(), operator=(), and ~CorrelationMatrix().

◆ m_imagesAndParameters

QMap<QString, QStringList>* Isis::CorrelationMatrix::m_imagesAndParameters

private

This map holds the images used to create this matrix and their associated parameters.

Definition at line 101 of file CorrelationMatrix.h.

Referenced by CorrelationMatrix(), CorrelationMatrix(), CorrelationMatrix(), imagesAndParameters(), operator=(), pvlObject(), setImagesAndParameters(), and ~CorrelationMatrix().

◆ m_visibleBlocks

QList<SparseBlockColumnMatrix>* Isis::CorrelationMatrix::m_visibleBlocks

private

This will be the three blocks (or whole matrix depending on size) that apply to the given area.

Definition at line 119 of file CorrelationMatrix.h.

Referenced by computeCorrelationMatrix(), CorrelationMatrix(), CorrelationMatrix(), CorrelationMatrix(), operator=(), visibleBlocks(), and ~CorrelationMatrix().

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

src/control/objs/CorrelationMatrix/CorrelationMatrix.h
src/control/objs/CorrelationMatrix/CorrelationMatrix.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CorrelationMatrix() [1/3]

◆ CorrelationMatrix() [2/3]

◆ CorrelationMatrix() [3/3]

◆ ~CorrelationMatrix()

Member Function Documentation

◆ computeCorrelationMatrix()

◆ correlationFileName()

◆ covarianceFileName()

◆ hasCovMat()

◆ imagesAndParameters()

◆ isValid()

◆ operator=()

◆ pvlObject()

◆ retrieveThreeVisibleBlocks()

◆ retrieveVisibleElements()

◆ retrieveWholeMatrix()

◆ setCorrelationFileName()

◆ setCovarianceFileName()

◆ setImagesAndParameters()

◆ visibleBlocks()

Member Data Documentation

◆ m_correlationFileName

◆ m_covarianceFileName

◆ m_diagonals

◆ m_imagesAndParameters

◆ m_visibleBlocks