Isis 3.0 Object Programmers' Reference

Home

Isis::ControlMeasure Class Reference

#include <ControlMeasure.h>

Inheritance diagram for Isis::ControlMeasure:

[legend]Collaboration diagram for Isis::ControlMeasure:

[legend]List of all members.

Detailed Description

a control measurement

This class is used to record a coordinate (measurement) on a cube for a control point.

Author:: 2005-07-29 Jeff Anderson

See also:: ControlPoint ControlNet

For internal use only.

History:: 2005-07-29 Jeff Anderson Original version

History:: 2006-01-11 Jacob Danton Added a Reference flag and updated unitTest

History:: 2006-10-05 Brendan George Modified call to retrieve current time to use iTime class, instead of Application class

History:: 2008-06-23 Steven Lambright The ZScore keyword is now supported

History:: 2008-06-25 Steven Koechle Added get methods for ZScore values.

History:: 2009-09-01 Eric Hyer Added the methods GetMeasureData and GetMeasureDataNames. Also fixed include issues.

History:: 2009-09-22 Eric Hyer Removed forward declaration for QPair

History:: 2009-10-30 Eric Hyer GetMeasurDataNames is now static

History:: 2009-12-31 Tracie Sucharski Added new parameters for jigsaw.

History:: 2010-04-29 Tracie Sucharski Renamed AutomaticPixel to Registered Pixel and AutomaticSubPixel to RegisteredSubPixel.

History:: 2010-05-06 Tracie Sucharski Use defaults of 0. instead of Isis::Null, because 0. is the default in the protocol buffers.

History:: 2010-06-03 Tracie Sucharski Move SetReference to ControlPoint, so error checking to make sure only a single measure be set to Reference.

History:: 2010-06-17 Tracie Sucharski Added Lock value to MeasureStatus.

History:: 2010-07-21 Tracie Sucharski Remove SetReference IsReference methods. Reference is no longer a separate keyword, but a possible MeasureType. Use either the ControlMeasure::Type() method or ControlPoint::HasReference, ReferenceIndex to determine the reference measure.

History:: 2010-07-27 Tracie Sucharski Updated for changes made after additional working sessions for Control network design.

History:: 2010-08-26 Tracie Sucharski No longer writing ResidualMagnitude, will be calculated as needed.

History:: 2010-10-04 Sharmila Prasad Add PrintableMeasureType method to return String Measure Type

History:: 2010-10-05 Eric Hyer No more includes in header file! serial number is now a QString.

History:: 2010-10-18 Tracie Sucharski Change "Setters", ComputeApriori and ComputeResiduals to return either Success or PointLocked. If the point is locked do not set values.

History:: 2010-10-19 Tracie Sucharski Set the DateTime to Null if anything in measure chanes, the date will be updated at write time.

History:: 2010-10-22 Steven Lambright Moved all implementations to the cpp file to shorten the header. Reordered methods. Improved consistency as far as the types of parameters passed in - some took 'double' and some 'const double &' depending on the original programmer. Now all take 'double' for the cleaner syntax and hopefully the overhead is negligable.

History:: 2010-10-26 Steven Lambright Change default chooser name from user name to application name.

History:: 2010-11-03 Mackenzie Boyd Modified MeasureType to string method, added static version. Added method PrintableClassData.

History:: 2010-11-16 Debbie Cook, Added jigsawRejected keyword.

History:: 2010-11-29 Tracie Sucharski, Constructor still had initializations in addition to the same intiializers in the method InitializeToNull. Also, values were being intialized to 0. instead of Isis::Null. Not sure how this happened other than a mistake in svn mergina? This was causing keywords with a value of 0. to be written to the output network. Remove all methods relating to Ephemeris Time-they are not used anywhere in Isis.

History:: 2010-12-08 Tracie Sucharski, Added a new measure type of Ground. This was done to help qnet functionality, but may be used for other functionality in the future. Added IsGround for convenience.

History:: 2010-12-22 Steven Lambright Added LogData capabilities and prepped for detailed change logs. The accessors needed to change names because of a conflict with a new enumerated value, DataField. The accessors to this class no longer give up internal pointers.

History:: 2011-01-13 Mackenzie Boyd Added pointer to owning ControlPoint.

History:: 2011-02-10 Eric Hyer - Measures no longer know about or care about whether they are the reference measure or not. This is now completely maintained by the ControlPoint class.

History:: 2011-02-18 Eric Hyer - ControlCubeGraphNode is now a friend. Eliminated ConnectControlSN and DisconnectControlSN methods. Fixed bug in destructor.

History:: 2011-03-01 Eric Hyer - Added StringToMeasureType method

History:: 2011-03-04 Tracie Sucharski - Fixed bug in DeleteLogData method, subtract 1 from size() in the loop.

History:: 2011-03-14 Eric Hyer - ControlMeasures now notify their network when their ignored status changes.

History:: 2011-04-04 Steven Lambright - Removed an old constructor

History:: 2011-04-07 Steven Lambright - GetResidualMagnitude no longer does math on special pixels.

History:: 2011-04-11 Steven Lambright - Added GetLogValue for convenience

History:: 2011-07-05 Debbie A. Cook - Removed editLock checks from methods SetCamera, SetRejected, and SetResidual and changed all other editLock tests to use IsEditLocked method instead of the private member, p_editLock, directly. Also added a check for an implicit lock if the measure is the reference measure of the parent point in the IsEditLocked method.

History:: 2011-07-29 Jai Rideout, Steven Lambright, and Eric Hyer - Made this inherit from QObject to get destroyed() signal

Definition at line 167 of file ControlMeasure.h.

Public Types

Candidate

(e.g., autoseed, interest) AKA predicted, unmeasured, unverified

Manual

Hand Measured (e.g., qnet).

RegisteredPixel

Registered to whole pixel (e.g.,pointreg).

RegisteredSubPixel

Registered to sub-pixel (e.g., pointreg).

Success

MeasureLocked

AprioriLine = 1

AprioriSample = 2

ChooserName = 4

CubeSerialNumber = 8

Coordinate = 16

DateTime = 32

Diameter = 64

EditLock = 128

Rejected = 256

FocalPlaneMeasured = 512

FocalPlaneComputed = 1024

Ignore = 2048

SampleResidual = 4096

LineResidual = 8192

SampleSigma = 16384

LineSigma = 32768

Type = 65536

enum MeasureType { Candidate, Manual, RegisteredPixel, RegisteredSubPixel }

Control network measurement types. More...

enum Status { Success, MeasureLocked }

enum DataField {
  AprioriLine = 1, AprioriSample = 2, ChooserName = 4, CubeSerialNumber = 8,
  Coordinate = 16, DateTime = 32, Diameter = 64, EditLock = 128,
  Rejected = 256, FocalPlaneMeasured = 512, FocalPlaneComputed = 1024, Ignore = 2048,
  SampleResidual = 4096, LineResidual = 8192, SampleSigma = 16384, LineSigma = 32768,
  Type = 65536
}

Public Member Functions

ControlMeasure ()

Create a new control measure and initialize it to nulls and zeros.

ControlMeasure (const ControlPointFileEntryV0002_Measure &)

Converts the protocol buffer version of the measure into a real ControlMeasure.

ControlMeasure (const ControlMeasure &other)

Copy the other control measure exactly.

~ControlMeasure ()

Free the memory allocated by a control.

ControlPoint * Parent ()

ControlCubeGraphNode * ControlSN ()

Status SetAprioriLine (double aprioriLine)

Status SetAprioriSample (double aprioriSample)

Status SetCamera (Isis::Camera *camera)

Set pointer to camera associated with a measure.

Status SetChooserName ()

Set chooser name to a user who last changed the coordinate.

Status SetChooserName (iString name)

Set the chooser name to an application that last changed the coordinate.

Status SetCoordinate (double sample, double line)

Set the coordinate of the measurement.

Status SetCoordinate (double sample, double line, MeasureType type)

Status SetCubeSerialNumber (iString newSerialNumber)

Set cube serial number.

Status SetDateTime ()

Date Time - Creation Time.

Status SetDateTime (iString datetime)

Set date/time the coordinate was last changed to specified date/time.

Status SetDiameter (double diameter)

Set the crater diameter at the coordinate.

Status SetEditLock (bool editLock)

Status SetFocalPlaneMeasured (double x, double y)

Set the focal plane x/y for the measured line/sample.

Status SetFocalPlaneComputed (double x, double y)

Set the computed focal plane x/y for the apriori lat/lon.

Status SetIgnored (bool newIgnoredStatus)

Status SetLineSigma (double lineSigma)

Status SetRejected (bool rejected)

Set "jigsaw" rejected flag for a measure.

Status SetResidual (double sampResidual, double lineResidual)

Set the BundleAdjust Residual of the coordinate.

Status SetSampleSigma (double sampleSigma)

Status SetType (MeasureType type)

void DeleteLogData (long dataType)

This deletes log data of the specified type.

QVariant GetLogValue (long dataType) const

Get the value of the log data with the specified type as a variant.

bool HasLogData (long dataType) const

Test if we have a valid log data value of the specified type.

void SetLogData (ControlMeasureLogData)

This adds or updates the log data information associated with data's type.

void UpdateLogData (ControlMeasureLogData)

This updates existing log data information associated with data's type.

double GetAprioriLine () const

double GetAprioriSample () const

Isis::Camera * Camera () const

iString GetChooserName () const

Return the chooser name.

iString GetCubeSerialNumber () const

Return the serial number of the cube containing the coordinate.

iString GetDateTime () const

Return the date/time the coordinate was last changed.

double GetDiameter () const

Return the diameter of the crater in pixels (0 implies no crater).

ControlMeasureLogData GetLogData (long dataType) const

bool IsEditLocked () const

Return value for p_editLock or implicit lock on reference measure.

bool IsRejected () const

double GetFocalPlaneComputedX () const

double GetFocalPlaneComputedY () const

double GetFocalPlaneMeasuredX () const

double GetFocalPlaneMeasuredY () const

double GetMeasureData (iString) const

One Getter to rule them all.

bool IsIgnored () const

bool IsMeasured () const

bool IsRegistered () const

bool IsStatisticallyRelevant (DataField field) const

double GetLine () const

double GetLineResidual () const

double GetLineSigma () const

QVector< ControlMeasureLogData > GetLogDataEntries () const

QVector< ControlMeasureLogData > GetLastRunLogDataEntries () const

double GetResidualMagnitude () const

Return Residual magnitude.

double GetSample () const

double GetSampleResidual () const

double GetSampleSigma () const

MeasureType GetType () const

QString GetPointId () const

double GetSampleShift () const

double GetLineShift () const

double GetPixelShift () const

QList< QStringList > PrintableClassData () const

Data accessor method, provides access to string representations of all variable values and names.

iString GetMeasureTypeString () const

Obtain a string representation of the MeasureType.

const ControlMeasure & operator= (const ControlMeasure &other)

Assignment operator.

bool operator!= (const Isis::ControlMeasure &pMeasure) const

Compare 2 Control Measures for inequality.

bool operator== (const Isis::ControlMeasure &pMeasure) const

Check for Control Measures equality.

ControlPointFileEntryV0002_Measure ToProtocolBuffer () const

Static Public Member Functions

static QVector< iString > GetMeasureDataNames ()

Returns a list of all valid options to pass to GetMeasureData.

static iString MeasureTypeToString (MeasureType type)

static MeasureType StringToMeasureType (QString str)

Private Member Functions

void InitializeToNull ()

initialize pointers and other data to NULL

void MeasureModified ()

Private Attributes

ControlPoint * parentPoint

Pointer to parent ControlPoint, may be null.

ControlCubeGraphNode * associatedCSN

Pointer to the Serial Number.

iString * p_serialNumber

MeasureType p_measureType

QVector< ControlMeasureLogData > * p_loggedData

PvlGroup * p_comments

iString * p_chooserName

list the program used and the definition file or include the user name for qnet

iString * p_dateTime

bool p_editLock

If true do not edit anything in measure.

bool p_ignore

bool p_jigsawRejected

Status of measure for last bundle adjust iteration.

double p_sample

Current sample/line measurement.

double p_line

Jigsaw uses this measure.

double p_diameter

double p_aprioriSample

The first identified location of the.

double p_aprioriLine

measure by autoseed. Pointreg/Interest always use this location to start it's search. Could be moved by interest program or user.

double p_computedEphemerisTime

double p_sampleSigma

Uncertainty/sigma in pixels of the measurement (current sample/line).

double p_lineSigma

Not sure how we determine this for automated or manual picking.

double p_sampleResidual

Jigsaw information - Solution error - replaces p_sampleError.

double p_lineResidual

Jigsaw information - Solution error - replaces p_lineError.

Isis::Camera * p_camera

double p_focalPlaneMeasuredX

double p_focalPlaneMeasuredY

double p_focalPlaneComputedX

double p_focalPlaneComputedY

double p_measuredEphemerisTime

Friends

class ControlPoint

class ControlCubeGraphNode

Member Enumeration Documentation

enum Isis::ControlMeasure::MeasureType

Control network measurement types.

OLD VERSION: Manual implies the coordinate was selected by a human but still may be in error. It is subject to refinement by other computer programs.

Estimated implies the coordinate was selected by a computer program but has not been sub-pixel registered and is more than likely in error. It is subject to refinement by other computer programs

AutomaticPixel implies the coordinate was selected by a computer program and met registration criteria (but still may be in error). It is subject to refinement by other computer programs.

ValidatedManual implies the coordinate was manually selected by a human, was validated by a human, and should not be changed by any automated means.

ValidatedAutomatic implies the coordinate was automatically selected by a computer program, was validated by a human, and should not be changed by any automated means.

Enumerator:

Candidate	(e.g., autoseed, interest) AKA predicted, unmeasured, unverified
Manual	Hand Measured (e.g., qnet).
RegisteredPixel	Registered to whole pixel (e.g.,pointreg).
RegisteredSubPixel	Registered to sub-pixel (e.g., pointreg).

Definition at line 199 of file ControlMeasure.h.

Constructor & Destructor Documentation

Isis::ControlMeasure::ControlMeasure ( )

Create a new control measure and initialize it to nulls and zeros.

Definition at line 45 of file ControlMeasure.cpp.

References Candidate, InitializeToNull(), p_chooserName, p_dateTime, p_editLock, p_ignore, p_jigsawRejected, p_line, p_loggedData, p_measureType, p_sample, and p_serialNumber.

Isis::ControlMeasure::ControlMeasure ( const ControlPointFileEntryV0002_Measure & protoBuf )

Converts the protocol buffer version of the measure into a real ControlMeasure.

Parameters:

other

The control measure to copy all of the values from

Definition at line 69 of file ControlMeasure.cpp.

Isis::ControlMeasure::ControlMeasure ( const ControlMeasure & other )

Copy the other control measure exactly.

Parameters:

other

The control measure to copy all of the values from

Definition at line 135 of file ControlMeasure.cpp.

References associatedCSN, InitializeToNull(), p_aprioriLine, p_aprioriSample, p_camera, p_chooserName, p_dateTime, p_diameter, p_editLock, p_ignore, p_jigsawRejected, p_line, p_lineResidual, p_lineSigma, p_loggedData, p_measureType, p_sample, p_sampleResidual, p_sampleSigma, and p_serialNumber.

Isis::ControlMeasure::~ControlMeasure ( )

Free the memory allocated by a control.

Definition at line 191 of file ControlMeasure.cpp.

References associatedCSN, p_chooserName, p_dateTime, p_loggedData, and p_serialNumber.

Member Function Documentation

void Isis::ControlMeasure::DeleteLogData ( long dataType )

This deletes log data of the specified type.

If none exist, this does nothing.

Parameters:

dataType

A ControlMeasureLogData::NumericLogDataType

Definition at line 524 of file ControlMeasure.cpp.

References p_loggedData.

Referenced by Isis::ControlPointEdit::saveMeasure().

iString Isis::ControlMeasure::GetChooserName ( ) const

Return the chooser name.

Definition at line 611 of file ControlMeasure.cpp.

References Isis::Application::Name(), and p_chooserName.

Referenced by ToProtocolBuffer().

iString Isis::ControlMeasure::GetCubeSerialNumber ( ) const

Return the serial number of the cube containing the coordinate.

Definition at line 622 of file ControlMeasure.cpp.

References p_serialNumber.

Referenced by Isis::ControlPoint::AddMeasure(), Isis::ControlCubeGraphNode::addMeasure(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlPoint::Delete(), Isis::InterestOperator::FindOverlap(), Isis::BundleAdjust::FlagOutliers(), Isis::ControlPoint::GetReferenceSN(), Isis::ControlPoint::IndexOf(), Isis::ControlPoint::IndexOfRefMeasure(), Isis::InterestOperator::InterestByMeasure(), Isis::ControlNet::measureAdded(), Isis::ControlNet::measureDeleted(), Isis::ControlNet::measureIgnored(), Isis::ControlNet::measureUnIgnored(), Isis::ControlNetFilter::PointDistanceFilter(), Isis::ControlNetFilter::PrintCubeFileSerialNum(), Isis::ControlPointEdit::saveMeasure(), and ToProtocolBuffer().

iString Isis::ControlMeasure::GetDateTime ( ) const

Return the date/time the coordinate was last changed.

Definition at line 628 of file ControlMeasure.cpp.

References Isis::Application::DateTime(), and p_dateTime.

Referenced by ToProtocolBuffer().

double Isis::ControlMeasure::GetDiameter ( ) const

Return the diameter of the crater in pixels (0 implies no crater).

Definition at line 639 of file ControlMeasure.cpp.

References p_diameter.

Referenced by ToProtocolBuffer().

QVariant Isis::ControlMeasure::GetLogValue ( long dataType ) const

Get the value of the log data with the specified type as a variant.

This should work for all types of log data.

Definition at line 538 of file ControlMeasure.cpp.

References p_loggedData.

double Isis::ControlMeasure::GetMeasureData ( iString ) const

One Getter to rule them all.

Definition at line 845 of file ControlMeasure.cpp.

References _FILEINFO_, IsMeasured(), IsRegistered(), Isis::iException::Message(), p_ignore, p_lineResidual, p_measureType, and p_sampleResidual.

QVector< iString > Isis::ControlMeasure::GetMeasureDataNames ( ) [static]

Returns a list of all valid options to pass to GetMeasureData.

Definition at line 867 of file ControlMeasure.cpp.

iString Isis::ControlMeasure::GetMeasureTypeString ( ) const

Obtain a string representation of the MeasureType.

Returns:: A string representation of the MeasureType

Definition at line 1024 of file ControlMeasure.cpp.

References p_measureType.

Referenced by Isis::ControlNetFilter::PointPixelShiftFilter(), Isis::ControlNetFilter::PointResMagnitudeFilter(), and PrintableClassData().

double Isis::ControlMeasure::GetResidualMagnitude ( ) const

Return Residual magnitude.

Definition at line 765 of file ControlMeasure.cpp.

References Isis::IsSpecial(), Isis::Null, p_lineResidual, and p_sampleResidual.

Referenced by Isis::ControlNet::AverageResidual(), Isis::ControlNet::GetMaximumResidual(), Isis::ControlNetStatistics::GetPointDoubleStats(), Isis::ControlNetFilter::PointResMagnitudeFilter(), PrintableClassData(), and Isis::ControlNetValidMeasure::ValidStandardOptions().

bool Isis::ControlMeasure::HasLogData ( long dataType ) const

Test if we have a valid log data value of the specified type.

Parameters:

dataType

A ControlMeasureLogData::NumericLogDataType

Definition at line 555 of file ControlMeasure.cpp.

References p_loggedData.

Referenced by SetLogData().

void Isis::ControlMeasure::InitializeToNull ( ) [private]

initialize pointers and other data to NULL

Definition at line 163 of file ControlMeasure.cpp.

References associatedCSN, Isis::Null, p_aprioriLine, p_aprioriSample, p_camera, p_chooserName, p_dateTime, p_diameter, p_focalPlaneComputedX, p_focalPlaneComputedY, p_focalPlaneMeasuredX, p_focalPlaneMeasuredY, p_lineResidual, p_lineSigma, p_loggedData, p_sampleResidual, p_sampleSigma, p_serialNumber, and parentPoint.

Referenced by ControlMeasure().

bool Isis::ControlMeasure::IsEditLocked ( ) const

Return value for p_editLock or implicit lock on reference measure.

This method returns p_editLock unless the measure is a reference measure. In the case of a reference measure the value of the parent point's editLock is returned. An editLock on a control point implicitly locks the points reference measure as well.

Returns:: value of p_editLock

For internal use only.

History:: 2011-07-05 Debbie A. Cook Added check for implicit lock on the reference measure of the parent's reference measure.

Definition at line 660 of file ControlMeasure.cpp.

References Isis::ControlPoint::GetRefMeasure(), Isis::ControlPoint::IsEditLocked(), p_editLock, and parentPoint.

Referenced by Isis::ControlPoint::Delete(), Isis::ControlNetStatistics::GenerateImageStats(), Isis::ControlNetFilter::PointPixelShiftFilter(), Isis::ControlNetFilter::PointResMagnitudeFilter(), SetAprioriLine(), SetAprioriSample(), SetChooserName(), SetCubeSerialNumber(), SetDateTime(), SetDiameter(), SetIgnored(), SetLineSigma(), SetSampleSigma(), and ToProtocolBuffer().

bool Isis::ControlMeasure::operator!= ( const Isis::ControlMeasure & pMeasure ) const

Compare 2 Control Measures for inequality.

Author:: sprasad (4/20/2010)

Parameters:

pMeasure

Returns:: bool

Definition at line 1104 of file ControlMeasure.cpp.

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

Assignment operator.

For internal use only.

History:: 2011-09-01 Tracie Sucharski - Do not set parentPoint to NULL or copy, retain the current parentPoint.

History:: 2011-09-22 Tracie Sucharski - Bug introduced from 2011-09-01 change when setting ignored status.

Definition at line 1038 of file ControlMeasure.cpp.

References associatedCSN, p_aprioriLine, p_aprioriSample, p_camera, p_chooserName, p_dateTime, p_diameter, p_editLock, p_focalPlaneComputedX, p_focalPlaneComputedY, p_focalPlaneMeasuredX, p_focalPlaneMeasuredY, p_ignore, p_line, p_lineResidual, p_lineSigma, p_loggedData, p_measureType, p_sample, p_sampleResidual, p_sampleSigma, p_serialNumber, and SetIgnored().

bool Isis::ControlMeasure::operator== ( const Isis::ControlMeasure & pMeasure ) const

Check for Control Measures equality.

Author:: sprasad (4/20/2010)

history 2010-06-24 Tracie Sucharski, Added new keywords

Parameters:

pMeasure

- Control Measure to be compared against

Returns:: bool

Definition at line 1120 of file ControlMeasure.cpp.

References p_aprioriLine, p_aprioriSample, p_chooserName, p_dateTime, p_diameter, p_editLock, p_focalPlaneComputedX, p_focalPlaneComputedY, p_focalPlaneMeasuredX, p_focalPlaneMeasuredY, p_ignore, p_line, p_lineResidual, p_lineSigma, p_measureType, p_sample, p_sampleResidual, p_sampleSigma, and p_serialNumber.

QList< QStringList > Isis::ControlMeasure::PrintableClassData ( ) const

Data accessor method, provides access to string representations of all variable values and names.

Returns:: A QList containing QStringLists, the QStringLists contain name value pairs such that element 0 is the name and element 1 is the value of the variable.

Definition at line 888 of file ControlMeasure.cpp.

References GetMeasureTypeString(), GetResidualMagnitude(), p_aprioriLine, p_aprioriSample, p_chooserName, p_dateTime, p_line, p_lineResidual, p_lineSigma, p_sample, p_sampleResidual, p_sampleSigma, and p_serialNumber.

ControlMeasure::Status Isis::ControlMeasure::SetCamera ( Isis::Camera * camera )

Set pointer to camera associated with a measure.

This method is used to set a pointer to the camera associated with a ControlMeasure.

Parameters:

*camera

Pointer to camera

Returns:: Status Success

For internal use only.

History:: 2011-07-01 Debbie A. Cook Removed editLock check

Definition at line 249 of file ControlMeasure.cpp.

References p_camera.

ControlMeasure::Status Isis::ControlMeasure::SetChooserName ( iString name )

Set the chooser name to an application that last changed the coordinate.

Definition at line 285 of file ControlMeasure.cpp.

References IsEditLocked(), and p_chooserName.

ControlMeasure::Status Isis::ControlMeasure::SetChooserName ( )

Set chooser name to a user who last changed the coordinate.

Definition at line 276 of file ControlMeasure.cpp.

References IsEditLocked(), and p_chooserName.

Referenced by Isis::ControlPointEdit::saveMeasure().

ControlMeasure::Status Isis::ControlMeasure::SetCoordinate	(	double	sample,
		double	line
	)

Set the coordinate of the measurement.

Parameters:

	sample	Sample coordinate of the measurement
	line	Line coordinate of the measurement,

Definition at line 299 of file ControlMeasure.cpp.

References GetType().

Referenced by Isis::ControlPointEdit::saveMeasure().

ControlMeasure::Status Isis::ControlMeasure::SetCubeSerialNumber ( iString newSerialNumber )

Set cube serial number.

This method is used to set the serial number of the cube. That is, the coordinate was selected from a cube with this unique serial number

Parameters:

Serial number of the cube where the coordinate was selected

Returns:: Status Success or MeasureLocked

Definition at line 267 of file ControlMeasure.cpp.

References IsEditLocked(), and p_serialNumber.

ControlMeasure::Status Isis::ControlMeasure::SetDateTime ( iString datetime )

Set date/time the coordinate was last changed to specified date/time.

Definition at line 334 of file ControlMeasure.cpp.

References IsEditLocked(), and p_dateTime.

ControlMeasure::Status Isis::ControlMeasure::SetDateTime ( )

Date Time - Creation Time.

Definition at line 325 of file ControlMeasure.cpp.

References Isis::Application::DateTime(), IsEditLocked(), and p_dateTime.

Referenced by Isis::ControlPointEdit::saveMeasure().

ControlMeasure::Status Isis::ControlMeasure::SetDiameter ( double diameter )

Set the crater diameter at the coordinate.

This method sets the crater diameter at the coordinate. If left unset a diameter of 0 is assumed which implies no crater

Parameters:

diameter

The diameter of the crater in pixels

Definition at line 350 of file ControlMeasure.cpp.

References IsEditLocked(), MeasureModified(), and p_diameter.

ControlMeasure::Status Isis::ControlMeasure::SetFocalPlaneComputed	(	double	x,
		double	y
	)

Set the computed focal plane x/y for the apriori lat/lon.

This is a convenience method for the BundleAdjustment class to avoid having to go redo the calculation.

Parameters:

*camera

Pointer to camera

Returns:: Status Success

For internal use only.

History:: 2011-07-14 Debbie A. Cook Removed editLock check for jigsaw

Definition at line 397 of file ControlMeasure.cpp.

References p_focalPlaneComputedX, and p_focalPlaneComputedY.

ControlMeasure::Status Isis::ControlMeasure::SetFocalPlaneMeasured	(	double	x,
		double	y
	)

Set the focal plane x/y for the measured line/sample.

This is a convenience method for the BundleAdjustment class to avoid having to go redo the calculation.

Parameters:

*camera

Pointer to camera

Returns:: Status Success

For internal use only.

History:: 2011-07-09 Debbie A. Cook Removed editLock check for jigsaw

Definition at line 377 of file ControlMeasure.cpp.

References p_focalPlaneMeasuredX, and p_focalPlaneMeasuredY.

void Isis::ControlMeasure::SetLogData ( ControlMeasureLogData data )

This adds or updates the log data information associated with data's type.

In most cases, this is what you want to use to assign log data.

Definition at line 504 of file ControlMeasure.cpp.

References _FILEINFO_, Isis::ControlMeasureLogData::GetDataType(), HasLogData(), Isis::ControlMeasureLogData::IsValid(), Isis::iException::Message(), p_loggedData, and UpdateLogData().

Referenced by Isis::ControlPointEdit::saveMeasure().

ControlMeasure::Status Isis::ControlMeasure::SetRejected ( bool reject )

Set "jigsaw" rejected flag for a measure.

This method is used to set the "jigsaw"-rejected flag for the current measure. It should only be used by jigsaw.

Parameters:

*reject

rejected flag

Returns:: Status Success

For internal use only.

History:: 2011-07-01 Debbie A. Cook Removed editLock check

Definition at line 421 of file ControlMeasure.cpp.

References MeasureModified(), and p_jigsawRejected.

Referenced by Isis::ControlPoint::ClearJigsawRejected(), and Isis::BundleAdjust::FlagOutliers().

ControlMeasure::Status Isis::ControlMeasure::SetResidual	(	double	sampResidual,
		double	lineResidual
	)

Set the BundleAdjust Residual of the coordinate.

***Warning: This method should only be used by BundleAdjust and its applications.

Parameters:

	sampResidual	Sample Residual
	lineResidual	Line Residual

For internal use only.

History:: 2011-07-01 Debbie A. Cook Removed editLock check to allow the residuals of locked points to be reported.

Definition at line 471 of file ControlMeasure.cpp.

References MeasureModified(), p_lineResidual, and p_sampleResidual.

ControlMeasure::MeasureType Isis::ControlMeasure::StringToMeasureType ( QString str ) [static]

Parameters:

str

The string to get a MeasureType from

Returns:: A Measure Type given a string

Definition at line 953 of file ControlMeasure.cpp.

References _FILEINFO_, Candidate, Manual, Isis::iException::Message(), RegisteredPixel, and RegisteredSubPixel.

void Isis::ControlMeasure::UpdateLogData ( ControlMeasureLogData newLogData )

This updates existing log data information associated with data's type.

If none exist, an error is thrown.

See also:: SetLogData

Definition at line 573 of file ControlMeasure.cpp.

References _FILEINFO_, Isis::ControlMeasureLogData::DataTypeToName(), Isis::ControlMeasureLogData::GetDataType(), Isis::iException::Message(), and p_loggedData.

Referenced by SetLogData().

Member Data Documentation

ControlCubeGraphNode* Isis::ControlMeasure::associatedCSN [private]

Pointer to the Serial Number.

Definition at line 325 of file ControlMeasure.h.

Referenced by Isis::ControlCubeGraphNode::addMeasure(), ControlMeasure(), ControlSN(), InitializeToNull(), operator=(), Isis::ControlCubeGraphNode::removeMeasure(), and ~ControlMeasure().

double Isis::ControlMeasure::p_aprioriLine [private]

measure by autoseed. Pointreg/Interest always use this location to start it's search. Could be moved by interest program or user.

Definition at line 348 of file ControlMeasure.h.

Referenced by ControlMeasure(), GetAprioriLine(), GetLineShift(), InitializeToNull(), operator=(), operator==(), PrintableClassData(), and SetAprioriLine().

double Isis::ControlMeasure::p_aprioriSample [private]

The first identified location of the.

Definition at line 347 of file ControlMeasure.h.

Referenced by ControlMeasure(), GetAprioriSample(), GetSampleShift(), InitializeToNull(), operator=(), operator==(), PrintableClassData(), and SetAprioriSample().

iString* Isis::ControlMeasure::p_chooserName [private]

list the program used and the definition file or include the user name for qnet

Definition at line 338 of file ControlMeasure.h.

Referenced by ControlMeasure(), GetChooserName(), InitializeToNull(), MeasureModified(), operator=(), operator==(), PrintableClassData(), SetChooserName(), and ~ControlMeasure().

bool Isis::ControlMeasure::p_editLock [private]

If true do not edit anything in measure.

Definition at line 340 of file ControlMeasure.h.

Referenced by ControlMeasure(), IsEditLocked(), operator=(), operator==(), and SetEditLock().

bool Isis::ControlMeasure::p_jigsawRejected [private]

Status of measure for last bundle adjust iteration.

Definition at line 342 of file ControlMeasure.h.

Referenced by ControlMeasure(), IsRejected(), and SetRejected().

double Isis::ControlMeasure::p_line [private]

Jigsaw uses this measure.

Definition at line 344 of file ControlMeasure.h.

Referenced by ControlMeasure(), GetLine(), GetLineShift(), operator=(), operator==(), and PrintableClassData().

double Isis::ControlMeasure::p_lineResidual [private]

Jigsaw information - Solution error - replaces p_lineError.

Definition at line 358 of file ControlMeasure.h.

Referenced by ControlMeasure(), GetLineResidual(), GetMeasureData(), GetResidualMagnitude(), InitializeToNull(), operator=(), operator==(), PrintableClassData(), and SetResidual().

double Isis::ControlMeasure::p_lineSigma [private]

Not sure how we determine this for automated or manual picking.

Definition at line 356 of file ControlMeasure.h.

Referenced by ControlMeasure(), GetLineSigma(), InitializeToNull(), operator=(), operator==(), PrintableClassData(), and SetLineSigma().

double Isis::ControlMeasure::p_sample [private]

Current sample/line measurement.

Definition at line 343 of file ControlMeasure.h.

Referenced by ControlMeasure(), GetSample(), GetSampleShift(), operator=(), operator==(), and PrintableClassData().

double Isis::ControlMeasure::p_sampleResidual [private]

Jigsaw information - Solution error - replaces p_sampleError.

Definition at line 357 of file ControlMeasure.h.

Referenced by ControlMeasure(), GetMeasureData(), GetResidualMagnitude(), GetSampleResidual(), InitializeToNull(), operator=(), operator==(), PrintableClassData(), and SetResidual().

double Isis::ControlMeasure::p_sampleSigma [private]

Uncertainty/sigma in pixels of the measurement (current sample/line).

Definition at line 355 of file ControlMeasure.h.

Referenced by ControlMeasure(), GetSampleSigma(), InitializeToNull(), operator=(), operator==(), PrintableClassData(), and SetSampleSigma().

ControlPoint* Isis::ControlMeasure::parentPoint [private]

Pointer to parent ControlPoint, may be null.

Definition at line 324 of file ControlMeasure.h.

Referenced by Isis::ControlPoint::AddMeasure(), GetPointId(), InitializeToNull(), IsEditLocked(), Parent(), and SetIgnored().

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

src/control/objs/ControlMeasure/ControlMeasure.h
src/control/objs/ControlMeasure/ControlMeasure.cpp


Public Types
	Candidate
	(e.g., autoseed, interest) AKA predicted, unmeasured, unverified
	Manual
	Hand Measured (e.g., qnet).
	RegisteredPixel
	Registered to whole pixel (e.g.,pointreg).
	RegisteredSubPixel
	Registered to sub-pixel (e.g., pointreg).
	Success
	MeasureLocked
	AprioriLine = 1
	AprioriSample = 2
	ChooserName = 4
	CubeSerialNumber = 8
	Coordinate = 16
	DateTime = 32
	Diameter = 64
	EditLock = 128
	Rejected = 256
	FocalPlaneMeasured = 512
	FocalPlaneComputed = 1024
	Ignore = 2048
	SampleResidual = 4096
	LineResidual = 8192
	SampleSigma = 16384
	LineSigma = 32768
	Type = 65536
enum	MeasureType { Candidate, Manual, RegisteredPixel, RegisteredSubPixel }
	Control network measurement types. More...
enum	Status { Success, MeasureLocked }
enum	DataField { AprioriLine = 1, AprioriSample = 2, ChooserName = 4, CubeSerialNumber = 8, Coordinate = 16, DateTime = 32, Diameter = 64, EditLock = 128, Rejected = 256, FocalPlaneMeasured = 512, FocalPlaneComputed = 1024, Ignore = 2048, SampleResidual = 4096, LineResidual = 8192, SampleSigma = 16384, LineSigma = 32768, Type = 65536 }
Public Member Functions
	ControlMeasure ()
	Create a new control measure and initialize it to nulls and zeros.
	ControlMeasure (const ControlPointFileEntryV0002_Measure &)
	Converts the protocol buffer version of the measure into a real ControlMeasure.
	ControlMeasure (const ControlMeasure &other)
	Copy the other control measure exactly.
	~ControlMeasure ()
	Free the memory allocated by a control.
ControlPoint *	Parent ()
ControlCubeGraphNode *	ControlSN ()
Status	SetAprioriLine (double aprioriLine)
Status	SetAprioriSample (double aprioriSample)
Status	SetCamera (Isis::Camera *camera)
	Set pointer to camera associated with a measure.
Status	SetChooserName ()
	Set chooser name to a user who last changed the coordinate.
Status	SetChooserName (iString name)
	Set the chooser name to an application that last changed the coordinate.
Status	SetCoordinate (double sample, double line)
	Set the coordinate of the measurement.
Status	SetCoordinate (double sample, double line, MeasureType type)
Status	SetCubeSerialNumber (iString newSerialNumber)
	Set cube serial number.
Status	SetDateTime ()
	Date Time - Creation Time.
Status	SetDateTime (iString datetime)
	Set date/time the coordinate was last changed to specified date/time.
Status	SetDiameter (double diameter)
	Set the crater diameter at the coordinate.
Status	SetEditLock (bool editLock)
Status	SetFocalPlaneMeasured (double x, double y)
	Set the focal plane x/y for the measured line/sample.
Status	SetFocalPlaneComputed (double x, double y)
	Set the computed focal plane x/y for the apriori lat/lon.
Status	SetIgnored (bool newIgnoredStatus)
Status	SetLineSigma (double lineSigma)
Status	SetRejected (bool rejected)
	Set "jigsaw" rejected flag for a measure.
Status	SetResidual (double sampResidual, double lineResidual)
	Set the BundleAdjust Residual of the coordinate.
Status	SetSampleSigma (double sampleSigma)
Status	SetType (MeasureType type)
void	DeleteLogData (long dataType)
	This deletes log data of the specified type.
QVariant	GetLogValue (long dataType) const
	Get the value of the log data with the specified type as a variant.
bool	HasLogData (long dataType) const
	Test if we have a valid log data value of the specified type.
void	SetLogData (ControlMeasureLogData)
	This adds or updates the log data information associated with data's type.
void	UpdateLogData (ControlMeasureLogData)
	This updates existing log data information associated with data's type.
double	GetAprioriLine () const
double	GetAprioriSample () const
Isis::Camera *	Camera () const
iString	GetChooserName () const
	Return the chooser name.
iString	GetCubeSerialNumber () const
	Return the serial number of the cube containing the coordinate.
iString	GetDateTime () const
	Return the date/time the coordinate was last changed.
double	GetDiameter () const
	Return the diameter of the crater in pixels (0 implies no crater).
ControlMeasureLogData	GetLogData (long dataType) const
bool	IsEditLocked () const
	Return value for p_editLock or implicit lock on reference measure.
bool	IsRejected () const
double	GetFocalPlaneComputedX () const
double	GetFocalPlaneComputedY () const
double	GetFocalPlaneMeasuredX () const
double	GetFocalPlaneMeasuredY () const
double	GetMeasureData (iString) const
	One Getter to rule them all.
bool	IsIgnored () const
bool	IsMeasured () const
bool	IsRegistered () const
bool	IsStatisticallyRelevant (DataField field) const
double	GetLine () const
double	GetLineResidual () const
double	GetLineSigma () const
QVector< ControlMeasureLogData >	GetLogDataEntries () const
QVector< ControlMeasureLogData >	GetLastRunLogDataEntries () const
double	GetResidualMagnitude () const
	Return Residual magnitude.
double	GetSample () const
double	GetSampleResidual () const
double	GetSampleSigma () const
MeasureType	GetType () const
QString	GetPointId () const
double	GetSampleShift () const
double	GetLineShift () const
double	GetPixelShift () const
QList< QStringList >	PrintableClassData () const
	Data accessor method, provides access to string representations of all variable values and names.
iString	GetMeasureTypeString () const
	Obtain a string representation of the MeasureType.
const ControlMeasure &	operator= (const ControlMeasure &other)
	Assignment operator.
bool	operator!= (const Isis::ControlMeasure &pMeasure) const
	Compare 2 Control Measures for inequality.
bool	operator== (const Isis::ControlMeasure &pMeasure) const
	Check for Control Measures equality.
ControlPointFileEntryV0002_Measure	ToProtocolBuffer () const
Static Public Member Functions
static QVector< iString >	GetMeasureDataNames ()
	Returns a list of all valid options to pass to GetMeasureData.
static iString	MeasureTypeToString (MeasureType type)
static MeasureType	StringToMeasureType (QString str)
Private Member Functions
void	InitializeToNull ()
	initialize pointers and other data to NULL
void	MeasureModified ()
Private Attributes
ControlPoint *	parentPoint
	Pointer to parent ControlPoint, may be null.
ControlCubeGraphNode *	associatedCSN
	Pointer to the Serial Number.
iString *	p_serialNumber
MeasureType	p_measureType
QVector< ControlMeasureLogData > *	p_loggedData
PvlGroup *	p_comments
iString *	p_chooserName
	list the program used and the definition file or include the user name for qnet
iString *	p_dateTime
bool	p_editLock
	If true do not edit anything in measure.
bool	p_ignore
bool	p_jigsawRejected
	Status of measure for last bundle adjust iteration.
double	p_sample
	Current sample/line measurement.
double	p_line
	Jigsaw uses this measure.
double	p_diameter
double	p_aprioriSample
	The first identified location of the.
double	p_aprioriLine
	measure by autoseed. Pointreg/Interest always use this location to start it's search. Could be moved by interest program or user.
double	p_computedEphemerisTime
double	p_sampleSigma
	Uncertainty/sigma in pixels of the measurement (current sample/line).
double	p_lineSigma
	Not sure how we determine this for automated or manual picking.
double	p_sampleResidual
	Jigsaw information - Solution error - replaces p_sampleError.
double	p_lineResidual
	Jigsaw information - Solution error - replaces p_lineError.
Isis::Camera *	p_camera
double	p_focalPlaneMeasuredX
double	p_focalPlaneMeasuredY
double	p_focalPlaneComputedX
double	p_focalPlaneComputedY
double	p_measuredEphemerisTime
Friends
class	ControlPoint
class	ControlCubeGraphNode