Isis::Pixel Class Reference

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

#include <Pixel.h>

Inheritance diagram for Isis::Pixel:

Collaboration diagram for Isis::Pixel:

Public Member Functions
	Pixel ()
	Constructs an empty Pixel. More...
	Pixel (int sample, int line, int band, double DN)
	Constructs a Pixel given a line, sample, band, and DN. More...
	Pixel (const Pixel &pixel)
	Constructs a Pixel, given a Pixel. More...
virtual	~Pixel ()
	Default destructor. More...
Pixel &	operator= (const Pixel &other)
	Copy assignment operator. More...
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. More...
short int	To16Bit ()
	Converts internal pixel value to a short int pixel with special pixel translations. More...
short unsigned int	To16Ubit ()
	Converts internal pixel value to a short int pixel with special pixel translations. More...
float	To32Bit ()
	Converts internal pixel value to float with special pixel translations. More...
double	ToDouble ()
	Converts stored pixel value to a double. More...
float	ToFloat ()
	Converts internal pixel value to float with pixel translations and care for overflows (underflows are assumed to cast to 0!) More...
std::string	ToString ()
	Returns the name of the pixel type as a string. More...
bool	IsSpecial ()
	Returns true if the input pixel is special. More...
bool	IsValid ()
	Returns true if the input pixel is valid. More...
bool	IsNull ()
	Returns true if the input pixel is null. More...
bool	IsHigh ()
	Returns true if the input pixel is one of the high saturation types. More...
bool	IsLow ()
	Returns true if the input pixel is one of the low saturation types. More...
bool	IsHrs ()
	Returns true if the input pixel is high representation saturation. More...
bool	IsHis ()
	Returns true if the input pixel is high instrument saturation. More...
bool	IsLis ()
	Returns true if the input pixel is low instrument saturation. More...
bool	IsLrs ()
	Returns true if the input pixel is low representation saturation. More...

Static Public Member Functions
static unsigned char	To8Bit (const double d)
	Converts double pixels to unsigned char pixels with special pixel translations. More...
static short int	To16Bit (const double d)
	Converts double pixels to short int pixels with special pixel translations. More...
static short unsigned int	To16UBit (const double d)
	Converts double pixels to short unsigned int pixels with special pixel translations. More...
static float	To32Bit (const double d)
	Converts double pixels to float pixels with special pixel translations. More...
static double	ToDouble (const unsigned char t)
	Converts unsigned char pixels to double pixels with special pixel translations. More...
static double	ToDouble (const short int t)
	Converts short int pixels to double pixels with special pixel translations. More...
static double	ToDouble (const short unsigned int t)
	Converts short unsigned int pixels to double pixels with special pixel translations. More...
static double	ToDouble (const float t)
	Converts float pixels to double pixels with special pixel translations. More...
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!) More...
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!) More...
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!) More...
static float	ToFloat (const double d)
	Converts double to float with pixel translations and care for overflows (underflows are assumed to cast to 0!) More...
static std::string	ToString (double d)
	Takes a double pixel value and returns the name of the pixel type as a string. More...
static bool	IsSpecial (const double d)
	Returns true if the input pixel is special. More...
static bool	IsSpecial (const float f)
	Returns true if the input pixel is special. More...
static bool	IsValid (const double d)
	Returns true if the input pixel is valid. More...
static bool	IsNull (const double d)
	Returns true if the input pixel is null. More...
static bool	IsHigh (const double d)
	Returns true if the input pixel is one of the high saturation types. More...
static bool	IsLow (const double d)
	Returns true if the input pixel is one of the low saturation types. More...
static bool	IsHrs (const double d)
	Returns true if the input pixel is high representation saturation. More...
static bool	IsHis (const double d)
	Returns true if the input pixel is high instrument saturation. More...
static bool	IsLis (const double d)
	Returns true if the input pixel is low instrument saturation. More...
static bool	IsLrs (const double d)
	Returns true if the input pixel is low representation saturation. More...

Private Attributes
int	m_line
	line coordinate of pixel More...
int	m_sample
	sample coordinate of pixel More...
int	m_band
	band coordinate of pixel More...
double	m_DN
	DN of pixel. More...

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

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.

History:

2015-05-11 Kristin Berry - Added ability to store pixel information/made class instantiatable and updated funtionality to use this information when available.

Definition at line 63 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 34 of file Pixel.cpp.

References 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

line	line coordinate
sample	sample coordinate
band	band coordinate
DN	data value for the pixel

Definition at line 52 of file Pixel.cpp.

Pixel() [3/3]

Isis::Pixel::Pixel

(

const Pixel &

pixel

)

Constructs a Pixel, given a Pixel.

Author

2015-08-05 Kristin Berry

Parameters

pixel

Pixel to copy

Definition at line 67 of file Pixel.cpp.

References band(), DN(), line(), and sample().

~Pixel()

Isis::Pixel::~Pixel ( )

virtual

Default destructor.

Definition at line 92 of file Pixel.cpp.

Member Function Documentation

band()

int Isis::Pixel::band

(

)

const

Returns

int The band coordinate of the Pixel

Definition at line 108 of file Pixel.cpp.

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

DN()

double Isis::Pixel::DN

(

)

const

Returns

double The DN value of the Pixel

Definition at line 114 of file Pixel.cpp.

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

IsHigh() [1/2]

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

inlinestatic

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

Parameters

d	Pixel value to test

Returns

bool

Definition at line 186 of file Pixel.h.

IsHigh() [2/2]

bool Isis::Pixel::IsHigh ( )

inline

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

Returns

bool

Definition at line 195 of file Pixel.h.

References m_DN.

IsHis() [1/2]

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

inlinestatic

Returns true if the input pixel is high instrument saturation.

Parameters

d	Pixel value to test

Returns

bool

Definition at line 246 of file Pixel.h.

IsHis() [2/2]

bool Isis::Pixel::IsHis ( )

inline

Returns true if the input pixel is high instrument saturation.

Returns

bool

Definition at line 255 of file Pixel.h.

References m_DN.

IsHrs() [1/2]

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

inlinestatic

Returns true if the input pixel is high representation saturation.

Parameters

d	Pixel value to test

Returns

bool

Definition at line 226 of file Pixel.h.

IsHrs() [2/2]

bool Isis::Pixel::IsHrs ( )

inline

Returns true if the input pixel is high representation saturation.

Returns

bool

Definition at line 235 of file Pixel.h.

References m_DN.

IsLis() [1/2]

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

inlinestatic

Returns true if the input pixel is low instrument saturation.

Parameters

d	Pixel value to test

Returns

bool

Definition at line 266 of file Pixel.h.

IsLis() [2/2]

bool Isis::Pixel::IsLis ( )

inline

Returns true if the input pixel is low instrument saturation.

Returns

bool

Definition at line 275 of file Pixel.h.

References m_DN.

IsLow() [1/2]

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

inlinestatic

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

Parameters

d	Pixel value to test

Returns

bool

Definition at line 206 of file Pixel.h.

IsLow() [2/2]

bool Isis::Pixel::IsLow ( )

inline

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

Returns

bool

Definition at line 215 of file Pixel.h.

References m_DN.

IsLrs() [1/2]

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

inlinestatic

Returns true if the input pixel is low representation saturation.

Parameters

d	Pixel value to test

Returns

bool

Definition at line 286 of file Pixel.h.

IsLrs() [2/2]

bool Isis::Pixel::IsLrs ( )

inline

Returns true if the input pixel is low representation saturation.

Returns

bool

Definition at line 295 of file Pixel.h.

References m_DN.

IsNull() [1/2]

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

inlinestatic

Returns true if the input pixel is null.

Parameters

d	Pixel value to test

Returns

bool

Definition at line 166 of file Pixel.h.

IsNull() [2/2]

bool Isis::Pixel::IsNull ( )

inline

Returns true if the input pixel is null.

Returns

bool

Definition at line 175 of file Pixel.h.

References m_DN.

IsSpecial() [1/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

d	Pixel value to test

Returns

bool

Definition at line 110 of file Pixel.h.

IsSpecial() [2/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 120 of file Pixel.h.

References m_DN.

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

f	Pixel value to test

Returns

bool

Definition at line 133 of file Pixel.h.

IsValid() [1/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

d	Pixel value to test

Returns

bool

Definition at line 145 of file Pixel.h.

IsValid() [2/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 155 of file Pixel.h.

References m_DN.

line()

int Isis::Pixel::line

(

)

const

Returns

int The line coordinate of the Pixel

Definition at line 96 of file Pixel.cpp.

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

operator=()

Pixel & Isis::Pixel::operator=

(

const Pixel &

other

)

Copy assignment operator.

Parameters

other

Pixel the Pixel to be copied

Returns

Pixel Pointer to self

Definition at line 82 of file Pixel.cpp.

References band(), DN(), line(), and sample().

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

sample()

int Isis::Pixel::sample

(

)

const

Returns

int The sample coordinate of the Pixel

Definition at line 102 of file Pixel.cpp.

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

To16Bit() [1/2]

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

static

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

Parameters

d	Double pixel value to be converted to a double

Returns

short int The short int pixel value

Definition at line 168 of file Pixel.cpp.

To16Bit() [2/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 205 of file Pixel.cpp.

To16UBit()

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

static

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

Parameters

d	Double pixel value to be converted to a double

Returns

short unsigned int The short int pixel value

Definition at line 216 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 253 of file Pixel.cpp.

To32Bit() [1/2]

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

static

Converts double pixels to float pixels with special pixel translations.

Parameters

d	Double pixel value to be converted to a double

Returns

float The float pixel value

Definition at line 264 of file Pixel.cpp.

To32Bit() [2/2]

float Isis::Pixel::To32Bit

(

)

Converts internal pixel value to float with special pixel translations.

Returns

float The float pixel value

Definition at line 283 of file Pixel.cpp.

To8Bit() [1/2]

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

static

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

Parameters

d	Double pixel value to be converted to a double

Returns

unsigned char The unsigned char pixel value

Definition at line 127 of file Pixel.cpp.

To8Bit() [2/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 156 of file Pixel.cpp.

ToDouble() [1/5]

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

static

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

Parameters

d	Unsigned char pixel value to be converted to a double

Returns

double The double pixel value

Definition at line 296 of file Pixel.cpp.

ToDouble() [2/5]

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

static

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

Parameters

d	Short int pixel value to be converted to a double

Returns

double The double pixel value

Definition at line 317 of file Pixel.cpp.

ToDouble() [3/5]

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

static

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

Parameters

d	Short unsigned int pixel value to be converted to a double

Returns

double The double pixel value

Definition at line 336 of file Pixel.cpp.

ToDouble() [4/5]

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

static

Converts float pixels to double pixels with special pixel translations.

Parameters

d	Float pixel value to be converted to a double

Returns

double The double pixel value

Definition at line 356 of file Pixel.cpp.

ToDouble() [5/5]

double Isis::Pixel::ToDouble

(

)

Converts stored pixel value to a double.

Returns

double The double pixel value

Definition at line 375 of file Pixel.cpp.

ToFloat() [1/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

t	Unsigned char pixel value to be converted to a float

Returns

float The float pixel value

Definition at line 390 of file Pixel.cpp.

ToFloat() [2/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

t	Short int pixel value to be converted to a float

Returns

float The float pixel value

Definition at line 411 of file Pixel.cpp.

ToFloat() [3/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

t	Short unsigned int pixel value to be converted to a float

Returns

float The float pixel value

Definition at line 432 of file Pixel.cpp.

ToFloat() [4/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

t	Double pixel value to be converted to a float

Returns

float The float pixel value

Definition at line 453 of file Pixel.cpp.

ToFloat() [5/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 473 of file Pixel.cpp.

ToString() [1/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

d	Pixel value

Returns

string The name of the pixel type

Definition at line 485 of file Pixel.cpp.

References Isis::IsSpecial().

ToString() [2/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 504 of file Pixel.cpp.

References Isis::ToString().

Member Data Documentation

m_band

int Isis::Pixel::m_band

private

band coordinate of pixel

Definition at line 307 of file Pixel.h.

m_DN

double Isis::Pixel::m_DN

private

DN of pixel.

Definition at line 310 of file Pixel.h.

Referenced by IsHigh(), IsHis(), IsHrs(), IsLis(), IsLow(), IsLrs(), IsNull(), IsSpecial(), and IsValid().

m_line

int Isis::Pixel::m_line

private

line coordinate of pixel

Definition at line 301 of file Pixel.h.

m_sample

int Isis::Pixel::m_sample

private

sample coordinate of pixel

Definition at line 304 of file Pixel.h.

---

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

• src/base/objs/Pixel/Pixel.h
• src/base/objs/Pixel/Pixel.cpp