USGS

Isis 3.0 Object Programmers' Reference

 Home
Isis::ControlMeasure

Isis::ControlMeasure Class Reference

#include <ControlMeasure.h>

Collaboration diagram for Isis::ControlMeasure:

Collaboration graph
[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.

Definition at line 57 of file ControlMeasure.h.

Public Types

 Unmeasured
 Manual
 Estimated
 Automatic
 ValidatedManual
 ValidatedAutomatic
enum  MeasureType {
  Unmeasured, Manual, Estimated, Automatic,
  ValidatedManual, ValidatedAutomatic
}
 Control network measurement types. More...

Public Member Functions

 ControlMeasure ()
 Create a control point measurement.
 ~ControlMeasure ()
 Destroy a control point measurement.
void Load (PvlGroup &p)
 Loads a PvlGroup into the ControlMeasure.
PvlGroup CreatePvlGroup ()
 Sets up and returns a PvlGroup for the ControlMeasure.
void SetCoordinate (const double &sample, const double &line)
 Set the coordinate of the measurement.
void SetCoordinate (const double &sample, const double &line, const MeasureType &type)
 Set the coordinate of the measurement.
double Sample () const
 Return the sample coordinate of the measurement.
double Line () const
 Return the line coordinate of the measurement.
void SetError (const double &serror, const double &lerror)
 Set the error of the coordinate.
void SetZScores (const double &zScoreMin, const double &zScoreMax)
 Sets the Z Scores of the coordinate.
double GetZScoreMin () const
 Returns the minimum zScore.
double GetZScoreMax () const
 Returns the maximum zScore.
double SampleError () const
 Return error the sample coordinate of the measurement.
double LineError () const
 Return error the line coordinate of the measurement.
double ErrorMagnitude () const
 Return error magnitude.
void SetType (const MeasureType &type)
 Set how the coordinate was obtained.
MeasureType Type () const
 Return the type of the measurment.
bool IsMeasured () const
 Has the measurement be measured??
bool IsValidated () const
 Has the measurement be validated by a human?
void SetReference (bool value)
 Set if a reference measurement.
bool IsReference () const
 Is the measurement a reference?
void SetCubeSerialNumber (const std::string &sn)
 Set cube serial number.
std::string CubeSerialNumber () const
 Return the serial number of the cube containing the coordinate.
void SetDiameter (double diameter)
 Set the crater diameter at the coordinate.
double Diameter () const
 Return the diameter of the crater in pixels (0 implies no crater).
void SetDateTime ()
 Set date/time the coordinate was last changed to the current date/time.
void SetDateTime (const std::string &datetime)
 Set date/time the coordinate was last changed to specified date/time.
std::string DateTime () const
 Return the date/time the coordinate was last changed.
void SetChooserName ()
 Set chooser name to a user who last changed the coordinate.
void SetChooserName (const std::string &name)
 Set the chooser name to an application that last changed the coordinate.
std::string ChooserName () const
 Return the chooser name.
void SetIgnore (bool ignore)
 Set up to ignore this measurement.
bool Ignore () const
 Return if this measurement should be ignored.
void SetGoodnessOfFit (const double fit)
 Set the Goodness of Fit variable.
double GoodnessOfFit () const
 Return the Goodnes of Fit.
void SetCamera (Isis::Camera *camera)
 Set the camera for this measure.
Isis::Camera * Camera () const
 Return the camera associated with this measure.
void SetFocalPlaneMeasured (double x, double y)
 Set the focal plane x/y for the measured line/sample.
double FocalPlaneMeasuredX () const
 Return the measured focal plane x.
double FocalPlaneMeasuredY () const
 Return the measured focal plane y.
void SetFocalPlaneComputed (double x, double y)
 Set the focal plane x/y for the computed (apriori) lat/lon.
double FocalPlaneComputedX () const
 Return the computed focal plane x.
double FocalPlaneComputedY () const
 Return the computed focal plane y.
void SetMeasuredEphemerisTime (double et)
 Set the measured ephemeris time of the measure.
double MeasuredEphemerisTime () const
 Get the measured ephemeris time of the measure.
void SetComputedEphemerisTime (double et)
 Set the computed ephemeris time of the measure.
double ComputedEphemerisTime () const
 Get the computed ephemeris time of the measure.
const double GetMeasureData (QString type) const
 One Getter to rule them all.
const QVector< QString > GetMeasureDataNames () const
 Returns a list of all valid options to pass to GetMeasureData.

Private Attributes

MeasureType p_measureType
std::string p_serialNumber
double p_line
double p_sample
double p_diameter
std::string p_dateTime
std::string p_chooserName
bool p_ignore
bool p_isReference
double p_sampleError
double p_lineError
double p_zScoreMin
double p_zScoreMax
double p_goodnessOfFit
Isis::Camera * p_camera
double p_focalPlaneMeasuredX
double p_focalPlaneMeasuredY
double p_focalPlaneComputedX
double p_focalPlaneComputedY
double p_measuredEphemerisTime
double p_computedEphemerisTime

Member Enumeration Documentation

enum Isis::ControlMeasure::MeasureType

Control network measurement types.

Unmeasured implies the coordinate (sample, line) has not been identified and therefore should not be used. An error will be thrown if the programmer attempts to acquire a coordinate for an unmeasured measurement

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

Automatic 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.

Definition at line 88 of file ControlMeasure.h.

Constructor & Destructor Documentation

Isis::ControlMeasure::ControlMeasure (  ) 

Create a control point measurement.

Definition at line 32 of file ControlMeasure.cpp.

References Isis::Null, SetCamera(), SetChooserName(), SetCoordinate(), SetCubeSerialNumber(), SetDateTime(), SetDiameter(), SetError(), SetGoodnessOfFit(), SetIgnore(), SetReference(), SetType(), and SetZScores().

Isis::ControlMeasure::~ControlMeasure (  )  [inline]

Destroy a control point measurement.

Definition at line 95 of file ControlMeasure.h.

Member Function Documentation

Isis::Camera* Isis::ControlMeasure::Camera (  )  const [inline]

Return the camera associated with this measure.

Definition at line 254 of file ControlMeasure.h.

References p_camera.

std::string Isis::ControlMeasure::ChooserName (  )  const [inline]

Return the chooser name.

Definition at line 236 of file ControlMeasure.h.

References p_chooserName.

double Isis::ControlMeasure::ComputedEphemerisTime (  )  const [inline]

Get the computed ephemeris time of the measure.

Definition at line 282 of file ControlMeasure.h.

References p_computedEphemerisTime.

PvlGroup Isis::ControlMeasure::CreatePvlGroup (  ) 

Sets up and returns a PvlGroup for the ControlMeasure.

Returns:
The PvlGroup for the ControlMeasure
Exceptions:
Isis::iException::Programmer - Invalid Measure Enumeration

Definition at line 91 of file ControlMeasure.cpp.

References _FILEINFO_, ErrorMagnitude(), IsReference(), Isis::iException::Message(), Isis::Null, p_chooserName, p_dateTime, p_diameter, p_goodnessOfFit, p_ignore, p_line, p_lineError, p_measureType, p_sample, p_sampleError, p_serialNumber, p_zScoreMax, and p_zScoreMin.

std::string Isis::ControlMeasure::CubeSerialNumber (  )  const [inline]

Return the serial number of the cube containing the coordinate.

Definition at line 207 of file ControlMeasure.h.

References p_serialNumber.

Referenced by Isis::ControlPoint::Add(), Isis::ControlPoint::Delete(), and Qisis::ControlPointEdit::savePoint().

std::string Isis::ControlMeasure::DateTime (  )  const [inline]

Return the date/time the coordinate was last changed.

Definition at line 228 of file ControlMeasure.h.

References p_dateTime.

double Isis::ControlMeasure::Diameter (  )  const [inline]

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

Definition at line 220 of file ControlMeasure.h.

References p_diameter.

double Isis::ControlMeasure::ErrorMagnitude (  )  const

Return error magnitude.

Definition at line 152 of file ControlMeasure.cpp.

References dist, p_lineError, and p_sampleError.

Referenced by CreatePvlGroup(), GetMeasureData(), and Load().

double Isis::ControlMeasure::FocalPlaneComputedX (  )  const [inline]

Return the computed focal plane x.

Definition at line 267 of file ControlMeasure.h.

References p_focalPlaneComputedX.

double Isis::ControlMeasure::FocalPlaneComputedY (  )  const [inline]

Return the computed focal plane y.

Definition at line 270 of file ControlMeasure.h.

References p_focalPlaneComputedY.

double Isis::ControlMeasure::FocalPlaneMeasuredX (  )  const [inline]

Return the measured focal plane x.

Definition at line 259 of file ControlMeasure.h.

References p_focalPlaneMeasuredX.

double Isis::ControlMeasure::FocalPlaneMeasuredY (  )  const [inline]

Return the measured focal plane y.

Definition at line 262 of file ControlMeasure.h.

References p_focalPlaneMeasuredY.

const double Isis::ControlMeasure::GetMeasureData ( QString  type  )  const

One Getter to rule them all.

Definition at line 185 of file ControlMeasure.cpp.

References _FILEINFO_, ErrorMagnitude(), IsMeasured(), IsValidated(), Isis::iException::Message(), p_goodnessOfFit, p_ignore, p_lineError, p_measureType, p_sampleError, p_zScoreMax, and p_zScoreMin.

const QVector< QString > Isis::ControlMeasure::GetMeasureDataNames (  )  const

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

Definition at line 217 of file ControlMeasure.cpp.

double Isis::ControlMeasure::GetZScoreMax (  )  const [inline]

Returns the maximum zScore.

Returns:
the maximum zScore

Definition at line 163 of file ControlMeasure.h.

References p_zScoreMax.

double Isis::ControlMeasure::GetZScoreMin (  )  const [inline]

Returns the minimum zScore.

Returns:
the minimum zScore

Definition at line 157 of file ControlMeasure.h.

References p_zScoreMin.

double Isis::ControlMeasure::GoodnessOfFit (  )  const [inline]

Return the Goodnes of Fit.

Definition at line 248 of file ControlMeasure.h.

References p_goodnessOfFit.

bool Isis::ControlMeasure::Ignore (  )  const [inline]

Return if this measurement should be ignored.

Definition at line 242 of file ControlMeasure.h.

References p_ignore.

bool Isis::ControlMeasure::IsMeasured (  )  const [inline]

Has the measurement be measured??

Definition at line 180 of file ControlMeasure.h.

References p_measureType.

Referenced by GetMeasureData(), and IsReference().

bool Isis::ControlMeasure::IsReference (  )  const [inline]

Is the measurement a reference?

Definition at line 192 of file ControlMeasure.h.

References IsMeasured(), and p_isReference.

Referenced by CreatePvlGroup().

bool Isis::ControlMeasure::IsValidated (  )  const [inline]

Has the measurement be validated by a human?

Definition at line 183 of file ControlMeasure.h.

References p_measureType.

Referenced by GetMeasureData().

double Isis::ControlMeasure::Line (  )  const [inline]

Return the line coordinate of the measurement.

Definition at line 129 of file ControlMeasure.h.

References p_line.

Referenced by Qisis::ControlPointEdit::registerPoint(), Qisis::ControlPointEdit::saveChips(), Qisis::ControlPointEdit::setLeftMeasure(), and Qisis::ControlPointEdit::setRightMeasure().

double Isis::ControlMeasure::LineError (  )  const [inline]

Return error the line coordinate of the measurement.

Definition at line 169 of file ControlMeasure.h.

References p_lineError.

void Isis::ControlMeasure::Load ( PvlGroup &  p  ) 

Loads a PvlGroup into the ControlMeasure.

Parameters:
p PvlGroup containing ControlMeasure information
Exceptions:
Isis::iException::User - Invalid Measure Type

Definition at line 54 of file ControlMeasure.cpp.

References _FILEINFO_, ErrorMagnitude(), Isis::iException::Message(), p_chooserName, p_dateTime, p_diameter, p_goodnessOfFit, p_ignore, p_isReference, SetCoordinate(), SetCubeSerialNumber(), SetError(), SetType(), and SetZScores().

double Isis::ControlMeasure::MeasuredEphemerisTime (  )  const [inline]

Get the measured ephemeris time of the measure.

Definition at line 276 of file ControlMeasure.h.

References p_measuredEphemerisTime.

double Isis::ControlMeasure::Sample (  )  const [inline]

Return the sample coordinate of the measurement.

Definition at line 126 of file ControlMeasure.h.

References p_sample.

Referenced by Qisis::ControlPointEdit::registerPoint(), Qisis::ControlPointEdit::saveChips(), Qisis::ControlPointEdit::setLeftMeasure(), and Qisis::ControlPointEdit::setRightMeasure().

double Isis::ControlMeasure::SampleError (  )  const [inline]

Return error the sample coordinate of the measurement.

Definition at line 166 of file ControlMeasure.h.

References p_sampleError.

void Isis::ControlMeasure::SetCamera ( Isis::Camera *  camera  )  [inline]

Set the camera for this measure.

Definition at line 251 of file ControlMeasure.h.

References p_camera.

Referenced by ControlMeasure().

void Isis::ControlMeasure::SetChooserName ( const std::string &  name  )  [inline]

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

Definition at line 233 of file ControlMeasure.h.

References p_chooserName.

void Isis::ControlMeasure::SetChooserName (  ) 

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

Definition at line 165 of file ControlMeasure.cpp.

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

Referenced by ControlMeasure(), and Qisis::ControlPointEdit::savePoint().

void Isis::ControlMeasure::SetComputedEphemerisTime ( double  et  )  [inline]

Set the computed ephemeris time of the measure.

Definition at line 279 of file ControlMeasure.h.

References p_computedEphemerisTime.

void Isis::ControlMeasure::SetCoordinate ( const double &  sample,
const double &  line,
const MeasureType &  type 
) [inline]

Set the coordinate of the measurement.

Parameters:
sample Sample coordinate of the measurement
line Line coordinate of the measurement
type The type of the coordinate

Definition at line 118 of file ControlMeasure.h.

References p_line, p_sample, and SetType().

void Isis::ControlMeasure::SetCoordinate ( const double &  sample,
const double &  line 
) [inline]

Set the coordinate of the measurement.

Parameters:
sample Sample coordinate of the measurement
line Line coordinate of the measurement

Definition at line 106 of file ControlMeasure.h.

References p_line, and p_sample.

Referenced by ControlMeasure(), Load(), and Qisis::ControlPointEdit::savePoint().

void Isis::ControlMeasure::SetCubeSerialNumber ( const std::string &  sn  )  [inline]

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:
sn Serial number of the cube where the coordinate was selected

Definition at line 204 of file ControlMeasure.h.

References p_serialNumber.

Referenced by ControlMeasure(), and Load().

void Isis::ControlMeasure::SetDateTime ( const std::string &  datetime  )  [inline]

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

Definition at line 225 of file ControlMeasure.h.

References p_dateTime.

void Isis::ControlMeasure::SetDateTime (  ) 

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

Definition at line 159 of file ControlMeasure.cpp.

References Isis::iTime::CurrentLocalTime(), and p_dateTime.

Referenced by ControlMeasure(), and Qisis::ControlPointEdit::savePoint().

void Isis::ControlMeasure::SetDiameter ( double  diameter  )  [inline]

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 217 of file ControlMeasure.h.

References p_diameter.

Referenced by ControlMeasure().

void Isis::ControlMeasure::SetError ( const double &  serror,
const double &  lerror 
) [inline]

Set the error of the coordinate.

Parameters:
serror Sample error
lerror Line error

Definition at line 137 of file ControlMeasure.h.

References p_lineError, and p_sampleError.

Referenced by ControlMeasure(), and Load().

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

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

Definition at line 178 of file ControlMeasure.cpp.

References p_focalPlaneComputedX, and p_focalPlaneComputedY.

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

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

Definition at line 171 of file ControlMeasure.cpp.

References p_focalPlaneMeasuredX, and p_focalPlaneMeasuredY.

void Isis::ControlMeasure::SetGoodnessOfFit ( const double  fit  )  [inline]

Set the Goodness of Fit variable.

Definition at line 245 of file ControlMeasure.h.

References p_goodnessOfFit.

Referenced by ControlMeasure().

void Isis::ControlMeasure::SetIgnore ( bool  ignore  )  [inline]

Set up to ignore this measurement.

Definition at line 239 of file ControlMeasure.h.

References p_ignore.

Referenced by ControlMeasure().

void Isis::ControlMeasure::SetMeasuredEphemerisTime ( double  et  )  [inline]

Set the measured ephemeris time of the measure.

Definition at line 273 of file ControlMeasure.h.

References p_measuredEphemerisTime.

void Isis::ControlMeasure::SetReference ( bool  value  )  [inline]

Set if a reference measurement.

Definition at line 189 of file ControlMeasure.h.

References p_isReference.

Referenced by ControlMeasure().

void Isis::ControlMeasure::SetType ( const MeasureType &  type  )  [inline]

Set how the coordinate was obtained.

Definition at line 174 of file ControlMeasure.h.

References p_measureType.

Referenced by ControlMeasure(), Load(), and SetCoordinate().

void Isis::ControlMeasure::SetZScores ( const double &  zScoreMin,
const double &  zScoreMax 
) [inline]

Sets the Z Scores of the coordinate.

Parameters:
zScoreMin Z Score of Minimum DN
zScoreMin Z Score of Maximum DN

Definition at line 148 of file ControlMeasure.h.

References p_zScoreMax, and p_zScoreMin.

Referenced by ControlMeasure(), and Load().

MeasureType Isis::ControlMeasure::Type (  )  const [inline]

Return the type of the measurment.

Definition at line 177 of file ControlMeasure.h.

References p_measureType.

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