 |
Isis Developer Reference
|
|
Isis Developer Reference
|
Statistical and similar ControlMeasure associated information. More...
#include <ControlMeasureLogData.h>
Public Types | |
| enum | NumericLogDataType { InvalidNumericLogDataType = 0 , Obsolete_Eccentricity = 1 , GoodnessOfFit = 2 , MinimumPixelZScore = 3 , MaximumPixelZScore = 4 , PixelShift = 5 , WholePixelCorrelation = 6 , SubPixelCorrelation = 7 , Obsolete_AverageResidual = 8 } |
| Please do not change existing values in this list except the size - it will break backwards compadibility. More... | |
Public Member Functions | |
| ControlMeasureLogData () | |
| This creates an empty, invalid (IsValid() will return false), instance. | |
| ControlMeasureLogData (NumericLogDataType dataType) | |
| This creates an instance with the given type but no value yet. | |
| ControlMeasureLogData (PvlKeyword keywordRep) | |
| This creates an instance while attempting to interpret keywordRep. | |
| ControlMeasureLogData (NumericLogDataType dataType, double value) | |
| This creates an instance with the given type and value for that type. | |
| ControlMeasureLogData (const ControlMeasureLogData &other) | |
| Copy constructor. | |
| ~ControlMeasureLogData () | |
| Destructor. | |
| void | SetNumericalValue (double value) |
| This updates the value associated with a NumericLogDataType. | |
| void | SetDataType (NumericLogDataType newDataType) |
| This changes the type of this log data. | |
| double | GetNumericalValue () const |
| Get the value associated with this log data. | |
| NumericLogDataType | GetDataType () const |
| Get the data type associated with this log data. | |
| QVariant | GetValue () const |
| Get the data type associated with this log data. | |
| bool | IsValid () const |
| This tests if the log data is complete and valid. | |
| PvlKeyword | ToKeyword () const |
| This converts the log data to a PvlKeyword. | |
| NumericLogDataType | NameToDataType (QString name) const |
| This converts a string to a log data type and is useful for converting Pvl keywords to Numeric Log Data Type. | |
| QString | DataTypeToName (NumericLogDataType type) const |
| This converts the log data type to a string and is used internally for convertions to and from Pvl. | |
Static Public Attributes | |
| static const int | MaximumNumericLogDataType = 9 |
| This value must be > the largest enumerated value in this type or convertions to and from Pvl will not work. | |
Statistical and similar ControlMeasure associated information.
This class represents information that is related to, or associated with, a control measure but is not part of the measure itself.
Please do not change existing values in this list except the size - it will break backwards compadibility.
This is the list of log data for control measures. To add a new element, put it in the list (anywhere), assign it a value one greater than the current maximum, and increase the maximum's value. Then add a case to ControlMeasureLogData::DataTypeToName. Once you've done that, you're done! :)
| Enumerator | |
|---|---|
| InvalidNumericLogDataType | This is a placeholder for unset values. |
| Obsolete_Eccentricity | Deprecated keyword kept for backwards compatability with older Control Networks. DO NOT USE!! |
| GoodnessOfFit | GoodnessOfFit is pointreg information for reference measures. This measures how well the computed fit area matches the pattern area. |
| MinimumPixelZScore | Control measures store z-scores in pairs. A pair contains the z-scores of the minimum and maximum pixels in the pattern chip generated for the given measure during point registration. Each z-score indicates how many standard deviations the given pixel value is above or below the mean DN. |
| MaximumPixelZScore |
|
| PixelShift | Deprecated keyword kept for backwards compatability with older Control Networks. DO NOT USE!! |
| WholePixelCorrelation | Deprecated keyword kept for backwards compatability with older Control Networks. DO NOT USE!! |
| SubPixelCorrelation | Deprecated keyword kept for backwards compatability with older Control Networks. DO NOT USE!! |
| Obsolete_AverageResidual | Deprecated keyword kept for backwards compatability with older Control Networks. DO NOT USE!! |
| Isis::ControlMeasureLogData::ControlMeasureLogData | ( | ) |
This creates an empty, invalid (IsValid() will return false), instance.
| Isis::ControlMeasureLogData::ControlMeasureLogData | ( | NumericLogDataType | dataType | ) |
This creates an instance with the given type but no value yet.
IsValid() will return false until a value is set.
| dataType | What the instance is describing (the field) |
| Isis::ControlMeasureLogData::ControlMeasureLogData | ( | PvlKeyword | keywordRep | ) |
This creates an instance while attempting to interpret keywordRep.
On failure, the IsValid() test will return false.
| keywordRep | The PvlKeyword representing log data |
References InvalidNumericLogDataType, NameToDataType(), and Isis::toDouble().
| Isis::ControlMeasureLogData::ControlMeasureLogData | ( | NumericLogDataType | dataType, |
| double | value ) |
This creates an instance with the given type and value for that type.
| dataType | What the value is describing (the field) |
| value | The numerical value of this field |
| Isis::ControlMeasureLogData::ControlMeasureLogData | ( | const ControlMeasureLogData & | other | ) |
Copy constructor.
| other | The instance to copy into this one. |
| Isis::ControlMeasureLogData::~ControlMeasureLogData | ( | ) |
Destructor.
This frees allocated memory by the instance of this class.
| QString Isis::ControlMeasureLogData::DataTypeToName | ( | NumericLogDataType | type | ) | const |
This converts the log data type to a string and is used internally for convertions to and from Pvl.
This is also useful for GUI programs that need to display log information.
| type | The data type to convert to a string |
References _FILEINFO_, GoodnessOfFit, InvalidNumericLogDataType, MaximumPixelZScore, MinimumPixelZScore, Obsolete_AverageResidual, Obsolete_Eccentricity, PixelShift, Isis::IException::Programmer, SubPixelCorrelation, Isis::toString(), and WholePixelCorrelation.
Referenced by NameToDataType(), and ToKeyword().
| ControlMeasureLogData::NumericLogDataType Isis::ControlMeasureLogData::GetDataType | ( | ) | const |
Get the data type associated with this log data.
The return value is InvalidNumericLogDataType is no value has been set..
Referenced by Isis::ControlMeasure::GetLogData(), and Isis::ControlMeasure::SetLogData().
| double Isis::ControlMeasureLogData::GetNumericalValue | ( | ) | const |
Get the value associated with this log data.
Returns Null is IsValid() if false.
Referenced by Isis::AbstractMeasureItem::getData(), and Isis::ControlNetFilter::PointGoodnessOfFitFilter().
| QVariant Isis::ControlMeasureLogData::GetValue | ( | ) | const |
Get the data type associated with this log data.
The return value is an invalid variant type if the value is not set.
| bool Isis::ControlMeasureLogData::IsValid | ( | ) | const |
This tests if the log data is complete and valid.
References InvalidNumericLogDataType, and Isis::Null.
Referenced by Isis::ControlMeasure::SetLogData(), and ToKeyword().
| ControlMeasureLogData::NumericLogDataType Isis::ControlMeasureLogData::NameToDataType | ( | QString | name | ) | const |
This converts a string to a log data type and is useful for converting Pvl keywords to Numeric Log Data Type.
| name | The string to convert to data type |
References DataTypeToName(), InvalidNumericLogDataType, and MaximumNumericLogDataType.
Referenced by ControlMeasureLogData().
| void Isis::ControlMeasureLogData::SetDataType | ( | NumericLogDataType | newDataType | ) |
This changes the type of this log data.
This will reset the value of the log data also.
| newDataType | The data type this log data should represent |
| void Isis::ControlMeasureLogData::SetNumericalValue | ( | double | value | ) |
This updates the value associated with a NumericLogDataType.
| value | The new value for this log data |
| PvlKeyword Isis::ControlMeasureLogData::ToKeyword | ( | ) | const |
This converts the log data to a PvlKeyword.
These should be understandable by the constructor.
References DataTypeToName(), IsValid(), and Isis::toString().
|
static |
This value must be > the largest enumerated value in this type or convertions to and from Pvl will not work.
Referenced by NameToDataType().