Isis 3.0 Developer's Reference (API) |
Home |
ControlNetValidMeasure class. More...
#include <ControlNetValidMeasure.h>
Inherited by Isis::InterestOperator.
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. | |
ControlNetValidMeasure class.
Base class to validate all the common Control Network options specific to Control Network applications.
Isis::ControlNetValidMeasure::ControlNetValidMeasure | ( | Pvl * | pPvl = 0 | ) |
Constructor - Initializes the data members and parses the input Pvl .
The Pvl Def File is optional.
pPvl | - Pvl DefFile |
References Isis::PvlObject::hasGroup().
Isis::ControlNetValidMeasure::ControlNetValidMeasure | ( | Pvl & | pPvl | ) |
Constructor with a reference to Pvl Def file.
Used for Interest Operator where Def File is a requirement
pPvl | - Pvl DefFile |
References Isis::PvlObject::hasGroup().
|
virtual |
Destructor: clean up stuff relevant for this class.
|
inlinevirtual |
Virtual Function to get better references for a Control Network based on Criteria.
Reimplemented in Isis::InterestOperator.
|
inlinevirtual |
|
inline |
Get the option MaxDN.
References mdMaxDN.
|
inline |
Get the option MaxEmissionAngle.
References mdMaxEmissionAngle.
|
inline |
Get the option MaxIncidenceAngle.
References mdMaxIncidenceAngle.
|
inline |
Get the option MetersFromEdge.
References mdMetersFromEdge.
|
inline |
Get the option MinDN.
References mdMinDN.
|
inline |
Get the option MinEmissionAngle.
References mdMinEmissionAngle.
|
inline |
Get the option MinIncidenceAngle.
References mdMinIncidenceAngle.
|
inline |
Get the option PixelsFromEdge.
References miPixelsFromEdge.
|
inline |
Get the Statistics Pvl Grp.
References mStatisticsGrp.
|
inline |
Get the Standard Options Pvl Group.
References mStdOptionsGrp.
void Isis::ControlNetValidMeasure::InitStdOptions | ( | void | ) |
Initialize the Standard Options.
Init all the standard options to default.
References Isis::ValidMaximum, and Isis::ValidMinimum.
void Isis::ControlNetValidMeasure::InitStdOptionsGroup | ( | void | ) |
Initialize the Standard Options Pvl Group with no DefFile.
Set the Standard Options group for logging.
References Isis::toString(), Isis::ValidMaximum, and Isis::ValidMinimum.
|
inline |
API to get status of CameraRequired flag.
References mbCameraRequired.
Referenced by IsCubeRequired().
|
inline |
References IsCameraRequired(), mbValidateDN, and mbValidateFromEdge.
|
inline |
API to display location in the form "Sample,Line".
References Isis::toString().
Referenced by Isis::InterestOperator::FindCnetRef(), and Isis::InterestOperator::ProcessLocked_Point_Reference().
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.
References _FILEINFO_, Isis::Cube::camera(), Isis::Cube::fileName(), Isis::Cube::lineCount(), Isis::Camera::PixelResolution(), Isis::Cube::sampleCount(), and Isis::Camera::SetImage().
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.
pvlDef | - Pvl DefFile |
References Isis::PvlObject::findGroup().
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.
References Isis::Cube::lineCount(), and Isis::Cube::sampleCount().
|
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.
psSerialNumfile | - File with list of Serial Numbers |
Referenced by Isis::InterestOperator::Operate().
|
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
pbFlag |
References mbCameraRequired.
|
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.
References _FILEINFO_, Isis::toString(), Isis::ValidMaximum, and Isis::ValidMinimum.
|
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]
References _FILEINFO_, and Isis::toString().
|
protected |
Validate and read Pixels and Meters from Edge Standard Options.
Validate and Read the Pixels and Meters from Edge Standard Options.
References Isis::toString().
|
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]
References _FILEINFO_, and Isis::toString().
|
protected |
Validate Pvl Sample, Line, Residual Magnitude Tolerances.
References _FILEINFO_, and Isis::toString().
|
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.
References _FILEINFO_, and Isis::toString().
|
protected |
Validate Pvl Sample, Line, Pixel (Sample and Line) Magnitude Shift Tolerances.
References _FILEINFO_, and Isis::toString().
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.
pdDnValue | - DN Value to Valdiate |
References Isis::IsSpecial().
Referenced by Isis::MoravecOperator::Interest(), and Isis::GradientOperator::Interest().
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.
pdEmissionAngle | - Emission Angle to Valdiate |
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.
pdIncidenceAngle | - Incidence Angle to Valdiate |
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.
pCamera | |
piSample | |
piLine |
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'.
pdSampleResidual | - Measure's Sample residual |
pdLineResidual | - Measure's Line residual |
pdResidualMagnitude | - Measure's Residual Magnitude |
pResults | - MeasureValidationResults |
References Isis::MeasureValidationResults::addFailure().
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.
pdResolution | - Resolution to Validate |
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.
sampleShift | Measure's sample shift (current - apriori) |
lineShift | Measure's line shift (current - apriori) |
pixelShift | Measure's pixel shift (Euclidean distance shifted) |
results | Validation results populated with any new failures |
References Isis::MeasureValidationResults::addFailure().
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.
piSample | - Point Sample location |
piLine | - Point Line location |
pCube | - Control Measure Cube |
pMeasureGrp | - Log PvlGroup |
References Isis::ControlMeasure::GetLine(), and Isis::ControlMeasure::GetSample().
Referenced by Isis::InterestOperator::FindCnetRef(), Isis::InterestOperator::InterestByMeasure(), Isis::InterestOperator::Operate(), and Isis::InterestOperator::ProcessLocked_Point_Reference().
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.
References Isis::ControlMeasure::GetLine(), and Isis::ControlMeasure::GetSample().
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.
pSample | - Image Sample |
pLine | - Image Line |
pMeasure | - Control Measure |
pCube | - Control Measure's image |
pMeasureGrp | - Result PvlGroup |
References _FILEINFO_, Isis::Cube::camera(), and Isis::Cube::fileName().
MeasureValidationResults Isis::ControlNetValidMeasure::ValidStandardOptions | ( | double | pSample, |
double | pLine, | ||
const ControlMeasure * | pMeasure, | ||
Cube * | pCube, | ||
Camera * | measureCamera, | ||
PvlGroup * | pMeasureGrp = NULL |
||
) |
References Isis::MeasureValidationResults::addFailure(), Isis::Sensor::EmissionAngle(), Isis::ControlMeasure::GetLineResidual(), Isis::ControlMeasure::GetLineShift(), Isis::ControlMeasure::GetPixelShift(), Isis::ControlMeasure::GetResidualMagnitude(), Isis::ControlMeasure::GetSampleResidual(), Isis::ControlMeasure::GetSampleShift(), Isis::Sensor::IncidenceAngle(), Isis::Null, Isis::Camera::PixelResolution(), Isis::Cube::pixelType(), Isis::Cube::read(), Isis::Camera::SetImage(), Isis::Portal::SetPosition(), and Isis::toString().
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.
|
protected |
Store current Measure's Line Shift.
|
protected |
Standard Option Line Shift.
|
protected |
Store current Measure's Pixel Shift.
|
protected |
Standard Option Pixel Shift.
|
protected |
Store current Measure's Sample Shift.
|
protected |
Standard Option Sample Shift.
|
protected |
To improve speed, flag to indicate if
< Camera needs to be opened
Referenced by IsCameraRequired(), and SetCameraRequiredFlag().
|
protected |
Check if DN needs to be Validated.
Referenced by IsCubeRequired().
|
protected |
Check if Pixels/Meters from edge needs to be Validated.
Referenced by IsCubeRequired().
|
protected |
CubeManager to open and read cubes.
Referenced by Isis::InterestOperator::FindCnetRef(), Isis::InterestOperator::InterestByPoint(), and Isis::InterestOperator::ProcessLocked_Point_Reference().
|
protected |
Store current Measure's DN Value.
Referenced by Isis::InterestOperator::InterestByMeasure().
|
protected |
Store current Measure's Emission Angle.
Referenced by Isis::InterestOperator::InterestByMeasure().
|
protected |
Store current Measure's Incidence Angle.
Referenced by Isis::InterestOperator::InterestByMeasure().
|
protected |
Store current Measure's Line Residual.
|
protected |
Standard Option Line Residual.
|
protected |
Standard Option MaxDN.
Referenced by GetMaxDN(), and Isis::StandardDeviationOperator::Interest().
|
protected |
Standard Option MaxEmissionAngle.
Referenced by GetMaxEmissionAngle().
|
protected |
Standard Option MaxIncidenceAngle.
Referenced by GetMaxIncidenceAngle().
|
protected |
Standard Option MaxResolution.
|
protected |
Standard Option MeteresFromEdge.
Referenced by GetMetersFromEdge().
|
protected |
Standard Option MinDN.
Referenced by GetMinDN(), and Isis::StandardDeviationOperator::Interest().
|
protected |
Standard Option MinEmissionAngle.
Referenced by GetMinEmissionAngle().
|
protected |
Standard Option MinIncidenceAngle.
Referenced by GetMinIncidenceAngle().
|
protected |
Standard Option MinResolution.
|
protected |
Store current Measure's Residual Magnitude.
|
protected |
Standard Option Residual Magnitude.
|
protected |
Store current Measure's Resolution.
Referenced by Isis::InterestOperator::FindCnetRef(), and Isis::InterestOperator::InterestByMeasure().
|
protected |
Store current Measure's Sample Residual.
|
protected |
Standard Option Sample Residual.
|
protected |
Standard Option PixelsFromEdge.
Referenced by GetPixelsFromEdge().
|
protected |
Pvl Log of all the processing.
Referenced by Isis::InterestOperator::FindCnetRef(), and GetLogPvl().
|
protected |
Serial numbers list.
Referenced by Isis::InterestOperator::FindCnetRef(), Isis::InterestOperator::InterestByMeasure(), Isis::InterestOperator::InterestByPoint(), and Isis::InterestOperator::ProcessLocked_Point_Reference().
|
protected |
Pvl output Statistics Group.
Referenced by Isis::InterestOperator::FindCnetRef(), and GetStatistics().
|
protected |
Monitor the status of the app.
Referenced by Isis::InterestOperator::FindCnetRef().
|
protected |
Pvl Standard Options Group.
Referenced by GetStdOptions().