Isis 3 Programmer Reference
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Isis::ControlNetValidMeasure Class Reference

ControlNetValidMeasure class. More...

#include <ControlNetValidMeasure.h>

Inheritance diagram for Isis::ControlNetValidMeasure:
Inheritance graph
Collaboration diagram for Isis::ControlNetValidMeasure:
Collaboration graph

Public Member Functions

 ControlNetValidMeasure (Pvl *pvl=0)
 Constructor - Initializes the data members and parses the input Pvl .
 
 ControlNetValidMeasure (Pvl &pvl)
 Constructor with a reference to Pvl Def file.
 
void InitStdOptions (void)
 Initialize the Standard Options.
 
void InitStdOptionsGroup (void)
 Initialize the Standard Options Pvl Group with no DefFile.
 
virtual ~ControlNetValidMeasure ()
 Destructor: clean up stuff relevant for this class.
 
void Parse (Pvl &pvlDef)
 Parse the DefFile for Standard Options.
 
virtual Pvl & GetLogPvl (void)
 Get the Pvl Log file.
 
virtual void FindCnetRef (ControlNet &pNewNet)
 Virtual Function to get better references for a Control Network based on Criteria.
 
bool ValidEmissionAngle (double pdEmissionAngle)
 Validate whether the Emission Angle is in the set Range.
 
bool ValidIncidenceAngle (double pdIncidenceAngle)
 Validate whether the Incidence Angle is in the set Range.
 
bool ValidDnValue (double pdDnValue)
 Validate whether the DN Value is in the set Range.
 
bool ValidResolution (double pdResolution)
 Validate whether the Resolution is in the set Range.
 
bool ValidResidualTolerances (double pdSampleResidual, double pdLineResidual, double pdResidualMagnitude, MeasureValidationResults &pResults)
 Validate whether the Residuals are within the set Tolerance.
 
bool ValidShiftTolerances (double sampleShift, double lineShift, double pixelShift, MeasureValidationResults &results)
 Validate whether the Sample and Line Shifts and Pixel Shift are within the set Tolerances.
 
bool ValidLatLon (Isis::Camera *pCamera, int piSample, int piLine)
 Validate the Lat/Lon.
 
PvlGroup & GetStdOptions (void)
 Get the Standard Options Pvl Group.
 
PvlGroup & GetStatistics (void)
 Get the Statistics Pvl Grp.
 
double GetMinDN (void)
 Get the option MinDN.
 
double GetMaxDN (void)
 Get the option MaxDN.
 
double GetMinEmissionAngle (void)
 Get the option MinEmissionAngle.
 
double GetMaxEmissionAngle (void)
 Get the option MaxEmissionAngle.
 
double GetMinIncidenceAngle (void)
 Get the option MinIncidenceAngle.
 
double GetMaxIncidenceAngle (void)
 Get the option MaxIncidenceAngle.
 
double GetPixelsFromEdge (void)
 Get the option PixelsFromEdge.
 
double GetMetersFromEdge (void)
 Get the option MetersFromEdge.
 
QString LocationString (double pdSample, double pdLine) const
 API to display location in the form "Sample,Line".
 
bool PixelsFromEdge (int piSample, int piLine, Cube *pCube)
 Test for a point to be user defined number of pixels from the edge.
 
bool MetersFromEdge (int piSample, int piLine, Cube *pCube)
 Test for a point to be user defined number of meters from the edge.
 
MeasureValidationResults ValidStandardOptions (const ControlMeasure *pMeasure, Cube *pCube, PvlGroup *pMeasureGrp=NULL)
 Validate Standard options to pick a reference based on a particular criteria.
 
MeasureValidationResults ValidStandardOptions (const ControlMeasure *pMeasure, Cube *pCube, Camera *camera, PvlGroup *pMeasureGrp=NULL)
 Validate Standard options to pick a reference based on a particular criteria.
 
MeasureValidationResults ValidStandardOptions (double pSample, double pLine, const ControlMeasure *pMeasure, Cube *pCube, PvlGroup *pMeasureGrp=NULL)
 Validate Standard options to pick a reference based on a particular criteria.
 
MeasureValidationResults ValidStandardOptions (double pSample, double pLine, const ControlMeasure *pMeasure, Cube *pCube, Camera *measureCamera, PvlGroup *pMeasureGrp=NULL)
 
MeasureValidationResults ValidStandardOptions (double pSample, double pLine, Cube *pCube, PvlGroup *pMeasureGrp=NULL)
 Validate Standard options to pick a reference based on a particular criteria.
 
bool IsCubeRequired ()
 
bool IsCameraRequired ()
 API to get status of CameraRequired flag.
 

Protected Member Functions

void ValidatePvlDN (void)
 Validate PVL Min & Max DN Standard Options.
 
void ValidatePvlEmissionAngle (void)
 Validate PVL Min & Max EmissionAngle Standard Options.
 
void ValidatePvlIncidenceAngle (void)
 Validate PVL Min & Max IncidenceAngle Standard Options.
 
void ValidatePvlResolution (void)
 Validate PVL Min & Max Resolution Standard Options.
 
void ValidatePvlFromEdge (void)
 Validate and read Pixels and Meters from Edge Standard Options.
 
void ValidatePvlResidualTolerances (void)
 Validate Pvl Sample, Line, Residual Magnitude Tolerances.
 
void ValidatePvlShiftTolerances ()
 Validate Pvl Sample, Line, Pixel (Sample and Line) Magnitude Shift Tolerances.
 
void ReadSerialNumbers (QString psSerialNumfile)
 Read the Serial Numbers from the file and open assocaited cubes.
 
void SetCameraRequiredFlag (bool pbFlag)
 Set the CameraRequired Flag.
 

Protected Attributes

double mdMinDN
 Standard Option MinDN.
 
double mdMaxDN
 Standard Option MaxDN.
 
double mdMinResolution
 Standard Option MinResolution.
 
double mdMaxResolution
 Standard Option MaxResolution.
 
double mdMinEmissionAngle
 Standard Option MinEmissionAngle.
 
double mdMaxEmissionAngle
 Standard Option MaxEmissionAngle.
 
double mdMinIncidenceAngle
 Standard Option MinIncidenceAngle.
 
double mdMaxIncidenceAngle
 Standard Option MaxIncidenceAngle.
 
double mdMetersFromEdge
 Standard Option MeteresFromEdge.
 
int miPixelsFromEdge
 Standard Option PixelsFromEdge.
 
double mdSampleResTolerance
 Standard Option Sample Residual.
 
double mdLineResTolerance
 Standard Option Line Residual.
 
double mdResidualTolerance
 Standard Option Residual Magnitude.
 
double m_sampleShiftTolerance
 Standard Option Sample Shift.
 
double m_lineShiftTolerance
 Standard Option Line Shift.
 
double m_pixelShiftTolerance
 Standard Option Pixel Shift.
 
double mdEmissionAngle
 Store current Measure's Emission Angle.
 
double mdIncidenceAngle
 Store current Measure's Incidence Angle.
 
double mdResolution
 Store current Measure's Resolution.
 
double mdDnValue
 Store current Measure's DN Value.
 
double mdSampleResidual
 Store current Measure's Sample Residual.
 
double mdLineResidual
 Store current Measure's Line Residual.
 
double mdResidualMagnitude
 Store current Measure's Residual Magnitude.
 
double m_sampleShift
 Store current Measure's Sample Shift.
 
double m_lineShift
 Store current Measure's Line Shift.
 
double m_pixelShift
 Store current Measure's Pixel Shift.
 
PvlGroup mPvlOpGrp
 Pvl Operator Group.
 
PvlGroup mStdOptionsGrp
 Pvl Standard Options Group.
 
PvlGroup mStatisticsGrp
 Pvl output Statistics Group.
 
Pvl mPvlLog
 Pvl Log of all the processing.
 
Progress mStatus
 Monitor the status of the app.
 
CubeManager mCubeMgr
 CubeManager to open and read cubes.
 
SerialNumberList mSerialNumbers
 Serial numbers list.
 
bool mbCameraRequired
 To improve speed, flag to indicate if Camera needs to be opened.
 
bool mbValidateDN
 Check if DN needs to be Validated.
 
bool mbValidateFromEdge
 Check if Pixels/Meters from edge needs to be Validated.
 

Detailed Description

ControlNetValidMeasure class.

Base class to validate all the common Control Network options specific to Control Network applications.

See also
cnetref autoseed etc.
Author
2010-05-11 Sharmila Prasad
History

2010-05-11 Sharmila Prasad - Original Version

2010-06-21 Sharmila Prasad - Remove references to UniversalGroundMap & Cubes use CubeManager instead

2010-06-23 Sharmila Prasad - Added Pixels/Meters from the edge options and Validate Standard Options

2010-09-16 Sharmila Prasad - Renamed to ControlNetValidMeasure for uniformity with other ControlNet Classes

2010-10-14 Sharmila Prasad - Use only a single copy of Control Net

2010-11-10 Sharmila Prasad - Change group name of DefFile from "Operator" to "ValidMeasure"

2011-05-17 Sharmila Prasad - Added Sample, Line Residuals and Residual Magnitude for validation

2011-05-19 Sharmila Prasad - Flag to indicate whether Camera is required, to increase the processing speed

2011-06-06 Sharmila Prasad - Process the options only is specified in the DefFile to improve run time

2011-11-21 Sharmila Prasad - Validate/Parse Pvl only if ValidMeasure Group is found. Fixes Mantis #584

2013-01-31 Steven Lambright - Fixed LocationString() to return valid text. Also, added a test for this text. Fixes #1436.

2014-03-03 Janet Barrett - Initialize the mdDnValue variable in the ValidStandardOptions method. Fixes #2040.

2016-07-13 Adam Paquette - Updated ValidStandardOptions to only get the EmissionAngle, IncidenceAngle, and PixelResolution if an image was properly set.

Definition at line 75 of file ControlNetValidMeasure.h.

Constructor & Destructor Documentation

◆ ControlNetValidMeasure() [1/2]

Isis::ControlNetValidMeasure::ControlNetValidMeasure ( Pvl * pPvl = 0)

Constructor - Initializes the data members and parses the input Pvl .

The Pvl Def File is optional.

Author
Sharmila Prasad (5/13/2010)
Parameters
pPvl- Pvl DefFile

Definition at line 29 of file ControlNetValidMeasure.cpp.

References InitStdOptions(), InitStdOptionsGroup(), mStatisticsGrp, and Parse().

◆ ControlNetValidMeasure() [2/2]

Isis::ControlNetValidMeasure::ControlNetValidMeasure ( Pvl & pPvl)

Constructor with a reference to Pvl Def file.

Used for Interest Operator where Def File is a requirement

Author
Sharmila Prasad (6/8/2010)
Parameters
pPvl- Pvl DefFile

Definition at line 49 of file ControlNetValidMeasure.cpp.

References InitStdOptions(), InitStdOptionsGroup(), mStatisticsGrp, and Parse().

◆ ~ControlNetValidMeasure()

Isis::ControlNetValidMeasure::~ControlNetValidMeasure ( )
virtual

Destructor: clean up stuff relevant for this class.

Author
Sharmila Prasad (6/3/2010)

Definition at line 124 of file ControlNetValidMeasure.cpp.

References Isis::CubeManager::CleanCubes(), and mCubeMgr.

Member Function Documentation

◆ FindCnetRef()

virtual void Isis::ControlNetValidMeasure::FindCnetRef ( ControlNet & pNewNet)
inlinevirtual

Virtual Function to get better references for a Control Network based on Criteria.

Reimplemented in Isis::InterestOperator.

Definition at line 97 of file ControlNetValidMeasure.h.

◆ GetLogPvl()

virtual Pvl & Isis::ControlNetValidMeasure::GetLogPvl ( void )
inlinevirtual

Get the Pvl Log file.

Definition at line 92 of file ControlNetValidMeasure.h.

References mPvlLog.

◆ GetMaxDN()

double Isis::ControlNetValidMeasure::GetMaxDN ( void )
inline

Get the option MaxDN.

Definition at line 137 of file ControlNetValidMeasure.h.

References mdMaxDN.

◆ GetMaxEmissionAngle()

double Isis::ControlNetValidMeasure::GetMaxEmissionAngle ( void )
inline

Get the option MaxEmissionAngle.

Definition at line 147 of file ControlNetValidMeasure.h.

References mdMaxEmissionAngle.

◆ GetMaxIncidenceAngle()

double Isis::ControlNetValidMeasure::GetMaxIncidenceAngle ( void )
inline

Get the option MaxIncidenceAngle.

Definition at line 157 of file ControlNetValidMeasure.h.

References mdMaxIncidenceAngle.

◆ GetMetersFromEdge()

double Isis::ControlNetValidMeasure::GetMetersFromEdge ( void )
inline

Get the option MetersFromEdge.

Definition at line 167 of file ControlNetValidMeasure.h.

References mdMetersFromEdge.

◆ GetMinDN()

double Isis::ControlNetValidMeasure::GetMinDN ( void )
inline

Get the option MinDN.

Definition at line 132 of file ControlNetValidMeasure.h.

References mdMinDN.

◆ GetMinEmissionAngle()

double Isis::ControlNetValidMeasure::GetMinEmissionAngle ( void )
inline

Get the option MinEmissionAngle.

Definition at line 142 of file ControlNetValidMeasure.h.

References mdMinEmissionAngle.

◆ GetMinIncidenceAngle()

double Isis::ControlNetValidMeasure::GetMinIncidenceAngle ( void )
inline

Get the option MinIncidenceAngle.

Definition at line 152 of file ControlNetValidMeasure.h.

References mdMinIncidenceAngle.

◆ GetPixelsFromEdge()

double Isis::ControlNetValidMeasure::GetPixelsFromEdge ( void )
inline

Get the option PixelsFromEdge.

Definition at line 162 of file ControlNetValidMeasure.h.

References miPixelsFromEdge.

◆ GetStatistics()

PvlGroup & Isis::ControlNetValidMeasure::GetStatistics ( void )
inline

Get the Statistics Pvl Grp.

Definition at line 127 of file ControlNetValidMeasure.h.

References mStatisticsGrp.

◆ GetStdOptions()

PvlGroup & Isis::ControlNetValidMeasure::GetStdOptions ( void )
inline

Get the Standard Options Pvl Group.

Definition at line 122 of file ControlNetValidMeasure.h.

References mStdOptionsGrp.

◆ InitStdOptions()

void Isis::ControlNetValidMeasure::InitStdOptions ( void )

Initialize the Standard Options.

Init all the standard options to default.

Author
Sharmila Prasad (6/8/2010)

Definition at line 66 of file ControlNetValidMeasure.cpp.

References m_lineShiftTolerance, m_pixelShiftTolerance, m_sampleShiftTolerance, mbCameraRequired, mbValidateDN, mbValidateFromEdge, mdLineResTolerance, mdMaxDN, mdMaxEmissionAngle, mdMaxIncidenceAngle, mdMaxResolution, mdMetersFromEdge, mdMinDN, mdMinEmissionAngle, mdMinIncidenceAngle, mdMinResolution, mdResidualTolerance, mdSampleResTolerance, miPixelsFromEdge, Isis::ValidMaximum, and Isis::ValidMinimum.

Referenced by ControlNetValidMeasure(), and ControlNetValidMeasure().

◆ InitStdOptionsGroup()

void Isis::ControlNetValidMeasure::InitStdOptionsGroup ( void )

Initialize the Standard Options Pvl Group with no DefFile.

Set the Standard Options group for logging.

Author
Sharmila Prasad (6/8/2010)

Definition at line 95 of file ControlNetValidMeasure.cpp.

References m_lineShiftTolerance, m_pixelShiftTolerance, m_sampleShiftTolerance, mdLineResTolerance, mdMaxDN, mdMaxEmissionAngle, mdMaxIncidenceAngle, mdMaxResolution, mdMetersFromEdge, mdMinDN, mdMinEmissionAngle, mdMinIncidenceAngle, mdMinResolution, mdResidualTolerance, mdSampleResTolerance, miPixelsFromEdge, mStdOptionsGrp, Isis::toString(), Isis::ValidMaximum, and Isis::ValidMinimum.

Referenced by ControlNetValidMeasure(), and ControlNetValidMeasure().

◆ IsCameraRequired()

bool Isis::ControlNetValidMeasure::IsCameraRequired ( )
inline

API to get status of CameraRequired flag.

Author
Sharmila Prasad (5/19/2011)
Returns
bool

Definition at line 213 of file ControlNetValidMeasure.h.

References mbCameraRequired.

◆ IsCubeRequired()

bool Isis::ControlNetValidMeasure::IsCubeRequired ( )
inline

Definition at line 202 of file ControlNetValidMeasure.h.

◆ LocationString()

QString Isis::ControlNetValidMeasure::LocationString ( double pdSample,
double pdLine ) const
inline

API to display location in the form "Sample,Line".

Definition at line 172 of file ControlNetValidMeasure.h.

References Isis::toString().

Referenced by Isis::InterestOperator::FindCnetRef(), and Isis::InterestOperator::ProcessLocked_Point_Reference().

◆ MetersFromEdge()

bool Isis::ControlNetValidMeasure::MetersFromEdge ( int piSample,
int piLine,
Cube * pCube )

Test for a point to be user defined number of meters from the edge.

Validate if a point in Measure is user defined number of meters from the edge.

Author
Sharmila Prasad (6/21/2010)
Parameters
piSample- Point Sample Location
piLine- Point Line Location
pCube- Control Measure Cube
Returns
bool

Definition at line 866 of file ControlNetValidMeasure.cpp.

References mdMetersFromEdge, Isis::Camera::PixelResolution(), Isis::Camera::SetImage(), and Isis::IException::User.

◆ Parse()

void Isis::ControlNetValidMeasure::Parse ( Pvl & pvlDef)

Parse the DefFile for Standard Options.

Virtual member that parses the common Cnet Options and checks for their validity.

Author
Sharmila Prasad (5/13/2010)
Parameters
pvlDef- Pvl DefFile

Definition at line 150 of file ControlNetValidMeasure.cpp.

References mPvlLog, mPvlOpGrp, mStdOptionsGrp, Isis::PvlObject::Traverse, ValidatePvlDN(), ValidatePvlEmissionAngle(), ValidatePvlFromEdge(), ValidatePvlIncidenceAngle(), ValidatePvlResidualTolerances(), ValidatePvlResolution(), and ValidatePvlShiftTolerances().

Referenced by ControlNetValidMeasure(), and ControlNetValidMeasure().

◆ PixelsFromEdge()

bool Isis::ControlNetValidMeasure::PixelsFromEdge ( int piSample,
int piLine,
Cube * pCube )

Test for a point to be user defined number of pixels from the edge.

Validate if a point in Measure is user defined number of pixels from the edge.

Author
Sharmila Prasad (6/21/2010)
Parameters
piSample- Point Sample Location
piLine- Point Line Location
pCube- Control Measure Cube
Returns
bool

Definition at line 824 of file ControlNetValidMeasure.cpp.

References miPixelsFromEdge.

◆ ReadSerialNumbers()

void Isis::ControlNetValidMeasure::ReadSerialNumbers ( QString psSerialNumfile)
protected

Read the Serial Numbers from the file and open assocaited cubes.

Read Serial Numbers from specified file and populate the Cube and UniversalGround Maps using the serial numbers.

Author
Sharmila Prasad (6/3/2010)
Parameters
psSerialNumfile- File with list of Serial Numbers

Definition at line 136 of file ControlNetValidMeasure.cpp.

References mCubeMgr, mSerialNumbers, mStatus, and Isis::CubeManager::SetNumOpenCubes().

Referenced by Isis::InterestOperator::Operate().

◆ SetCameraRequiredFlag()

void Isis::ControlNetValidMeasure::SetCameraRequiredFlag ( bool pbFlag)
inlineprotected

Set the CameraRequired Flag.

This flag indicates whether a camera is required to Validate a Control Measure. Camera is required to get Emission, Incidence angles and Resolution

Author
Sharmila Prasad (5/19/2011)
Parameters
pbFlag

Definition at line 250 of file ControlNetValidMeasure.h.

References mbCameraRequired.

◆ ValidatePvlDN()

void Isis::ControlNetValidMeasure::ValidatePvlDN ( void )
protected

Validate PVL Min & Max DN Standard Options.

Validate the Min and Max Dn Values set by the user in the Operator pvl file.

If not set then set the options to default and enter their names in the Unused Group. If the user set values are invalid then exception is thrown.

Author
Sharmila Prasad (5/10/2010)

Definition at line 464 of file ControlNetValidMeasure.cpp.

References Isis::PvlContainer::hasKeyword(), mbValidateDN, mdMaxDN, mdMinDN, mPvlOpGrp, mStdOptionsGrp, Isis::toString(), Isis::IException::User, Isis::ValidMaximum, and Isis::ValidMinimum.

Referenced by Parse().

◆ ValidatePvlEmissionAngle()

void Isis::ControlNetValidMeasure::ValidatePvlEmissionAngle ( void )
protected

Validate PVL Min & Max EmissionAngle Standard Options.

ValidateEmissionAngle: Validate the Min and Max Emission Values set by the user in the Operator pvl file.

If not set then set the options to default and enter their names in the Unused Group. If the user set values are invalid then exception is thrown, the valid range being [0-135]

Author
Sharmila Prasad (5/10/2010)

Definition at line 497 of file ControlNetValidMeasure.cpp.

References Isis::PvlContainer::hasKeyword(), mbCameraRequired, mdMaxEmissionAngle, mdMinEmissionAngle, mPvlOpGrp, mStdOptionsGrp, Isis::toString(), and Isis::IException::User.

Referenced by Parse().

◆ ValidatePvlFromEdge()

void Isis::ControlNetValidMeasure::ValidatePvlFromEdge ( void )
protected

Validate and read Pixels and Meters from Edge Standard Options.

Validate and Read the Pixels and Meters from Edge Standard Options.

Author
Sharmila Prasad (6/22/2010)

Definition at line 394 of file ControlNetValidMeasure.cpp.

References Isis::PvlContainer::hasKeyword(), mbValidateFromEdge, mdMetersFromEdge, miPixelsFromEdge, mPvlOpGrp, mStdOptionsGrp, and Isis::toString().

Referenced by Parse().

◆ ValidatePvlIncidenceAngle()

void Isis::ControlNetValidMeasure::ValidatePvlIncidenceAngle ( void )
protected

Validate PVL Min & Max IncidenceAngle Standard Options.

ValidateIncidenceAngle: Validate the Min and Max Incidence Values set by the user in the Operator pvl file.

If not set then set the options to default and enter their names in the Unused Group. If the user set values are invalid then exception is thrown, the valid range being [0-135]

Author
Sharmila Prasad (5/10/2010)

Definition at line 533 of file ControlNetValidMeasure.cpp.

References Isis::PvlContainer::hasKeyword(), mbCameraRequired, mdMaxIncidenceAngle, mdMinIncidenceAngle, mPvlOpGrp, mStdOptionsGrp, Isis::toString(), and Isis::IException::User.

Referenced by Parse().

◆ ValidatePvlResidualTolerances()

void Isis::ControlNetValidMeasure::ValidatePvlResidualTolerances ( void )
protected

Validate Pvl Sample, Line, Residual Magnitude Tolerances.

Author
Sharmila Prasad (5/16/2011)

Definition at line 565 of file ControlNetValidMeasure.cpp.

References Isis::PvlContainer::hasKeyword(), mdLineResTolerance, mdResidualTolerance, mdSampleResTolerance, mPvlOpGrp, mStdOptionsGrp, Isis::toString(), and Isis::IException::User.

Referenced by Parse().

◆ ValidatePvlResolution()

void Isis::ControlNetValidMeasure::ValidatePvlResolution ( void )
protected

Validate PVL Min & Max Resolution Standard Options.

Validate the Min and Max Resolution Values set by the user in the Operator pvl file.

If not set then set the options to default and enter their names in the Unused Group. If the user set values are invalid then exception is thrown.

Author
Sharmila Prasad (6/4/2010)

Definition at line 426 of file ControlNetValidMeasure.cpp.

References Isis::PvlContainer::hasKeyword(), mbCameraRequired, mdMaxResolution, mdMinResolution, mPvlOpGrp, mStdOptionsGrp, Isis::toString(), and Isis::IException::User.

Referenced by Parse().

◆ ValidatePvlShiftTolerances()

void Isis::ControlNetValidMeasure::ValidatePvlShiftTolerances ( )
protected

Validate Pvl Sample, Line, Pixel (Sample and Line) Magnitude Shift Tolerances.

Definition at line 610 of file ControlNetValidMeasure.cpp.

References Isis::PvlContainer::hasKeyword(), m_lineShiftTolerance, m_pixelShiftTolerance, m_sampleShiftTolerance, mPvlOpGrp, mStdOptionsGrp, Isis::toString(), and Isis::IException::User.

Referenced by Parse().

◆ ValidDnValue()

bool Isis::ControlNetValidMeasure::ValidDnValue ( double pdDnValue)

Validate whether the DN Value is in the set Range.

Validates Dn Value by comparing against the Min and Max DN Values set in the def file or the defaults.

Author
Sharmila Prasad (3/30/2010)
Parameters
pdDnValue- DN Value to Valdiate
Returns
bool

Definition at line 701 of file ControlNetValidMeasure.cpp.

References Isis::IsSpecial(), and mdMaxDN.

Referenced by Isis::GradientOperator::Interest(), and Isis::MoravecOperator::Interest().

◆ ValidEmissionAngle()

bool Isis::ControlNetValidMeasure::ValidEmissionAngle ( double pdEmissionAngle)

Validate whether the Emission Angle is in the set Range.

Validates an Emission angle by comparing with the min and max values in the def file.

If Emission Angle is greater or lesser than the max/min values in the def file or the defaults it returns false else true.

Author
Sharmila Prasad (3/30/2010)
Parameters
pdEmissionAngle- Emission Angle to Valdiate
Returns
bool

Definition at line 666 of file ControlNetValidMeasure.cpp.

References mdMaxEmissionAngle.

◆ ValidIncidenceAngle()

bool Isis::ControlNetValidMeasure::ValidIncidenceAngle ( double pdIncidenceAngle)

Validate whether the Incidence Angle is in the set Range.

Validates an Incidence angle by comparing with the min and max values in the def file.

If Incidence Angle is greater or lesser than the max/min values in the def file or the defaults it returns false else true.

Author
Sharmila Prasad (5/10/2010)
Parameters
pdIncidenceAngle- Incidence Angle to Valdiate
Returns
bool

Definition at line 684 of file ControlNetValidMeasure.cpp.

References mdMaxIncidenceAngle.

◆ ValidLatLon()

bool Isis::ControlNetValidMeasure::ValidLatLon ( Isis::Camera * pCamera,
int piSample,
int piLine )

Validate the Lat/Lon.

Validate if a point has a valid lat, lon for that camera.

Author
Sharmila Prasad (6/4/2010)
Parameters
pCamera
piSample
piLine
Returns
bool

Definition at line 809 of file ControlNetValidMeasure.cpp.

◆ ValidResidualTolerances()

bool Isis::ControlNetValidMeasure::ValidResidualTolerances ( double pdSampleResidual,
double pdLineResidual,
double pdResidualMagnitude,
MeasureValidationResults & pResults )

Validate whether the Residuals are within the set Tolerance.

Validate whether the Sample and Line Residuals and Residual Magnitudes are within the set Tolerances'.

Author
Sharmila Prasad (5/16/2011)
Parameters
pdSampleResidual- Measure's Sample residual
pdLineResidual- Measure's Line residual
pdResidualMagnitude- Measure's Residual Magnitude
pResults- MeasureValidationResults
Returns
bool - Valid (true/false)

Definition at line 739 of file ControlNetValidMeasure.cpp.

References mdLineResTolerance, mdResidualTolerance, and mdSampleResTolerance.

◆ ValidResolution()

bool Isis::ControlNetValidMeasure::ValidResolution ( double pdResolution)

Validate whether the Resolution is in the set Range.

Validates Dn Value by comparing against the Min and Max DN Values set in the def file or the defaults.

Author
Sharmila Prasad (6/4/2010)
Parameters
pdResolution- Resolution to Validate
Returns
bool

Definition at line 718 of file ControlNetValidMeasure.cpp.

References mdMaxResolution.

◆ ValidShiftTolerances()

bool Isis::ControlNetValidMeasure::ValidShiftTolerances ( double sampleShift,
double lineShift,
double pixelShift,
MeasureValidationResults & results )

Validate whether the Sample and Line Shifts and Pixel Shift are within the set Tolerances.

Parameters
sampleShiftMeasure's sample shift (current - apriori)
lineShiftMeasure's line shift (current - apriori)
pixelShiftMeasure's pixel shift (Euclidean distance shifted)
resultsValidation results populated with any new failures
Returns
Whether every test was valid or not

Definition at line 772 of file ControlNetValidMeasure.cpp.

References m_lineShiftTolerance, m_pixelShiftTolerance, and m_sampleShiftTolerance.

◆ ValidStandardOptions() [1/5]

MeasureValidationResults Isis::ControlNetValidMeasure::ValidStandardOptions ( const ControlMeasure * pMeasure,
Cube * pCube,
Camera * camera,
PvlGroup * pMeasureGrp = NULL )

Validate Standard options to pick a reference based on a particular criteria.

Definition at line 376 of file ControlNetValidMeasure.cpp.

References ValidStandardOptions().

◆ ValidStandardOptions() [2/5]

MeasureValidationResults Isis::ControlNetValidMeasure::ValidStandardOptions ( const ControlMeasure * pMeasure,
Cube * pCube,
PvlGroup * pMeasureGrp = NULL )

Validate Standard options to pick a reference based on a particular criteria.

Validate a measure for all the Standard Options.

Author
Sharmila Prasad (6/22/2010)
Parameters
piSample- Point Sample location
piLine- Point Line location
pCube- Control Measure Cube
pMeasureGrp- Log PvlGroup
Returns
bool

Definition at line 365 of file ControlNetValidMeasure.cpp.

References ValidStandardOptions().

Referenced by Isis::InterestOperator::FindCnetRef(), Isis::InterestOperator::InterestByMeasure(), Isis::InterestOperator::Operate(), Isis::InterestOperator::ProcessLocked_Point_Reference(), ValidStandardOptions(), ValidStandardOptions(), ValidStandardOptions(), and ValidStandardOptions().

◆ ValidStandardOptions() [3/5]

MeasureValidationResults Isis::ControlNetValidMeasure::ValidStandardOptions ( double pSample,
double pLine,
const ControlMeasure * pMeasure,
Cube * pCube,
Camera * measureCamera,
PvlGroup * pMeasureGrp = NULL )

Definition at line 200 of file ControlNetValidMeasure.cpp.

◆ ValidStandardOptions() [4/5]

MeasureValidationResults Isis::ControlNetValidMeasure::ValidStandardOptions ( double pSample,
double pLine,
const ControlMeasure * pMeasure,
Cube * pCube,
PvlGroup * pMeasureGrp = NULL )

Validate Standard options to pick a reference based on a particular criteria.

Validate a point on an image and the Control Measure if not Null.

Author
Sharmila Prasad (5/17/2011)
Parameters
pSample- Image Sample
pLine- Image Line
pMeasure- Control Measure
pCube- Control Measure's image
pMeasureGrp- Result PvlGroup
Returns
MeasureValidationResults

Definition at line 179 of file ControlNetValidMeasure.cpp.

References mbCameraRequired, Isis::IException::User, and ValidStandardOptions().

◆ ValidStandardOptions() [5/5]

MeasureValidationResults Isis::ControlNetValidMeasure::ValidStandardOptions ( double pSample,
double pLine,
Cube * pCube,
PvlGroup * pMeasureGrp = NULL )

Validate Standard options to pick a reference based on a particular criteria.

Validate a point on an image for Standard Options.

Author
Sharmila Prasad (5/17/2011)
Parameters
pSample- Image Sample
pLine- Image Line
pCube- Image
pMeasureGrp- Optional Result Group
Returns
MeasureValidationResults

Definition at line 345 of file ControlNetValidMeasure.cpp.

References ValidStandardOptions().

Member Data Documentation

◆ m_lineShift

double Isis::ControlNetValidMeasure::m_lineShift
protected

Store current Measure's Line Shift.

Definition at line 281 of file ControlNetValidMeasure.h.

◆ m_lineShiftTolerance

double Isis::ControlNetValidMeasure::m_lineShiftTolerance
protected

Standard Option Line Shift.

Definition at line 269 of file ControlNetValidMeasure.h.

Referenced by InitStdOptions(), InitStdOptionsGroup(), ValidatePvlShiftTolerances(), and ValidShiftTolerances().

◆ m_pixelShift

double Isis::ControlNetValidMeasure::m_pixelShift
protected

Store current Measure's Pixel Shift.

Definition at line 282 of file ControlNetValidMeasure.h.

◆ m_pixelShiftTolerance

double Isis::ControlNetValidMeasure::m_pixelShiftTolerance
protected

Standard Option Pixel Shift.

Definition at line 270 of file ControlNetValidMeasure.h.

Referenced by InitStdOptions(), InitStdOptionsGroup(), ValidatePvlShiftTolerances(), and ValidShiftTolerances().

◆ m_sampleShift

double Isis::ControlNetValidMeasure::m_sampleShift
protected

Store current Measure's Sample Shift.

Definition at line 280 of file ControlNetValidMeasure.h.

◆ m_sampleShiftTolerance

double Isis::ControlNetValidMeasure::m_sampleShiftTolerance
protected

Standard Option Sample Shift.

Definition at line 268 of file ControlNetValidMeasure.h.

Referenced by InitStdOptions(), InitStdOptionsGroup(), ValidatePvlShiftTolerances(), and ValidShiftTolerances().

◆ mbCameraRequired

bool Isis::ControlNetValidMeasure::mbCameraRequired
protected

To improve speed, flag to indicate if Camera needs to be opened.

Definition at line 292 of file ControlNetValidMeasure.h.

Referenced by InitStdOptions(), IsCameraRequired(), SetCameraRequiredFlag(), ValidatePvlEmissionAngle(), ValidatePvlIncidenceAngle(), ValidatePvlResolution(), and ValidStandardOptions().

◆ mbValidateDN

bool Isis::ControlNetValidMeasure::mbValidateDN
protected

Check if DN needs to be Validated.

Definition at line 294 of file ControlNetValidMeasure.h.

Referenced by InitStdOptions(), and ValidatePvlDN().

◆ mbValidateFromEdge

bool Isis::ControlNetValidMeasure::mbValidateFromEdge
protected

Check if Pixels/Meters from edge needs to be Validated.

Definition at line 295 of file ControlNetValidMeasure.h.

Referenced by InitStdOptions(), and ValidatePvlFromEdge().

◆ mCubeMgr

CubeManager Isis::ControlNetValidMeasure::mCubeMgr
protected

CubeManager to open and read cubes.

Definition at line 289 of file ControlNetValidMeasure.h.

Referenced by Isis::InterestOperator::FindCnetRef(), Isis::InterestOperator::FindOverlapByImageFootPrint(), Isis::InterestOperator::InterestByPoint(), Isis::InterestOperator::ProcessLocked_Point_Reference(), ReadSerialNumbers(), and ~ControlNetValidMeasure().

◆ mdDnValue

double Isis::ControlNetValidMeasure::mdDnValue
protected

Store current Measure's DN Value.

Definition at line 275 of file ControlNetValidMeasure.h.

Referenced by Isis::InterestOperator::InterestByMeasure().

◆ mdEmissionAngle

double Isis::ControlNetValidMeasure::mdEmissionAngle
protected

Store current Measure's Emission Angle.

Definition at line 272 of file ControlNetValidMeasure.h.

Referenced by Isis::InterestOperator::InterestByMeasure().

◆ mdIncidenceAngle

double Isis::ControlNetValidMeasure::mdIncidenceAngle
protected

Store current Measure's Incidence Angle.

Definition at line 273 of file ControlNetValidMeasure.h.

Referenced by Isis::InterestOperator::InterestByMeasure().

◆ mdLineResidual

double Isis::ControlNetValidMeasure::mdLineResidual
protected

Store current Measure's Line Residual.

Definition at line 277 of file ControlNetValidMeasure.h.

◆ mdLineResTolerance

double Isis::ControlNetValidMeasure::mdLineResTolerance
protected

Standard Option Line Residual.

Definition at line 265 of file ControlNetValidMeasure.h.

Referenced by InitStdOptions(), InitStdOptionsGroup(), ValidatePvlResidualTolerances(), and ValidResidualTolerances().

◆ mdMaxDN

double Isis::ControlNetValidMeasure::mdMaxDN
protected

Standard Option MaxDN.

Definition at line 255 of file ControlNetValidMeasure.h.

Referenced by GetMaxDN(), InitStdOptions(), InitStdOptionsGroup(), Isis::StandardDeviationOperator::Interest(), ValidatePvlDN(), and ValidDnValue().

◆ mdMaxEmissionAngle

double Isis::ControlNetValidMeasure::mdMaxEmissionAngle
protected

Standard Option MaxEmissionAngle.

Definition at line 259 of file ControlNetValidMeasure.h.

Referenced by GetMaxEmissionAngle(), InitStdOptions(), InitStdOptionsGroup(), ValidatePvlEmissionAngle(), and ValidEmissionAngle().

◆ mdMaxIncidenceAngle

double Isis::ControlNetValidMeasure::mdMaxIncidenceAngle
protected

Standard Option MaxIncidenceAngle.

Definition at line 261 of file ControlNetValidMeasure.h.

Referenced by GetMaxIncidenceAngle(), InitStdOptions(), InitStdOptionsGroup(), ValidatePvlIncidenceAngle(), and ValidIncidenceAngle().

◆ mdMaxResolution

double Isis::ControlNetValidMeasure::mdMaxResolution
protected

Standard Option MaxResolution.

Definition at line 257 of file ControlNetValidMeasure.h.

Referenced by InitStdOptions(), InitStdOptionsGroup(), ValidatePvlResolution(), and ValidResolution().

◆ mdMetersFromEdge

double Isis::ControlNetValidMeasure::mdMetersFromEdge
protected

Standard Option MeteresFromEdge.

Definition at line 262 of file ControlNetValidMeasure.h.

Referenced by GetMetersFromEdge(), InitStdOptions(), InitStdOptionsGroup(), MetersFromEdge(), and ValidatePvlFromEdge().

◆ mdMinDN

double Isis::ControlNetValidMeasure::mdMinDN
protected

Standard Option MinDN.

Definition at line 254 of file ControlNetValidMeasure.h.

Referenced by GetMinDN(), InitStdOptions(), InitStdOptionsGroup(), Isis::StandardDeviationOperator::Interest(), and ValidatePvlDN().

◆ mdMinEmissionAngle

double Isis::ControlNetValidMeasure::mdMinEmissionAngle
protected

Standard Option MinEmissionAngle.

Definition at line 258 of file ControlNetValidMeasure.h.

Referenced by GetMinEmissionAngle(), InitStdOptions(), InitStdOptionsGroup(), and ValidatePvlEmissionAngle().

◆ mdMinIncidenceAngle

double Isis::ControlNetValidMeasure::mdMinIncidenceAngle
protected

Standard Option MinIncidenceAngle.

Definition at line 260 of file ControlNetValidMeasure.h.

Referenced by GetMinIncidenceAngle(), InitStdOptions(), InitStdOptionsGroup(), and ValidatePvlIncidenceAngle().

◆ mdMinResolution

double Isis::ControlNetValidMeasure::mdMinResolution
protected

Standard Option MinResolution.

Definition at line 256 of file ControlNetValidMeasure.h.

Referenced by InitStdOptions(), InitStdOptionsGroup(), and ValidatePvlResolution().

◆ mdResidualMagnitude

double Isis::ControlNetValidMeasure::mdResidualMagnitude
protected

Store current Measure's Residual Magnitude.

Definition at line 278 of file ControlNetValidMeasure.h.

◆ mdResidualTolerance

double Isis::ControlNetValidMeasure::mdResidualTolerance
protected

Standard Option Residual Magnitude.

Definition at line 266 of file ControlNetValidMeasure.h.

Referenced by InitStdOptions(), InitStdOptionsGroup(), ValidatePvlResidualTolerances(), and ValidResidualTolerances().

◆ mdResolution

double Isis::ControlNetValidMeasure::mdResolution
protected

Store current Measure's Resolution.

Definition at line 274 of file ControlNetValidMeasure.h.

Referenced by Isis::InterestOperator::FindCnetRef(), and Isis::InterestOperator::InterestByMeasure().

◆ mdSampleResidual

double Isis::ControlNetValidMeasure::mdSampleResidual
protected

Store current Measure's Sample Residual.

Definition at line 276 of file ControlNetValidMeasure.h.

◆ mdSampleResTolerance

double Isis::ControlNetValidMeasure::mdSampleResTolerance
protected

Standard Option Sample Residual.

Definition at line 264 of file ControlNetValidMeasure.h.

Referenced by InitStdOptions(), InitStdOptionsGroup(), ValidatePvlResidualTolerances(), and ValidResidualTolerances().

◆ miPixelsFromEdge

int Isis::ControlNetValidMeasure::miPixelsFromEdge
protected

Standard Option PixelsFromEdge.

Definition at line 263 of file ControlNetValidMeasure.h.

Referenced by GetPixelsFromEdge(), InitStdOptions(), InitStdOptionsGroup(), PixelsFromEdge(), and ValidatePvlFromEdge().

◆ mPvlLog

Pvl Isis::ControlNetValidMeasure::mPvlLog
protected

Pvl Log of all the processing.

Definition at line 287 of file ControlNetValidMeasure.h.

Referenced by Isis::InterestOperator::FindCnetRef(), GetLogPvl(), and Parse().

◆ mPvlOpGrp

PvlGroup Isis::ControlNetValidMeasure::mPvlOpGrp
protected

Pvl Operator Group.

Definition at line 284 of file ControlNetValidMeasure.h.

Referenced by Parse(), ValidatePvlDN(), ValidatePvlEmissionAngle(), ValidatePvlFromEdge(), ValidatePvlIncidenceAngle(), ValidatePvlResidualTolerances(), ValidatePvlResolution(), and ValidatePvlShiftTolerances().

◆ mSerialNumbers

SerialNumberList Isis::ControlNetValidMeasure::mSerialNumbers
protected

Serial numbers list.

Definition at line 290 of file ControlNetValidMeasure.h.

Referenced by Isis::InterestOperator::FindCnetRef(), Isis::InterestOperator::FindOverlapByImageFootPrint(), Isis::InterestOperator::InterestByMeasure(), Isis::InterestOperator::InterestByPoint(), Isis::InterestOperator::ProcessLocked_Point_Reference(), and ReadSerialNumbers().

◆ mStatisticsGrp

PvlGroup Isis::ControlNetValidMeasure::mStatisticsGrp
protected

Pvl output Statistics Group.

Definition at line 286 of file ControlNetValidMeasure.h.

Referenced by ControlNetValidMeasure(), ControlNetValidMeasure(), Isis::InterestOperator::FindCnetRef(), and GetStatistics().

◆ mStatus

Progress Isis::ControlNetValidMeasure::mStatus
protected

Monitor the status of the app.

Definition at line 288 of file ControlNetValidMeasure.h.

Referenced by Isis::InterestOperator::FindCnetRef(), and ReadSerialNumbers().

◆ mStdOptionsGrp

PvlGroup Isis::ControlNetValidMeasure::mStdOptionsGrp
protected

Pvl Standard Options Group.

Definition at line 285 of file ControlNetValidMeasure.h.

Referenced by GetStdOptions(), InitStdOptionsGroup(), Parse(), ValidatePvlDN(), ValidatePvlEmissionAngle(), ValidatePvlFromEdge(), ValidatePvlIncidenceAngle(), ValidatePvlResidualTolerances(), ValidatePvlResolution(), and ValidatePvlShiftTolerances().

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