Public Member Functions |
| | Pixel () |
| | Constructs an empty Pixel.
|
| | Pixel (int sample, int line, int band, double DN) |
| | Constructs a Pixel given a line, sample, band, and DN.
|
| | Pixel (const Pixel &pixel) |
| | Constructs a Pixel, given a Pixel.
|
| virtual | ~Pixel () |
| | Default destructor.
|
| Pixel & | operator= (const Pixel &other) |
| | Copy assignment operator.
|
| int | line () const |
| | Returns the line coordinate of the Pixel.
|
| int | sample () const |
| | Returns the sample coordinate of the Pixel.
|
| int | band () const |
| | Returns the band coordinate of the Pixel.
|
| double | DN () const |
| | Returns the DN of the Pixel.
|
| unsigned char | To8Bit () |
| | Converts internal pixel value to an unsigned char pixel with special pixel translations.
|
| short int | To16Bit () |
| | Converts internal pixel value to a short int pixel with special pixel translations.
|
| float | To32Bit () |
| | Converts internal pixel value to float with special pixel translations.
|
| double | ToDouble () |
| | Converts stored pixel value to a double.
|
| float | ToFloat () |
| | Converts internal pixel value to float with pixel translations and care for overflows (underflows are assumed to cast to 0!)
|
| std::string | ToString () |
| | Returns the name of the pixel type as a string.
|
| bool | IsSpecial () |
| | Returns true if the input pixel is special.
|
| bool | IsValid () |
| | Returns true if the input pixel is valid.
|
| bool | IsNull () |
| | Returns true if the input pixel is null.
|
| bool | IsHigh () |
| | Returns true if the input pixel is one of the high saturation types.
|
| bool | IsLow () |
| | Returns true if the input pixel is one of the low saturation types.
|
| bool | IsHrs () |
| | Returns true if the input pixel is high representation saturation.
|
| bool | IsHis () |
| | Returns true if the input pixel is high instrument saturation.
|
| bool | IsLis () |
| | Returns true if the input pixel is low instrument saturation.
|
| bool | IsLrs () |
| | Returns true if the input pixel is low representation saturation.
|
Static Public Member Functions |
| static unsigned char | To8Bit (const double d) |
| | Converts double pixels to unsigned char pixels with special pixel translations.
|
| static short int | To16Bit (const double d) |
| | Converts double pixels to short int pixels with special pixel translations.
|
| static float | To32Bit (const double d) |
| | Converts double pixels to float pixels with special pixel translations.
|
| static double | ToDouble (const unsigned char t) |
| | Converts unsigned char pixels to double pixels with special pixel translations.
|
| static double | ToDouble (const short int t) |
| | Converts short int pixels to double pixels with special pixel translations.
|
| static double | ToDouble (const float t) |
| | Converts float pixels to double pixels with special pixel translations.
|
| static float | ToFloat (const unsigned char d) |
| | Converts unsigned char to float with pixel translations and care for overflows (underflows are assumed to cast to 0!)
|
| static float | ToFloat (const short int d) |
| | Converts short int to float with pixel translations and care for overflows (underflows are assumed to cast to 0!)
|
| static float | ToFloat (const double d) |
| | Converts double to float with pixel translations and care for overflows (underflows are assumed to cast to 0!)
|
| static std::string | ToString (double d) |
| | Takes a double pixel value and returns the name of the pixel type as a string.
|
| static bool | IsSpecial (const double d) |
| | Returns true if the input pixel is special.
|
| static bool | IsSpecial (const float f) |
| | Returns true if the input pixel is special.
|
| static bool | IsValid (const double d) |
| | Returns true if the input pixel is valid.
|
| static bool | IsNull (const double d) |
| | Returns true if the input pixel is null.
|
| static bool | IsHigh (const double d) |
| | Returns true if the input pixel is one of the high saturation types.
|
| static bool | IsLow (const double d) |
| | Returns true if the input pixel is one of the low saturation types.
|
| static bool | IsHrs (const double d) |
| | Returns true if the input pixel is high representation saturation.
|
| static bool | IsHis (const double d) |
| | Returns true if the input pixel is high instrument saturation.
|
| static bool | IsLis (const double d) |
| | Returns true if the input pixel is low instrument saturation.
|
| static bool | IsLrs (const double d) |
| | Returns true if the input pixel is low representation saturation.
|
Store and/or manipulate pixel values.
This class can store pixel information and also contains utility methods for testing and modifying pixel and special pixel values that can be used without instanteating the class.
- Author
- 2002-04-11 Kris Becker
- History:
- 2003-02-11 Jeff Anderson - Wrote unitTest and documentation
- History:
- 2003-05-16 Stuart Sides - Modified schema from astrogeology... isis.astrogeology...
- History:
- 2005-02-15 Elizabeth Ribelin - Modified file to support Doxygen documentation
- History:
- 2005-05-18 Jeff Anderson - Changed long to int for 64-bit port
- History:
- 2006-06-21 Elizabeth Miller - Copied SpecialPixel methods into into the Pixel class for easy refactoring later and added several conversion methods
- History:
- 2009-02-03 Travis Addair - Modified documentation for clarity
- History:
- 2015-05-11 Kristin Berry - Added ability to store pixel information/made class instantiatable and updated funtionality to use this information when available.
- History:
- 2015-08-05 Kristin Berry - Added empty constructor, copy constructor, copy assignement operator, and virutal destructor. Also updated to comply with Isiscoding standards.
Definition at line 62 of file Pixel.h.
| static bool Isis::Pixel::IsValid |
( |
const double |
d | ) |
|
|
inlinestatic |
Returns true if the input pixel is valid.
Valid implies the pixel is neither hrs, lrs, his, lis, nor null.
- Parameters
-
- Returns
- bool
Definition at line 139 of file Pixel.h.
| bool Isis::Pixel::IsValid |
( |
| ) |
|
|
inline |
Returns true if the input pixel is valid.
Valid implies the pixel is neither hrs, lrs, his, lis, nor null.
- Returns
- bool
Definition at line 149 of file Pixel.h.
References m_DN.
