Isis 3 Programmer Reference
Isis::DBL_UNION Union Reference

Manipulate special pixel values. More...

#include <SpecialPixel.h>

Collaboration diagram for Isis::DBL_UNION:
Collaboration graph

Public Attributes

unsigned int i [2]
 
double d
 

Detailed Description

Manipulate special pixel values.

This is not technically a class but instead a set of constants and functions which operate on Isis special pixels. There are several types of special pixels defined under the namespace Isis which include: Isis::Null Pixel has no data available Isis::Lis Pixel was saturated on the instrument Isis::His Pixel was saturated on the instrument Isis::Lrs Pixel was saturated during a computation Isis::Hrs Pixel was saturated during a computation As indicated, saturated pixels are either generated by the instrument or generated by a computation. For example, on the instrument with a 8-bit Analog-to-Digital converter, a gain setting could cause the conversion of many pixels to exceed 255. Because their are only 8-bits the value 255 is likely a High Instrument Saturation (His) value. Likewise, 0 would be a Low Instrument Saturation (Lis) value. The Lrs and Hrs values indicate Low or High Representation Saturation respectively. When an application program operates on non-special pixels using standard arithmetic operators (and other functions) it is possible that the operation could generate an Lrs or Hrs. Application programmer should take care when processing pixels to ensure that special pixels are not used in computations. These tests can be performed with various functions provided in this include file.

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

2008-01-09 Jeannie Walldren - Added new unitTests and new method, StringToPixel()

2008-01-10 Jeannie Walldren - Added new unitTests and modified StringToPixel() to allow the user to enter any legal and unique shortened version of special pixels.

2016-04-20 Jeannie Backer - Added Janet Barret's changes IVALID_MAX4 definition to handle SignedInteger imports.

2018-07-18 Tyler Wilson - Added 4-byte unsigned int special pixel values. References #971.

Todo
2005-02-15 Kris Becker - finish class documentation

Definition at line 72 of file SpecialPixel.h.

Member Data Documentation

◆ d

double Isis::DBL_UNION::d

Definition at line 74 of file SpecialPixel.h.

◆ i

unsigned int Isis::DBL_UNION::i[2]

Definition at line 73 of file SpecialPixel.h.


The documentation for this union was generated from the following file: