Isis 3 Programmer Reference
|
Stores information about a "Spectral pixel" or spectel. More...
#include <Spectel.h>
Public Member Functions | |
Spectel () | |
Constructs an empty Spectel. | |
Spectel (int sample, int line, int band, double DN, double center, double width) | |
Constructs a Spectel using its l,s,b coordinates, its DN value, and its wavelength. | |
Spectel (Pixel pixel, double center, double width) | |
Constructs a Spectel, given a Pixel, center wavelength, and width. | |
Spectel (const Spectel &spectel) | |
Constructs a Spectel, given a Spectel. | |
virtual | ~Spectel () |
Default destructor. | |
Spectel & | operator= (const Spectel &other) |
Copy assignment operator. | |
double | centerWavelength () const |
Gets central wavelength of spectel. | |
double | filterWidth () const |
Gets wavelength width associated with spectel. | |
int | line () const |
int | sample () const |
int | band () const |
double | DN () const |
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. | |
short unsigned int | To16Ubit () |
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 short unsigned int | To16UBit (const double d) |
Converts double pixels to short unsigned 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 short unsigned int t) |
Converts short unsigned 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 short unsigned int d) |
Converts short unsigned 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. | |
Private Attributes | |
double | m_center |
Center wavelength associated with pixel. | |
double | m_width |
Wavelength width (FWHM) associated with pixel. | |
int | m_line |
line coordinate of pixel | |
int | m_sample |
sample coordinate of pixel | |
int | m_band |
band coordinate of pixel | |
double | m_DN |
DN of pixel. | |
Stores information about a "Spectral pixel" or spectel.
Isis::Spectel::Spectel | ( | ) |
Constructs an empty Spectel.
Definition at line 18 of file Spectel.cpp.
References m_center, m_width, and Isis::Null.
Isis::Spectel::Spectel | ( | int | sample, |
int | line, | ||
int | band, | ||
double | DN, | ||
double | center, | ||
double | width ) |
Constructs a Spectel using its l,s,b coordinates, its DN value, and its wavelength.
line | spectel line coordinate |
sample | spectel sample coordinate |
band | spectel band coordinate |
DN | spectel value |
center | center wavelength of spectel |
width | wavelength width of spectel |
Definition at line 38 of file Spectel.cpp.
Isis::Spectel::Spectel | ( | Pixel | pixel, |
double | center, | ||
double | width ) |
Isis::Spectel::Spectel | ( | const Spectel & | spectel | ) |
|
virtual |
Default destructor.
Definition at line 75 of file Spectel.cpp.
|
inherited |
Definition at line 92 of file Pixel.cpp.
References Isis::Pixel::m_band.
Referenced by Isis::Pixel::Pixel().
double Isis::Spectel::centerWavelength | ( | ) | const |
Gets central wavelength of spectel.
Definition at line 95 of file Spectel.cpp.
References m_center.
|
inherited |
Definition at line 98 of file Pixel.cpp.
References Isis::Pixel::m_DN.
Referenced by Isis::Pixel::Pixel().
double Isis::Spectel::filterWidth | ( | ) | const |
Gets wavelength width associated with spectel.
Definition at line 107 of file Spectel.cpp.
References m_width.
|
inlineinherited |
Returns true if the input pixel is one of the high saturation types.
Definition at line 180 of file Pixel.h.
References Isis::Pixel::IsHigh(), and Isis::Pixel::m_DN.
Referenced by Isis::Pixel::IsHigh().
|
inlinestaticinherited |
|
inlineinherited |
Returns true if the input pixel is high instrument saturation.
Definition at line 240 of file Pixel.h.
References Isis::Pixel::IsHis(), and Isis::Pixel::m_DN.
Referenced by Isis::Pixel::IsHis(), and Isis::Pixel::ToString().
|
inlinestaticinherited |
|
inlineinherited |
Returns true if the input pixel is high representation saturation.
Definition at line 220 of file Pixel.h.
References Isis::Pixel::IsHrs(), and Isis::Pixel::m_DN.
Referenced by Isis::Pixel::IsHrs(), and Isis::Pixel::ToString().
|
inlinestaticinherited |
|
inlineinherited |
Returns true if the input pixel is low instrument saturation.
Definition at line 260 of file Pixel.h.
References Isis::Pixel::IsLis(), and Isis::Pixel::m_DN.
Referenced by Isis::Pixel::IsLis(), and Isis::Pixel::ToString().
|
inlinestaticinherited |
|
inlineinherited |
Returns true if the input pixel is one of the low saturation types.
Definition at line 200 of file Pixel.h.
References Isis::Pixel::IsLow(), and Isis::Pixel::m_DN.
Referenced by Isis::Pixel::IsLow().
|
inlinestaticinherited |
|
inlineinherited |
Returns true if the input pixel is low representation saturation.
Definition at line 280 of file Pixel.h.
References Isis::Pixel::IsLrs(), and Isis::Pixel::m_DN.
Referenced by Isis::Pixel::IsLrs(), and Isis::Pixel::ToString().
|
inlinestaticinherited |
|
inlineinherited |
Returns true if the input pixel is null.
Definition at line 160 of file Pixel.h.
References Isis::Pixel::IsNull(), and Isis::Pixel::m_DN.
Referenced by Isis::Pixel::IsNull(), and Isis::Pixel::ToString().
|
inlinestaticinherited |
|
inlineinherited |
Returns true if the input pixel is special.
Not special implies it is valid to use in computations.
Definition at line 105 of file Pixel.h.
References Isis::Pixel::IsSpecial(), and Isis::Pixel::m_DN.
Referenced by Isis::Pixel::IsSpecial(), and Isis::Pixel::ToString().
|
inlinestaticinherited |
|
inlinestaticinherited |
|
inlineinherited |
Returns true if the input pixel is valid.
Valid implies the pixel is neither hrs, lrs, his, lis, nor null.
Definition at line 140 of file Pixel.h.
References Isis::Pixel::IsValid(), and Isis::Pixel::m_DN.
Referenced by Isis::Pixel::IsValid().
|
inlinestaticinherited |
|
inherited |
Definition at line 80 of file Pixel.cpp.
References Isis::Pixel::m_line.
Referenced by Isis::Pixel::Pixel().
Copy assignment operator.
Definition at line 80 of file Spectel.cpp.
References m_center, m_width, and Isis::Pixel::operator=().
|
inherited |
Definition at line 86 of file Pixel.cpp.
References Isis::Pixel::m_sample.
Referenced by Isis::Pixel::Pixel().
|
inherited |
Converts internal pixel value to a short int pixel with special pixel translations.
Definition at line 189 of file Pixel.cpp.
References Isis::Pixel::m_DN, and Isis::Pixel::To16Bit().
Referenced by Isis::Pixel::To16Bit().
|
staticinherited |
|
inherited |
Converts internal pixel value to a short int pixel with special pixel translations.
Definition at line 237 of file Pixel.cpp.
References Isis::Pixel::m_DN, and Isis::Pixel::To16UBit().
|
staticinherited |
Converts double pixels to short unsigned int pixels with special pixel translations.
d | Double pixel value to be converted to a double |
Definition at line 200 of file Pixel.cpp.
Referenced by Isis::Pixel::To16Ubit().
|
inherited |
Converts internal pixel value to float with special pixel translations.
Definition at line 267 of file Pixel.cpp.
References Isis::Pixel::m_DN, and Isis::Pixel::To32Bit().
Referenced by Isis::Pixel::To32Bit().
|
staticinherited |
|
inherited |
Converts internal pixel value to an unsigned char pixel with special pixel translations.
Definition at line 140 of file Pixel.cpp.
References Isis::Pixel::m_DN, and Isis::Pixel::To8Bit().
Referenced by Isis::Pixel::To8Bit().
|
staticinherited |
|
inherited |
Converts stored pixel value to a double.
Definition at line 359 of file Pixel.cpp.
References Isis::Pixel::m_DN.
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
inherited |
Converts internal pixel value to float with pixel translations and care for overflows (underflows are assumed to cast to 0!)
Definition at line 457 of file Pixel.cpp.
References Isis::Pixel::m_DN, and Isis::Pixel::ToFloat().
Referenced by Isis::Pixel::ToFloat().
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
inherited |
Returns the name of the pixel type as a string.
Definition at line 488 of file Pixel.cpp.
References Isis::Pixel::m_DN, and Isis::Pixel::ToString().
Referenced by Isis::Pixel::ToString().
|
staticinherited |
Takes a double pixel value and returns the name of the pixel type as a string.
d | Pixel value |
Definition at line 469 of file Pixel.cpp.
References Isis::Pixel::IsHis(), Isis::Pixel::IsHrs(), Isis::Pixel::IsLis(), Isis::Pixel::IsLrs(), Isis::Pixel::IsNull(), and Isis::Pixel::IsSpecial().
|
privateinherited |
band coordinate of pixel
Definition at line 292 of file Pixel.h.
Referenced by Isis::Pixel::band(), Isis::Pixel::operator=(), Isis::Pixel::Pixel(), Isis::Pixel::Pixel(), and Isis::Pixel::Pixel().
|
private |
Center wavelength associated with pixel.
Definition at line 41 of file Spectel.h.
Referenced by centerWavelength(), operator=(), Spectel(), Spectel(), Spectel(), and Spectel().
|
privateinherited |
DN of pixel.
Definition at line 295 of file Pixel.h.
Referenced by Isis::Pixel::DN(), Isis::Pixel::IsHigh(), Isis::Pixel::IsHis(), Isis::Pixel::IsHrs(), Isis::Pixel::IsLis(), Isis::Pixel::IsLow(), Isis::Pixel::IsLrs(), Isis::Pixel::IsNull(), Isis::Pixel::IsSpecial(), Isis::Pixel::IsValid(), Isis::Pixel::operator=(), Isis::Pixel::Pixel(), Isis::Pixel::Pixel(), Isis::Pixel::Pixel(), Isis::Pixel::To16Bit(), Isis::Pixel::To16Ubit(), Isis::Pixel::To32Bit(), Isis::Pixel::To8Bit(), Isis::Pixel::ToDouble(), Isis::Pixel::ToFloat(), and Isis::Pixel::ToString().
|
privateinherited |
line coordinate of pixel
Definition at line 286 of file Pixel.h.
Referenced by Isis::Pixel::line(), Isis::Pixel::operator=(), Isis::Pixel::Pixel(), Isis::Pixel::Pixel(), and Isis::Pixel::Pixel().
|
privateinherited |
sample coordinate of pixel
Definition at line 289 of file Pixel.h.
Referenced by Isis::Pixel::operator=(), Isis::Pixel::Pixel(), Isis::Pixel::Pixel(), Isis::Pixel::Pixel(), and Isis::Pixel::sample().
|
private |
Wavelength width (FWHM) associated with pixel.
Definition at line 43 of file Spectel.h.
Referenced by filterWidth(), operator=(), Spectel(), Spectel(), Spectel(), and Spectel().