USGS

Isis 3.0 Object Programmers' Reference

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
 Store and/or 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...
union  Isis::DBL_UNION
 Manipulate special pixel values. 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 { NoByteOrder = 0, Lsb, 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.

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
History:
2003-02-11 Stuart Sides - Documented and created an object unittest
History:
2003-05-16 Stuart Sides - Modified schema from astrogeology... isis.astrogeology...
History:
2003-10-03 Stuart Sides - Added the byte order enumeration and functions to convert the enumeration to a string and from a string to an enumeration. Also deprecated the LittleEndian and BigEndian functions. They were replaced by Lsb and Msb functions.
History:
2004-03-18 Stuart Sides - Added to macros for case where we need to know at compile time if a system is LSB or MSB. The macros are ISIS_LITTLE_ENDIAN and ISIS_BIG_ENDIAN

Definition at line 59 of file Endian.h.

Function Documentation

const double Isis::E ( 2.  7182818284590452354)

Sets some basic constants for use in ISIS programming.

Sets constants used in ISIS applications and objects such as PI and E.

Author
2003-01-22 Tracie Sucharski
History:
2003-02-11 Stuart Sides - Documented and created an object unitTest.
History:
2003-05-16 Stuart Sides - Modified schema from astrogeology... isis.astrogeology...
History:
2006-05-17 Elizabeth Miller - Removed .xml file and added documentation to .h file
History:
2009-03-16 Tracie Sucharski - Updated for release 3.2.0.
History:
2010-03-18 Tracie Sucharski - Updated to 3.2.1beta.
History:
2010-05-24 Travis Addair - Added DEG2RAD and RAD2DEG
History:
2010-11-29 Steven Lambright - Isis version constant removed
History:
2012-06-22 Orrin Thomas - Added TWOPI and coverted DEG2RAD and RAD2DEG two decimal constants (from division expresions)

The mathematical constant E

Referenced by Isis::InlineCalculator::eConstant(), Isis::Matrix::Eigenvalues(), Isis::Matrix::Eigenvectors(), Isis::NoOperator::Interest(), Isis::EquatorialCylindricalShape::intersectSurface(), Isis::RobustFloatCompare< K >::operator()(), Isis::Orthographic::Orthographic(), Isis::CubeCalculator::prepareCalculations(), Isis::LunarAzimuthalEqualArea::SetCoordinate(), Isis::MocWideAngleDistortionMap::SetFocalPlane(), Isis::MarciDistortionMap::SetFocalPlane(), Isis::TaylorCameraDistortionMap::SetFocalPlane(), Isis::CameraDistortionMap::SetFocalPlane(), Isis::LoHighDistortionMap::SetFocalPlane(), Isis::LunarAzimuthalEqualArea::SetGround(), Isis::MocWideAngleDistortionMap::SetUndistortedFocalPlane(), Isis::MarciDistortionMap::SetUndistortedFocalPlane(), Isis::CameraDistortionMap::SetUndistortedFocalPlane(), Isis::LoHighDistortionMap::SetUndistortedFocalPlane(), and Isis::LoMediumDistortionMap::SetUndistortedFocalPlane().

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
History:
2003-05-16 Stuart Sides - Modified schema from astrogeology... isis.astrogeology...
History:
2006-03-18 Elizabeth Miller - Added gui helper stuff
History:
2006-05-17 Elizabeth Miller - Removed .xml and documented .h file

Definition at line 87 of file Isis.h.

Referenced by main().