Isis 3 Programmer Reference
Isis::Pixel Class Reference

Store and/or manipulate pixel values. More...

#include <Pixel.h>

Inheritance diagram for Isis::Pixel:
Inheritance graph
Collaboration diagram for Isis::Pixel:
Collaboration graph

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.
 
Pixeloperator= (const Pixel &other)
 Copy assignment operator.
 
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

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.
 

Detailed Description

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

2003-05-16 Stuart Sides - Modified schema from astrogeology... isis.astrogeology...

2005-02-15 Elizabeth Ribelin - Modified file to support Doxygen documentation

2005-05-18 Jeff Anderson - Changed long to int for 64-bit port

2006-06-21 Elizabeth Miller - Copied SpecialPixel methods into into the Pixel class for easy refactoring later and added several conversion methods

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.

2015-08-05 Kristin Berry - Added empty constructor, copy constructor, copy assignement operator, and virutal destructor. Also updated to comply with Isiscoding standards.

2016-04-20 Makayla Shepherd - Added methods to handle UnsignedWord pixel type.

Definition at line 48 of file Pixel.h.

Constructor & Destructor Documentation

◆ Pixel() [1/3]

Isis::Pixel::Pixel ( )

Constructs an empty Pixel.

Author
2015-08-05 Kristin Berry

Definition at line 18 of file Pixel.cpp.

References m_band, m_DN, m_line, m_sample, and Isis::Null.

◆ Pixel() [2/3]

Isis::Pixel::Pixel ( int sample,
int line,
int band,
double DN )

Constructs a Pixel given a line, sample, band, and DN.

Author
2015-05-08 Kristin Berry
Parameters
lineline coordinate
samplesample coordinate
bandband coordinate
DNdata value for the pixel

Definition at line 36 of file Pixel.cpp.

References band(), DN(), line(), m_band, m_DN, m_line, m_sample, and sample().

◆ Pixel() [3/3]

Isis::Pixel::Pixel ( const Pixel & pixel)

Constructs a Pixel, given a Pixel.

Author
2015-08-05 Kristin Berry
Parameters
pixelPixel to copy

Definition at line 51 of file Pixel.cpp.

References m_band, m_DN, m_line, and m_sample.

◆ ~Pixel()

Isis::Pixel::~Pixel ( )
virtual

Default destructor.

Definition at line 76 of file Pixel.cpp.

Member Function Documentation

◆ band()

int Isis::Pixel::band ( ) const
Returns
int The band coordinate of the Pixel

Definition at line 92 of file Pixel.cpp.

References m_band.

Referenced by Pixel().

◆ DN()

double Isis::Pixel::DN ( ) const
Returns
double The DN value of the Pixel

Definition at line 98 of file Pixel.cpp.

References m_DN.

Referenced by Pixel().

◆ IsHigh() [1/2]

bool Isis::Pixel::IsHigh ( )
inline

Returns true if the input pixel is one of the high saturation types.

Returns
bool

Definition at line 180 of file Pixel.h.

References IsHigh(), and m_DN.

Referenced by IsHigh().

◆ IsHigh() [2/2]

static bool Isis::Pixel::IsHigh ( const double d)
inlinestatic

Returns true if the input pixel is one of the high saturation types.

Parameters
dPixel value to test
Returns
bool

Definition at line 171 of file Pixel.h.

◆ IsHis() [1/2]

bool Isis::Pixel::IsHis ( )
inline

Returns true if the input pixel is high instrument saturation.

Returns
bool

Definition at line 240 of file Pixel.h.

References IsHis(), and m_DN.

Referenced by IsHis(), and ToString().

◆ IsHis() [2/2]

static bool Isis::Pixel::IsHis ( const double d)
inlinestatic

Returns true if the input pixel is high instrument saturation.

Parameters
dPixel value to test
Returns
bool

Definition at line 231 of file Pixel.h.

◆ IsHrs() [1/2]

bool Isis::Pixel::IsHrs ( )
inline

Returns true if the input pixel is high representation saturation.

Returns
bool

Definition at line 220 of file Pixel.h.

References IsHrs(), and m_DN.

Referenced by IsHrs(), and ToString().

◆ IsHrs() [2/2]

static bool Isis::Pixel::IsHrs ( const double d)
inlinestatic

Returns true if the input pixel is high representation saturation.

Parameters
dPixel value to test
Returns
bool

Definition at line 211 of file Pixel.h.

◆ IsLis() [1/2]

bool Isis::Pixel::IsLis ( )
inline

Returns true if the input pixel is low instrument saturation.

Returns
bool

Definition at line 260 of file Pixel.h.

References IsLis(), and m_DN.

Referenced by IsLis(), and ToString().

◆ IsLis() [2/2]

static bool Isis::Pixel::IsLis ( const double d)
inlinestatic

Returns true if the input pixel is low instrument saturation.

Parameters
dPixel value to test
Returns
bool

Definition at line 251 of file Pixel.h.

◆ IsLow() [1/2]

bool Isis::Pixel::IsLow ( )
inline

Returns true if the input pixel is one of the low saturation types.

Returns
bool

Definition at line 200 of file Pixel.h.

References IsLow(), and m_DN.

Referenced by IsLow().

◆ IsLow() [2/2]

static bool Isis::Pixel::IsLow ( const double d)
inlinestatic

Returns true if the input pixel is one of the low saturation types.

Parameters
dPixel value to test
Returns
bool

Definition at line 191 of file Pixel.h.

◆ IsLrs() [1/2]

bool Isis::Pixel::IsLrs ( )
inline

Returns true if the input pixel is low representation saturation.

Returns
bool

Definition at line 280 of file Pixel.h.

References IsLrs(), and m_DN.

Referenced by IsLrs(), and ToString().

◆ IsLrs() [2/2]

static bool Isis::Pixel::IsLrs ( const double d)
inlinestatic

Returns true if the input pixel is low representation saturation.

Parameters
dPixel value to test
Returns
bool

Definition at line 271 of file Pixel.h.

◆ IsNull() [1/2]

bool Isis::Pixel::IsNull ( )
inline

Returns true if the input pixel is null.

Returns
bool

Definition at line 160 of file Pixel.h.

References IsNull(), and m_DN.

Referenced by IsNull(), and ToString().

◆ IsNull() [2/2]

static bool Isis::Pixel::IsNull ( const double d)
inlinestatic

Returns true if the input pixel is null.

Parameters
dPixel value to test
Returns
bool

Definition at line 151 of file Pixel.h.

◆ IsSpecial() [1/3]

bool Isis::Pixel::IsSpecial ( )
inline

Returns true if the input pixel is special.

Not special implies it is valid to use in computations.

Returns
bool

Definition at line 105 of file Pixel.h.

References IsSpecial(), and m_DN.

Referenced by IsSpecial(), and ToString().

◆ IsSpecial() [2/3]

static bool Isis::Pixel::IsSpecial ( const double d)
inlinestatic

Returns true if the input pixel is special.

Not special implies it is valid to use in computations.

Parameters
dPixel value to test
Returns
bool

Definition at line 95 of file Pixel.h.

◆ IsSpecial() [3/3]

static bool Isis::Pixel::IsSpecial ( const float f)
inlinestatic

Returns true if the input pixel is special.

Not special implies it is valid to use in computations. This method applies to a 4-byte floating point rather than an 8-byte double.

Parameters
fPixel value to test
Returns
bool

Definition at line 118 of file Pixel.h.

◆ IsValid() [1/2]

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 140 of file Pixel.h.

References IsValid(), and m_DN.

Referenced by IsValid().

◆ IsValid() [2/2]

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
dPixel value to test
Returns
bool

Definition at line 130 of file Pixel.h.

◆ line()

int Isis::Pixel::line ( ) const
Returns
int The line coordinate of the Pixel

Definition at line 80 of file Pixel.cpp.

References m_line.

Referenced by Pixel().

◆ operator=()

Pixel & Isis::Pixel::operator= ( const Pixel & other)

Copy assignment operator.

Parameters
otherPixel the Pixel to be copied
Returns
Pixel Pointer to self

Definition at line 66 of file Pixel.cpp.

References m_band, m_DN, m_line, and m_sample.

Referenced by Isis::Spectel::operator=().

◆ sample()

int Isis::Pixel::sample ( ) const
Returns
int The sample coordinate of the Pixel

Definition at line 86 of file Pixel.cpp.

References m_sample.

Referenced by Pixel().

◆ To16Bit() [1/2]

short int Isis::Pixel::To16Bit ( )

Converts internal pixel value to a short int pixel with special pixel translations.

Returns
short int The short int pixel value

Definition at line 189 of file Pixel.cpp.

References m_DN, and To16Bit().

Referenced by To16Bit().

◆ To16Bit() [2/2]

short int Isis::Pixel::To16Bit ( const double d)
static

Converts double pixels to short int pixels with special pixel translations.

Parameters
dDouble pixel value to be converted to a double
Returns
short int The short int pixel value

Definition at line 152 of file Pixel.cpp.

◆ To16Ubit()

short unsigned int Isis::Pixel::To16Ubit ( )

Converts internal pixel value to a short int pixel with special pixel translations.

Returns
short unsigned int The short int pixel value

Definition at line 237 of file Pixel.cpp.

References m_DN, and To16UBit().

◆ To16UBit()

short unsigned int Isis::Pixel::To16UBit ( const double d)
static

Converts double pixels to short unsigned int pixels with special pixel translations.

Parameters
dDouble pixel value to be converted to a double
Returns
short unsigned int The short int pixel value

Definition at line 200 of file Pixel.cpp.

Referenced by To16Ubit().

◆ To32Bit() [1/2]

float Isis::Pixel::To32Bit ( )

Converts internal pixel value to float with special pixel translations.

Returns
float The float pixel value

Definition at line 267 of file Pixel.cpp.

References m_DN, and To32Bit().

Referenced by To32Bit().

◆ To32Bit() [2/2]

float Isis::Pixel::To32Bit ( const double d)
static

Converts double pixels to float pixels with special pixel translations.

Parameters
dDouble pixel value to be converted to a double
Returns
float The float pixel value

Definition at line 248 of file Pixel.cpp.

◆ To8Bit() [1/2]

unsigned char Isis::Pixel::To8Bit ( )

Converts internal pixel value to an unsigned char pixel with special pixel translations.

Returns
unsigned char The unsigned char pixel value

Definition at line 140 of file Pixel.cpp.

References m_DN, and To8Bit().

Referenced by To8Bit().

◆ To8Bit() [2/2]

unsigned char Isis::Pixel::To8Bit ( const double d)
static

Converts double pixels to unsigned char pixels with special pixel translations.

Parameters
dDouble pixel value to be converted to a double
Returns
unsigned char The unsigned char pixel value

Definition at line 111 of file Pixel.cpp.

◆ ToDouble() [1/5]

double Isis::Pixel::ToDouble ( )

Converts stored pixel value to a double.

Returns
double The double pixel value

Definition at line 359 of file Pixel.cpp.

References m_DN.

◆ ToDouble() [2/5]

double Isis::Pixel::ToDouble ( const float d)
static

Converts float pixels to double pixels with special pixel translations.

Parameters
dFloat pixel value to be converted to a double
Returns
double The double pixel value

Definition at line 340 of file Pixel.cpp.

◆ ToDouble() [3/5]

double Isis::Pixel::ToDouble ( const short int d)
static

Converts short int pixels to double pixels with special pixel translations.

Parameters
dShort int pixel value to be converted to a double
Returns
double The double pixel value

Definition at line 301 of file Pixel.cpp.

◆ ToDouble() [4/5]

double Isis::Pixel::ToDouble ( const short unsigned int d)
static

Converts short unsigned int pixels to double pixels with special pixel translations.

Parameters
dShort unsigned int pixel value to be converted to a double
Returns
double The double pixel value

Definition at line 320 of file Pixel.cpp.

◆ ToDouble() [5/5]

double Isis::Pixel::ToDouble ( const unsigned char d)
static

Converts unsigned char pixels to double pixels with special pixel translations.

Parameters
dUnsigned char pixel value to be converted to a double
Returns
double The double pixel value

Definition at line 280 of file Pixel.cpp.

◆ ToFloat() [1/5]

float Isis::Pixel::ToFloat ( )

Converts internal pixel value to float with pixel translations and care for overflows (underflows are assumed to cast to 0!)

Returns
float The float pixel value

Definition at line 457 of file Pixel.cpp.

References m_DN, and ToFloat().

Referenced by ToFloat().

◆ ToFloat() [2/5]

float Isis::Pixel::ToFloat ( const double t)
static

Converts double to float with pixel translations and care for overflows (underflows are assumed to cast to 0!)

Parameters
tDouble pixel value to be converted to a float
Returns
float The float pixel value

Definition at line 437 of file Pixel.cpp.

◆ ToFloat() [3/5]

float Isis::Pixel::ToFloat ( const short int t)
static

Converts short int to float with pixel translations and care for overflows (underflows are assumed to cast to 0!)

Parameters
tShort int pixel value to be converted to a float
Returns
float The float pixel value

Definition at line 395 of file Pixel.cpp.

◆ ToFloat() [4/5]

float Isis::Pixel::ToFloat ( const short unsigned int t)
static

Converts short unsigned int to float with pixel translations and care for overflows (underflows are assumed to cast to 0!)

Parameters
tShort unsigned int pixel value to be converted to a float
Returns
float The float pixel value

Definition at line 416 of file Pixel.cpp.

◆ ToFloat() [5/5]

float Isis::Pixel::ToFloat ( const unsigned char t)
static

Converts unsigned char to float with pixel translations and care for overflows (underflows are assumed to cast to 0!)

Parameters
tUnsigned char pixel value to be converted to a float
Returns
float The float pixel value

Definition at line 374 of file Pixel.cpp.

◆ ToString() [1/2]

string Isis::Pixel::ToString ( )

Returns the name of the pixel type as a string.

Returns
string The name of the pixel type

Definition at line 488 of file Pixel.cpp.

References m_DN, and ToString().

Referenced by ToString().

◆ ToString() [2/2]

string Isis::Pixel::ToString ( double d)
static

Takes a double pixel value and returns the name of the pixel type as a string.

Parameters
dPixel value
Returns
string The name of the pixel type

Definition at line 469 of file Pixel.cpp.

References IsHis(), IsHrs(), IsLis(), IsLrs(), IsNull(), and IsSpecial().

Member Data Documentation

◆ m_band

int Isis::Pixel::m_band
private

band coordinate of pixel

Definition at line 292 of file Pixel.h.

Referenced by band(), operator=(), Pixel(), Pixel(), and Pixel().

◆ m_DN

double Isis::Pixel::m_DN
private

◆ m_line

int Isis::Pixel::m_line
private

line coordinate of pixel

Definition at line 286 of file Pixel.h.

Referenced by line(), operator=(), Pixel(), Pixel(), and Pixel().

◆ m_sample

int Isis::Pixel::m_sample
private

sample coordinate of pixel

Definition at line 289 of file Pixel.h.

Referenced by operator=(), Pixel(), Pixel(), Pixel(), and sample().


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