USGS

Isis 3.0 Developer's Reference (API)

Home

Utility

Objects providing general functionality. More...

Classes

class  Isis::Area3D
 Represents a 3D area (a 3D "cube") More...
 
class  Isis::CollectorMap< K, T, ComparePolicy, RemovalPolicy, CopyPolicy >
 Collector/container for arbitrary items. More...
 
class  Isis::Column
 Format ascii tables. More...
 
class  Isis::CSVReader
 Reads strings and parses them into tokens separated by a delimiter character. More...
 
class  Isis::Displacement
 Displacement is a signed length, usually in meters. More...
 
class  Isis::Distance
 Distance measurement, usually in meters. More...
 
class  Isis::EndianSwapper
 Byte swapper. More...
 
class  Isis::ExportPdsTable
 Export a PDS table from an Isis3 Table. More...
 
class  Isis::GaussianStretch
 Gaussian stretch class. More...
 
class  Isis::GSL::GSLUtility
 GSLUtility Provides top level interface to the GNU GSL. More...
 
class  Isis::ID
 Creates sequential IDs. More...
 
class  Isis::ImportPdsTable
 Import a PDS table file with a label description. More...
 
class  Isis::Kernels
 Determine SPICE kernels defined in an ISIS file. More...
 
class  Isis::Latitude
 This class is designed to encapsulate the concept of a Latitude. More...
 
class  Isis::LineEquation
 Utility class for creating and using cartesean line equations. More...
 
class  Isis::Longitude
 This class is designed to encapsulate the concept of a Longitude. More...
 
class  Isis::Pixel
 Manipulate pixel values. More...
 
class  Isis::PolygonTools
 Provides various tools to work with geos multipolygons. More...
 
class  Isis::SparseBlockColumnMatrix
 SparseBlockColumnMatrix. More...
 
class  Isis::SparseBlockRowMatrix
 SparseBlockRowMatrix. More...
 
class  Isis::SparseBlockMatrix
 SparseBlockMatrix. More...
 
class  Isis::Stretch
 Pixel value mapper. More...
 
class  Isis::TextFile
 Provides access to sequential ASCII stream I/O. More...
 
class  Isis::DbAccess
 DbAccess manages programatic access to a database through profiles. More...
 
class  Isis::DbProfile
 A DbProfile is a container for access parameters to a database. More...
 
class  Isis::QHistogram
 Plot Histograms. More...
 

Enumerations

enum  Isis::ByteOrder { Isis::NoByteOrder = 0, Isis::Lsb, Isis::Msb }
 Tests the current architecture for byte order. More...
 

Functions

const double Isis::E (2.7182818284590452354)
 Sets some basic constants for use in ISIS programming.
 
std::map< QString, void * > GuiHelpers ()
 Base include file for all Isis applications.
 

Variables

const DBL_UNION Isis::IVALID_MIN8 = { DBL_INIT(0xFFEFFFFF, 0xFFFFFFFA) }
 Manipulate special pixel values.
 

Detailed Description

Objects providing general functionality.

Enumeration Type Documentation

Tests the current architecture for byte order.

Allows ISIS applications and objects to test the architecture's byte order. Little Endian or Big Endian. Note: Middle Endian is not supported at this time.

Author
2002-12-01 Tracie Sucharski
Enumerator
NoByteOrder 
Lsb 
Msb 

Function Documentation

std::map< QString, void * > GuiHelpers ( )

Base include file for all Isis applications.

This is not technically a class. Instead it is the main include file the must be placed at the beginning of every executable program. For example:

using namespace std;
#include "Isis.h"

The include file handles starting the Isis GUI, error messages, and a host of other Isis related duties that should be performed in all Isis programs. It actually contains the standard C++ declaration of main (i.e., int main (int argc, char *argv[])) and invokes the function IsisMain which must be supplied by the programmer. Therefore, your program should always start as follows:

using namespace std;
#include "Isis.h"
void IsisMain() {
...
}

The Isis.h file includes code that catches all thrown exceptions. It first trys to catch and report Isis specific errors. That is, those thrown within IsisMain or by Isis objects created in IsisMain. It will then catch C++ system type errors and respond accordingly. This eliminates the need for the application programmer to trap errors. They may however, throw errors as necessary to indicate error conditions within their application.

Author
2002-01-01 Jeff Anderson

Referenced by main().

Variable Documentation

const DBL_UNION Isis::IVALID_MIN8 = { DBL_INIT(0xFFEFFFFF, 0xFFFFFFFA) }

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