A container class for a ControlMeasure. More...

#include <BundleMeasure.h>

Collaboration diagram for Isis::BundleMeasure:

Public Member Functions
	BundleMeasure (ControlMeasure controlMeasure, BundleControlPoint bundleControlPoint)
	Constructor. More...

	BundleMeasure (const BundleMeasure &src)
	Copy constructor. More...

	~BundleMeasure ()
	Destructor. More...

BundleMeasure &	operator= (const BundleMeasure &src)
	Assignment operator. More...

void	setParentObservation (QSharedPointer< BundleObservation > observation)
	Sets the parent bundle observation. More...

void	setParentImage (QSharedPointer< BundleImage > image)
	Sets the parent bundle image. More...

void	setRejected (bool reject)
	Sets the BundleMeasure's status to rejected or not rejected. More...

bool	isRejected () const
	Determines whether or not this BundleMeasure is rejected. More...

Camera *	camera () const
	Accesses the associated camera for this bundle measure. More...

BundleControlPoint *	parentControlPoint ()
	Accesses the parent BundleControlPoint for this bundle measure. More...

QSharedPointer< BundleImage >	parentBundleImage ()
	Access the parent BundleImage for this bundle measure. More...

QSharedPointer< BundleObservation >	parentBundleObservation ()
	Accesses the parent BundleObservation for this bundle measure. More...

const QSharedPointer< BundleObservationSolveSettings >	observationSolveSettings ()
	Accesses the parent observation's solve settings. More...

double	sample () const
	Accesses the current sample measurement for this control measure. More...

double	sampleResidual () const
	Accesses the sample residual for this control measure. More...

double	line () const
	Accesses the current line measurement for this control measure. More...

double	lineResidual () const
	Accesses the line residual for this control measure. More...

double	residualMagnitude () const
	Accesses the residual magnitude for this control measure. More...

QString	cubeSerialNumber () const
	Accesses the serial number of the cube containing this control measure. More...

double	focalPlaneComputedX () const
	Accesses the computed focal plane x value for this control measure. More...

double	focalPlaneComputedY () const
	Accesses the computed focal plane y value for this control measure. More...

double	focalPlaneMeasuredX () const
	Accesses the measured focal plane x value for this control measure //TODO verify? More...

double	focalPlaneMeasuredY () const
	Accesses the measured focal plane y value for this control measure //TODO verify? More...

int	observationIndex () const
	Accesses the observation index for the parent observation. More...

Private Attributes
ControlMeasure *	m_controlMeasure
	Contained control measure. More...

BundleControlPoint *	m_parentControlPoint
	Parent bundle control point that contains this bundle control measure. More...

QSharedPointer< BundleImage >	m_parentBundleImage
	Parent image of this bundle control measure. More...

QSharedPointer< BundleObservation >	m_parentObservation
	Parent bundle observation. More...

Detailed Description

A container class for a ControlMeasure.

This class is used as a wrapper around a ControlMeasure to provide the necessary information for BundleAdjust. This class can be used to get the parent bundle observation solve settings for observation mode adjustment.

Note that a BundleMeasure should be created from a non-ignored ControlMeasure.

Author: 2014-07-09 Ken Edmundson

History:: 2015-02-20 Jeannie Backer - Added assignment operator. Brought closer to Isis coding standards.

History:: 2016-07-14 Ian Humphrey - Updated documentation and coding standards in preparation to merge into trunk. Updated unit test for BundleMeasure. Fixes #4145, #4077.

History:: 2016-08-03 Jesse Mapel - Changed parent observation to a QSharedPointer. Added error throws to observationSolveSettings and observationIndex if calling when parent observation has not been set. Fixes #4150.

History:: 2016-08-15 Ian Humphrey - Added sampleResidual(), lineResidual(), residualMagnitude(), focalPlaneComputedX(), and focalPlaneComputedY(). Modified isRejected() and camera() accessors to be const. Updated unit test for these methods. References #4201.

History:: 2016-08-15 Jesse Mapel - Changed parent BundleImage to a QSharedPointer and added a mutator. Added wrapper methods for several ControlMeasure methods. Added typedef for BundleMeasureQsp. Fixes #4159.

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

History:: 2016-08-25 Adam Paquette - Updated documentation. Fixes #4299.

Definition at line 55 of file BundleMeasure.h.

Constructor & Destructor Documentation

◆ BundleMeasure() [1/2]

Isis::BundleMeasure::BundleMeasure	(	ControlMeasure *	controlMeasure,
		BundleControlPoint *	bundleControlPoint
	)

Constructor.

Constructs a BundleMeasure from a ControlMeasure with the passed BundleControlPoint as its parent control point

Parameters

controlMeasure	Pointer to the ControlMeasure to store
bundleControlPoint	Pointer to the BundleControlPoint that contains this BundleMeasure

Definition at line 28 of file BundleMeasure.cpp.

References m_controlMeasure, and m_parentControlPoint.

◆ BundleMeasure() [2/2]

Isis::BundleMeasure::BundleMeasure ( const BundleMeasure & src )

Copy constructor.

Constructs a BundleMeasure from another BundleMeasure

Parameters

src	The source BundleMeasure to copy

Definition at line 49 of file BundleMeasure.cpp.

References m_controlMeasure, m_parentBundleImage, m_parentControlPoint, and m_parentObservation.

◆ ~BundleMeasure()

Isis::BundleMeasure::~BundleMeasure ( )

Destructor.

Definition at line 38 of file BundleMeasure.cpp.

Member Function Documentation

◆ camera()

Camera * Isis::BundleMeasure::camera ( ) const

Accesses the associated camera for this bundle measure.

See also: ControlMeasure::camera()

Returns: Camera* Returns a pointer to the camera associated with this bundle measure

Definition at line 128 of file BundleMeasure.cpp.

References m_controlMeasure.

Referenced by Isis::IsisBundleObservation::computeImagePartials(), Isis::CsmBundleObservation::computeImagePartials(), Isis::IsisBundleObservation::computeObservationValue(), Isis::BundleAdjust::computePartials(), Isis::IsisBundleObservation::computePoint3DPartials(), Isis::CsmBundleObservation::computePoint3DPartials(), Isis::IsisBundleObservation::computeRHSPartials(), Isis::CsmBundleObservation::computeRHSPartials(), and Isis::IsisBundleObservation::computeTargetPartials().

◆ cubeSerialNumber()

QString Isis::BundleMeasure::cubeSerialNumber ( ) const

Accesses the serial number of the cube containing this control measure.

See also: ControlMeasure::GetCubeSerialNumber()

Returns: QString Returns the serial number of the cube that contains this control measure

Definition at line 251 of file BundleMeasure.cpp.

References Isis::ControlMeasure::GetCubeSerialNumber(), and m_controlMeasure.

Referenced by Isis::BundleAdjust::computePartials(), Isis::IsisBundleObservation::computeRHSPartials(), and Isis::CsmBundleObservation::computeRHSPartials().

◆ focalPlaneComputedX()

double Isis::BundleMeasure::focalPlaneComputedX ( ) const

Accesses the computed focal plane x value for this control measure.

See also: ControlMeasure::GetFocalPlaneComputedX()

Returns: double Returns the computed focal plane x value

Definition at line 263 of file BundleMeasure.cpp.

References m_controlMeasure.

◆ focalPlaneComputedY()

double Isis::BundleMeasure::focalPlaneComputedY ( ) const

Accesses the computed focal plane y value for this control measure.

See also: ControlMeasure::GetFocalPlaneComputedY()

Returns: double Returns the computed focal plane y value

Definition at line 275 of file BundleMeasure.cpp.

References m_controlMeasure.

◆ focalPlaneMeasuredX()

double Isis::BundleMeasure::focalPlaneMeasuredX ( ) const

Accesses the measured focal plane x value for this control measure //TODO verify?

See also: ControlMeasure::GetFocalPlaneMeasuredX()

Returns: double Returns the measured focal plane x value

Definition at line 287 of file BundleMeasure.cpp.

References m_controlMeasure.

Referenced by Isis::IsisBundleObservation::computeRHSPartials().

◆ focalPlaneMeasuredY()

double Isis::BundleMeasure::focalPlaneMeasuredY ( ) const

Accesses the measured focal plane y value for this control measure //TODO verify?

See also: ControlMeasure::GetFocalPlaneMeasuredY()

Returns: double Returns the measured focal plane y value

Definition at line 299 of file BundleMeasure.cpp.

References m_controlMeasure.

Referenced by Isis::IsisBundleObservation::computeRHSPartials().

◆ isRejected()

bool Isis::BundleMeasure::isRejected ( ) const

Determines whether or not this BundleMeasure is rejected.

Returns: bool Returns a boolean indicating whether this BundleMeasure is rejected

Definition at line 116 of file BundleMeasure.cpp.

References m_controlMeasure.

◆ line()

double Isis::BundleMeasure::line ( ) const

Accesses the current line measurement for this control measure.

See also: ControlMeasure::GetLine()

Returns: double Returns the line measurement for this control measure

Definition at line 215 of file BundleMeasure.cpp.

References m_controlMeasure.

Referenced by Isis::BundleAdjust::computePartials(), and Isis::CsmBundleObservation::computeRHSPartials().

◆ lineResidual()

double Isis::BundleMeasure::lineResidual ( ) const

Accesses the line residual for this control measure.

See also: ControlMeasure::GetLineResidual()

Returns: double Returns the line residual

Definition at line 227 of file BundleMeasure.cpp.

References m_controlMeasure.

◆ observationIndex()

int Isis::BundleMeasure::observationIndex ( ) const

Accesses the observation index for the parent observation.

See also: BundleObservation::index()

Returns: int Returns the observation index of the parent observation

Exceptions

IException::Programmer "In BundleMeasure::observationIndex: parent observation has not been set."

Definition at line 314 of file BundleMeasure.cpp.

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

◆ observationSolveSettings()

const QSharedPointer< BundleObservationSolveSettings > Isis::BundleMeasure::observationSolveSettings ( )

Accesses the parent observation's solve settings.

See also: BundleObservation::solveSettings()

Returns: const QSharedPointer<BundleObservationSolveSettings> Returns a const pointer to the BundleObservationSolveSettings for the parent BundleObservation

Exceptions

IException::Programmer "In BundleMeasure::observationSolveSettings: parent observation has not been set."

Definition at line 174 of file BundleMeasure.cpp.

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

◆ operator=()

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

Assignment operator.

Assigns the state of this BundleMeasure from another BundleMeasure

Parameters

src	The source BundleMeasure to assign state from

Returns: BundleMeasure& Returns a reference to this BundleMeasure

Definition at line 66 of file BundleMeasure.cpp.

References m_controlMeasure, m_parentBundleImage, m_parentControlPoint, and m_parentObservation.

◆ parentBundleImage()

QSharedPointer< BundleImage > Isis::BundleMeasure::parentBundleImage ( )

Access the parent BundleImage for this bundle measure.

Returns: QSharedPointer<BundleImage> Returns a pointer to the parent BundleImage

Definition at line 148 of file BundleMeasure.cpp.

References m_parentBundleImage.

◆ parentBundleObservation()

QSharedPointer< BundleObservation > Isis::BundleMeasure::parentBundleObservation ( )

Accesses the parent BundleObservation for this bundle measure.

Returns: QSharedPointer<BundleObservation> Returns a pointer to the parent BundleObservation

Definition at line 158 of file BundleMeasure.cpp.

References m_parentObservation.

Referenced by Isis::BundleAdjust::computePartials().

◆ parentControlPoint()

BundleControlPoint * Isis::BundleMeasure::parentControlPoint ( )

Accesses the parent BundleControlPoint for this bundle measure.

Returns: BundleControlPoint* Returns a pointer to the parent BundleControlPoint

Definition at line 138 of file BundleMeasure.cpp.

References m_parentControlPoint.

Referenced by Isis::CsmBundleObservation::computeImagePartials(), Isis::IsisBundleObservation::computePoint3DPartials(), Isis::CsmBundleObservation::computePoint3DPartials(), Isis::IsisBundleObservation::computeRHSPartials(), Isis::CsmBundleObservation::computeRHSPartials(), and Isis::IsisBundleObservation::computeTargetPartials().

◆ residualMagnitude()

double Isis::BundleMeasure::residualMagnitude ( ) const

Accesses the residual magnitude for this control measure.

See also: ControlMeasure::GetResidualMagnitude()

Returns: double Returns the residual magnitude

Definition at line 239 of file BundleMeasure.cpp.

References Isis::ControlMeasure::GetResidualMagnitude(), and m_controlMeasure.

◆ sample()

double Isis::BundleMeasure::sample ( ) const

Accesses the current sample measurement for this control measure.

See also: ControlMeasure::GetSample()

Returns: double Returns the sample measurement for this control measure

Definition at line 191 of file BundleMeasure.cpp.

References m_controlMeasure.

Referenced by Isis::BundleAdjust::computePartials(), and Isis::CsmBundleObservation::computeRHSPartials().

◆ sampleResidual()

double Isis::BundleMeasure::sampleResidual ( ) const

Accesses the sample residual for this control measure.

See also: ControlMeasure::GetSampleResidual()

Returns: double Returns the sample residual

Definition at line 203 of file BundleMeasure.cpp.

References m_controlMeasure.

◆ setParentImage()

void Isis::BundleMeasure::setParentImage ( QSharedPointer< BundleImage > image )

Sets the parent bundle image.

Parameters

image Pointer to the parent BundleImage

Definition at line 94 of file BundleMeasure.cpp.

References m_parentBundleImage.

◆ setParentObservation()

void Isis::BundleMeasure::setParentObservation ( QSharedPointer< BundleObservation > observation )

Sets the parent bundle observation.

Parameters

observation Pointer to the parent BundleObservation

Definition at line 84 of file BundleMeasure.cpp.

References m_parentObservation.

◆ setRejected()

void Isis::BundleMeasure::setRejected ( bool reject )

Sets the BundleMeasure's status to rejected or not rejected.

Parameters

reject True will set the BundleMeasure to rejected.

See also: ControlMeasure::SetRejected(bool reject)

Definition at line 106 of file BundleMeasure.cpp.

References m_controlMeasure, and Isis::ControlMeasure::SetRejected().

Member Data Documentation

◆ m_controlMeasure

ControlMeasure* Isis::BundleMeasure::m_controlMeasure

private

Contained control measure.

Definition at line 92 of file BundleMeasure.h.

Referenced by BundleMeasure(), camera(), cubeSerialNumber(), focalPlaneComputedX(), focalPlaneComputedY(), focalPlaneMeasuredX(), focalPlaneMeasuredY(), isRejected(), line(), lineResidual(), operator=(), residualMagnitude(), sample(), sampleResidual(), and setRejected().

◆ m_parentBundleImage

QSharedPointer<BundleImage> Isis::BundleMeasure::m_parentBundleImage

private

Parent image of this bundle control measure.

Definition at line 95 of file BundleMeasure.h.

Referenced by BundleMeasure(), operator=(), parentBundleImage(), and setParentImage().

◆ m_parentControlPoint

BundleControlPoint* Isis::BundleMeasure::m_parentControlPoint

private

Parent bundle control point that contains this bundle control measure.

Definition at line 93 of file BundleMeasure.h.

Referenced by BundleMeasure(), operator=(), and parentControlPoint().

◆ m_parentObservation

QSharedPointer<BundleObservation> Isis::BundleMeasure::m_parentObservation

private

Parent bundle observation.

Definition at line 96 of file BundleMeasure.h.

Referenced by BundleMeasure(), observationIndex(), observationSolveSettings(), operator=(), parentBundleObservation(), and setParentObservation().

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

src/control/objs/BundleUtilities/BundleMeasure.h
src/control/objs/BundleUtilities/BundleMeasure.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BundleMeasure() [1/2]

◆ BundleMeasure() [2/2]

◆ ~BundleMeasure()

Member Function Documentation

◆ camera()

◆ cubeSerialNumber()

◆ focalPlaneComputedX()

◆ focalPlaneComputedY()

◆ focalPlaneMeasuredX()

◆ focalPlaneMeasuredY()

◆ isRejected()

◆ line()

◆ lineResidual()

◆ observationIndex()

◆ observationSolveSettings()

◆ operator=()

◆ parentBundleImage()

◆ parentBundleObservation()

◆ parentControlPoint()

◆ residualMagnitude()

◆ sample()

◆ sampleResidual()

◆ setParentImage()

◆ setParentObservation()

◆ setRejected()

Member Data Documentation

◆ m_controlMeasure

◆ m_parentBundleImage

◆ m_parentControlPoint

◆ m_parentObservation