Classes
struct	RawIO
struct	StdIO
struct	CubeDims
class	CubeIoPolicy
class	FileHandler
class	FileRepository
class	iFile
struct	DeleteObject
class	PvlSpecs
	Container defines a Pvl path element such as Group, Object and Keyword. More...
class	KeywordHandler
	Keyword construct handler. More...
class	PropagationHandler
Typedefs
typedef CubeIoPolicy< double, IDL::IdlDouble, StdIO >	DoubleIO
typedef CubeIoPolicy< unsigned char, IDL::IdlByte, RawIO >	ByteIO
typedef CubeIoPolicy< short int, IDL::IdlInt2, RawIO >	WordIO
typedef CubeIoPolicy< float, IDL::IdlFloat, RawIO >	FloatIO
typedef int(*	IsisDlmInit )(IdlDlm &idl)
Functions
template<class T >
void	FetchData (T &reader, Isis::Cube &cube, const IDL::ArrayDims &dims, const std::string &vname, IDL::IdlVariable &vData)
template<class T >
void	PutData (T &writer, Isis::Cube &cube, const IDL::ArrayDims &dims, IDL::IdlVariable &vData)
PvlGroup	setAlphaCube (Cube icube, Cube ocube, const CubeDims &specs)
std::string	Usage ()
int	isis_add_aggregate_init (IdlDlm &idl)
int	isis_add_aggregate (const IdlRtnDef &rtn, const IdlParameters &input, IdlParameters &output)
int	isis_add_key_init (IdlDlm &idl)
int	isis_add_key (const IdlRtnDef &rtn, const IdlParameters &input, IdlParameters &output)
int	isis_close_init (IdlDlm &idl)
int	isis_close (const IdlRtnDef &rtn, const IdlParameters &input, IdlParameters &output)
int	isis_create_init (IdlDlm &idl)
int	isis_create (const IdlRtnDef &rtn, const IdlParameters &input, IdlParameters &output)
int	isis_delete_aggregate_init (IdlDlm &idl)
int	isis_delete_aggregate (const IdlRtnDef &rtn, const IdlParameters &input, IdlParameters &output)
int	isis_get_key_init (IdlDlm &idl)
int	isis_get_key (const IdlRtnDef &rtn, const IdlParameters &input, IdlParameters &output)
int	isis_open_init (IdlDlm &idl)
int	isis_open (const IdlRtnDef &rtn, const IdlParameters &input, IdlParameters &output)
int	isis_query_init (IdlDlm &idl)
void	show_file_data (const IdlRtnDef &rtn, iFile &file)
int	isis_query (const IdlRtnDef &rtn, const IdlParameters &input, IdlParameters &output)
int	isis_query_key_init (IdlDlm &idl)
int	isis_query_key (const IdlRtnDef &rtn, const IdlParameters &input, IdlParameters &output)
int	isis_read_init (IdlDlm &idl)
int	isis_read (const IdlRtnDef &rtn, const IdlParameters &input, IdlParameters &output)
int	isis_read_blob_init (IdlDlm &idl)
int	isis_read_blob (const IdlRtnDef &rtn, const IdlParameters &input, IdlParameters &output)
int	isis_read_brick_init (IdlDlm &idl)
int	isis_read_brick (const IdlRtnDef &rtn, const IdlParameters &input, IdlParameters &output)
int	isis_read_image_init (IdlDlm &idl)
int	isis_read_image (const IdlRtnDef &rtn, const IdlParameters &input, IdlParameters &output)
int	isis_special_pixels_init (IdlDlm &idl)
int	isis_special_pixels (const IdlRtnDef &rtn, const IdlParameters &input, IdlParameters &output)
int	isis_write_init (IdlDlm &idl)
int	isis_write (const IdlRtnDef &rtn, const IdlParameters &input, IdlParameters &output)
int	isis_write_image_init (IdlDlm &idl)
int	isis_write_image (const IdlRtnDef &rtn, const IdlParameters &input, IdlParameters &output)

Detailed Description

IsisDlm.h contains definitions used in the implementation of the ISIS DLM toolkit.

Id:: IsisDlm.h,v 1.2 2004/09/09 18:47:26 kbecker Exp

ISISDLM namespace wrapper for all IsisDlm code All components used in this IsisDlm system will reside in this unique namespace

Typedef Documentation

typedef CubeIoPolicy<unsigned char, IDL::IdlByte, RawIO> ISISDLM::ByteIO

typedef CubeIoPolicy<double, IDL::IdlDouble, StdIO> ISISDLM::DoubleIO

typedef CubeIoPolicy<float, IDL::IdlFloat, RawIO> ISISDLM::FloatIO

typedef int(* ISISDLM::IsisDlmInit)(IdlDlm &idl)

Define an IDL DLM initialization routine This definition should be used to declare all routines that are to visable to IDL calling environment.

typedef CubeIoPolicy<short int, IDL::IdlInt2, RawIO> ISISDLM::WordIO

Function Documentation

template<class T >

void ISISDLM::FetchData	(	T &	reader,
		Isis::Cube &	cube,
		const IDL::ArrayDims &	dims,
		const std::string &	vname,
		IDL::IdlVariable &	vData
	)

Routine to read generalized data type This routine is used to read all kinds of data types

Referenced by isis_read(), isis_read_brick(), and isis_read_image().

int ISISDLM::isis_add_aggregate	(	const IdlRtnDef &	rtn,
		const IdlParameters &	input,
		IdlParameters &	output
	)

Performs initialization of isis_add_aggregate routine

Parameters:

rtn	Provides the function definition as specified in isis_add_aggregate_init
input	Contains a list of the input parameters
output	Will receive the parameters being passed back to IDL user

Returns:: 0 if successful, 1 otherwise

References Usage().

Referenced by isis_add_aggregate_init().

Here is the call graph for this function:

int ISISDLM::isis_add_aggregate_init ( IdlDlm & idl )

Performs initialization of isis_add_aggregate routine The isis_add_aggregate_init function defines the isis_add_aggregate routine and registers it to the IDL DLM toolkit.

Parameters:

idl	IDL DLM interface

Returns:: 0 if successful, 1 otherwise

References isis_add_aggregate().

Here is the call graph for this function:

int ISISDLM::isis_add_key	(	const IdlRtnDef &	rtn,
		const IdlParameters &	input,
		IdlParameters &	output
	)

Performs initialization of isis_add_key routine

Parameters:

rtn	Provides the function definition as specified in isis_add_key_init
input	Contains a list of the input parameters
output	Will receive the parameters being passed back to IDL user

Returns:: 0 if successful, 1 otherwise

Referenced by isis_add_key_init().

int ISISDLM::isis_add_key_init ( IdlDlm & idl )

Performs initialization of isis_query routine The isis_add_key_init function defines the isis_add_key routine and registers it to the IDL DLM toolkit.

Parameters:

idl	IDL DLM interface

Returns:: 0 if successful, 1 otherwise

References isis_add_key().

Here is the call graph for this function:

int ISISDLM::isis_close	(	const IdlRtnDef &	rtn,
		const IdlParameters &	input,
		IdlParameters &	output
	)

Performs initialization of isis_close routine

Parameters:

rtn	Provides the function definition as specified in isis_close_init
input	Contains a list of the input parameters
output	Will receive the parameters being passed back to IDL user

Returns:: 0 if successful, 1 otherwise

References ISISDLM::FileRepository::Instance(), ISISDLM::FileRepository::removeFile(), and Usage().

Referenced by isis_close_init().

Here is the call graph for this function:

int ISISDLM::isis_close_init ( IdlDlm & idl )

Performs initialization of isis_close routine The isis_close_init function defines the isis_close routine and registers it to the IDL DLM toolkit.

Parameters:

idl	IDL DLM interface

Returns:: 0 if successful, 1 otherwise

References isis_close().

Here is the call graph for this function:

int ISISDLM::isis_create	(	const IdlRtnDef &	rtn,
		const IdlParameters &	input,
		IdlParameters &	output
	)

Performs initialization of isis_create routine

Parameters:

rtn	Provides the function definition as specified in isis_create_init
input	Contains a list of the input parameters
output	Will receive the parameters being passed back to IDL user

Returns:: 0 if successful, 1 otherwise

References ISISDLM::FileRepository::addCube(), ISISDLM::FileRepository::addPvl(), ISISDLM::FileHandler::CreateCube(), ISISDLM::FileHandler::CreatePvl(), ISISDLM::iFile::Cube(), ISISDLM::FileRepository::getFile(), ISISDLM::FileRepository::Instance(), ISISDLM::FileHandler::setAttached(), ISISDLM::FileHandler::setBsqCore(), ISISDLM::FileHandler::setCoreType(), ISISDLM::FileHandler::setCubeDims(), ISISDLM::FileHandler::setCubeSpecs(), ISISDLM::FileHandler::setDetached(), and Usage().

Referenced by isis_create_init().

Here is the call graph for this function:

int ISISDLM::isis_create_init ( IdlDlm & idl )

Performs initialization of isis_create routine The isis_create_init function defines the isis_create routine and registers it to the IDL DLM toolkit.

Parameters:

idl	IDL DLM interface

Returns:: 0 if successful, 1 otherwise

References isis_create().

Here is the call graph for this function:

int ISISDLM::isis_delete_aggregate	(	const IdlRtnDef &	rtn,
		const IdlParameters &	input,
		IdlParameters &	output
	)

Performs initialization of isis_delete_aggregate routine

Parameters:

rtn	Provides the function definition as specified in isis_delete_aggregate_init
input	Contains a list of the input parameters
output	Will receive the parameters being passed back to IDL user

Returns:: 0 if successful, 1 otherwise

References Usage().

Referenced by isis_delete_aggregate_init().

Here is the call graph for this function:

int ISISDLM::isis_delete_aggregate_init ( IdlDlm & idl )

Performs initialization of isis_delete_aggregate routine The isis_delete_aggregate_init function defines the isis_delete_aggregate routine and registers it to the IDL DLM toolkit.

Parameters:

idl	IDL DLM interface

Returns:: 0 if successful, 1 otherwise

References isis_delete_aggregate().

Here is the call graph for this function:

int ISISDLM::isis_get_key	(	const IdlRtnDef &	rtn,
		const IdlParameters &	input,
		IdlParameters &	output
	)

Performs initialization of isis_get_key routine

Parameters:

rtn	Provides the function definition as specified in isis_get_key_init
input	Contains a list of the input parameters
output	Will receive the parameters being passed back to IDL user

Returns:: 0 if successful, 1 otherwise

References ISISDLM::FileRepository::getFile(), ISISDLM::iFile::Pvl(), ISISDLM::KeywordHandler::read(), and Usage().

Referenced by isis_get_key_init().

Here is the call graph for this function:

int ISISDLM::isis_get_key_init ( IdlDlm & idl )

Performs initialization of isis_query routine The isis_get_key_init function defines the isis_get_key routine and registers it to the IDL DLM toolkit.

Parameters:

idl	IDL DLM interface

Returns:: 0 if successful, 1 otherwise

References isis_get_key().

Here is the call graph for this function:

int ISISDLM::isis_open	(	const IdlRtnDef &	rtn,
		const IdlParameters &	input,
		IdlParameters &	output
	)

Performs initialization of isis_open routine

Parameters:

rtn	Provides the function definition as specified in isis_open_init
input	Contains a list of the input parameters
output	Will receive the parameters being passed back to IDL user

Returns:: 0 if successful, 1 otherwise

References ISISDLM::FileRepository::Instance(), ISISDLM::FileHandler::OpenCube(), ISISDLM::FileHandler::OpenPvl(), and Usage().

Referenced by isis_open_init().

Here is the call graph for this function:

int ISISDLM::isis_open_init ( IdlDlm & idl )

Performs initialization of isis_open routine The isis_open_init function defines the isis_open routine and registers it to the IDL DLM toolkit.

Parameters:

idl	IDL DLM interface

Returns:: 0 if successful, 1 otherwise

References isis_open().

Here is the call graph for this function:

int ISISDLM::isis_query	(	const IdlRtnDef &	rtn,
		const IdlParameters &	input,
		IdlParameters &	output
	)

Performs initialization of isis_query routine

Parameters:

rtn	Provides the function definition as specified in isis_query_init
input	Contains a list of the input parameters
output	Will receive the parameters being passed back to IDL user

Returns:: 0 if successful, 1 otherwise

References ISISDLM::iFile::Cube(), ISISDLM::FileRepository::getFile(), ISISDLM::FileRepository::getNthFile(), ISISDLM::FileRepository::Instance(), ISISDLM::iFile::name(), show_file_data(), ISISDLM::FileRepository::size(), and Usage().

Referenced by isis_query_init().

Here is the call graph for this function:

int ISISDLM::isis_query_init ( IdlDlm & idl )

Performs initialization of isis_query routine The isis_query_init function defines the isis_query routine and registers it to the IDL DLM toolkit.

Parameters:

idl	IDL DLM interface

Returns:: 0 if successful, 1 otherwise

References isis_query().

Here is the call graph for this function:

int ISISDLM::isis_query_key	(	const IdlRtnDef &	rtn,
		const IdlParameters &	input,
		IdlParameters &	output
	)

Performs initialization of isis_query_key routine

Parameters:

rtn	Provides the function definition as specified in isis_query_key_init
input	Contains a list of the input parameters
output	Will receive the parameters being passed back to IDL user

Returns:: 0 if successful, 1 otherwise

References ISISDLM::FileRepository::getFile(), ISISDLM::FileRepository::Instance(), ISISDLM::iFile::Pvl(), ISISDLM::KeywordHandler::read(), and Usage().

Referenced by isis_query_key_init().

Here is the call graph for this function:

int ISISDLM::isis_query_key_init ( IdlDlm & idl )

Performs initialization of isis_query routine The isis_query_key_init function defines the isis_query_key routine and registers it to the IDL DLM toolkit.

Parameters:

idl	IDL DLM interface

Returns:: 0 if successful, 1 otherwise

References isis_query_key().

Here is the call graph for this function:

int ISISDLM::isis_read	(	const IdlRtnDef &	rtn,
		const IdlParameters &	input,
		IdlParameters &	output
	)

Performs initialization of isis_read routine

Parameters:

rtn	Provides the function definition as specified in isis_read_init
input	Contains a list of the input parameters
output	Will receive the parameters being passed back to IDL user

Returns:: 0 if successful, 1 otherwise

References ISISDLM::FileRepository::addCube(), FetchData(), ISISDLM::FileRepository::Instance(), and Usage().

Referenced by isis_read_init().

Here is the call graph for this function:

int ISISDLM::isis_read_blob	(	const IdlRtnDef &	rtn,
		const IdlParameters &	input,
		IdlParameters &	output
	)

Performs initialization of isis_read_blob routine

Parameters:

rtn	Provides the function definition as specified in isis_read_blob_init
input	Contains a list of the input parameters
output	Will receive the parameters being passed back to IDL user

Returns:: 0 if successful, 1 otherwise

References ISISDLM::FileRepository::getFile(), ISISDLM::FileRepository::Instance(), ISISDLM::iFile::name(), and Usage().

Referenced by isis_read_blob_init().

Here is the call graph for this function:

int ISISDLM::isis_read_blob_init ( IdlDlm & idl )

Performs initialization of isis_read_blob routine The isis_read_blob_init function defines the isis_read_blob routine and registers it to the IDL DLM toolkit.

Parameters:

idl	IDL DLM interface

Returns:: 0 if successful, 1 otherwise

References isis_read_blob().

Here is the call graph for this function:

int ISISDLM::isis_read_brick	(	const IdlRtnDef &	rtn,
		const IdlParameters &	input,
		IdlParameters &	output
	)

Performs initialization of isis_read_brick routine

Parameters:

rtn	Provides the function definition as specified in isis_read_brick_init
input	Contains a list of the input parameters
output	Will receive the parameters being passed back to IDL user

Returns:: 0 if successful, 1 otherwise

References ISISDLM::FileRepository::addCube(), ISISDLM::iFile::Cube(), FetchData(), ISISDLM::FileRepository::getFile(), ISISDLM::FileRepository::Instance(), ISISDLM::iFile::name(), ISISDLM::CubeDims::setBandSpecs(), ISISDLM::CubeDims::setLineSpecs(), ISISDLM::CubeDims::setSampleSpecs(), and Usage().

Referenced by isis_read_brick_init().

Here is the call graph for this function:

int ISISDLM::isis_read_brick_init ( IdlDlm & idl )

Performs initialization of isis_read_brick routine The isis_read_brick_init function defines the isis_read_brick routine and registers it to the IDL DLM toolkit.

Parameters:

idl	IDL DLM interface

Returns:: 0 if successful, 1 otherwise

References isis_read_brick().

Here is the call graph for this function:

int ISISDLM::isis_read_image	(	const IdlRtnDef &	rtn,
		const IdlParameters &	input,
		IdlParameters &	output
	)

Performs initialization of isis_read_image routine

Parameters:

rtn	Provides the function definition as specified in isis_read_image_init
input	Contains a list of the input parameters
output	Will receive the parameters being passed back to IDL user

Returns:: 0 if successful, 1 otherwise

References ISISDLM::FileRepository::addCube(), ISISDLM::iFile::Cube(), FetchData(), ISISDLM::FileRepository::getFile(), ISISDLM::FileRepository::Instance(), ISISDLM::iFile::name(), ISISDLM::CubeDims::setBandSpecs(), and Usage().

Referenced by isis_read_image_init().

Here is the call graph for this function:

int ISISDLM::isis_read_image_init ( IdlDlm & idl )

Performs initialization of isis_read_image routine The isis_read_image_init function defines the isis_read_image routine and registers it to the IDL DLM toolkit.

Parameters:

idl	IDL DLM interface

Returns:: 0 if successful, 1 otherwise

References isis_read_image().

Here is the call graph for this function:

int ISISDLM::isis_read_init ( IdlDlm & idl )

Performs initialization of isis_read routine The isis_read_init function defines the isis_read routine and registers it to the IDL DLM toolkit.

Parameters:

idl	IDL DLM interface

Returns:: 0 if successful, 1 otherwise

References isis_read().

Here is the call graph for this function:

int ISISDLM::isis_special_pixels	(	const IdlRtnDef &	rtn,
		const IdlParameters &	input,
		IdlParameters &	output
	)

Performs initialization of isis_special_pixels routine

Parameters:

rtn	Provides the function definition as specified in isis_special_pixels_init
input	Contains a list of the input parameters
output	Will receive the parameters being passed back to IDL user

Returns:: 0 if successful, 1 otherwise

References Usage().

Referenced by isis_special_pixels_init().

Here is the call graph for this function:

int ISISDLM::isis_special_pixels_init ( IdlDlm & idl )

Performs initialization of isis_special_pixels routine The isis_special_pixels_init function defines the isis_special_pixels routine and registers it to the IDL DLM toolkit.

Parameters:

idl	IDL DLM interface

Returns:: 0 if successful, 1 otherwise

References isis_special_pixels().

Here is the call graph for this function:

int ISISDLM::isis_write	(	const IdlRtnDef &	rtn,
		const IdlParameters &	input,
		IdlParameters &	output
	)

Performs initialization of isis_write routine

Parameters:

rtn	Provides the function definition as specified in isis_write_init
input	Contains a list of the input parameters
output	Will receive the parameters being passed back to IDL user

Returns:: 0 if successful, 1 otherwise

References ISISDLM::FileRepository::addCube(), ISISDLM::FileRepository::Instance(), PutData(), and Usage().

Referenced by isis_write_init().

Here is the call graph for this function:

int ISISDLM::isis_write_image	(	const IdlRtnDef &	rtn,
		const IdlParameters &	input,
		IdlParameters &	output
	)

Performs initialization of isis_write_image routine

Parameters:

rtn	Provides the function definition as specified in isis_write_image_init
input	Contains a list of the input parameters
output	Will receive the parameters being passed back to IDL user

Returns:: 0 if successful, 1 otherwise

References ISISDLM::FileRepository::addCube(), ISISDLM::iFile::Cube(), ISISDLM::FileRepository::getFile(), ISISDLM::FileRepository::Instance(), ISISDLM::iFile::name(), PutData(), ISISDLM::CubeDims::setBandSpecs(), and Usage().

Referenced by isis_write_image_init().

Here is the call graph for this function:

int ISISDLM::isis_write_image_init ( IdlDlm & idl )

Performs initialization of isis_write_image routine The isis_write_image_init function defines the isis_write_image routine and registers it to the IDL DLM toolkit.

References isis_write_image().

Here is the call graph for this function:

int ISISDLM::isis_write_init ( IdlDlm & idl )

Performs initialization of isis_write routine The isis_write_init function defines the isis_write routine and registers it to the IDL DLM toolkit.

Parameters:

idl	IDL DLM interface

Returns:: 0 if successful, 1 otherwise

References isis_write().

Here is the call graph for this function:

template<class T >

void ISISDLM::PutData	(	T &	writer,
		Isis::Cube &	cube,
		const IDL::ArrayDims &	dims,
		IDL::IdlVariable &	vData
	)

The write routine that interfaces with the ISIS I/O engines This routine is used to read all kinds of data types

Referenced by isis_write(), and isis_write_image().

PvlGroup ISISDLM::setAlphaCube	(	Cube *	icube,
		Cube *	ocube,
		const CubeDims &	specs
	)		`[inline]`

References ISISDLM::CubeDims::_nlines, ISISDLM::CubeDims::_nsamps, ISISDLM::CubeDims::_sline, and ISISDLM::CubeDims::_ssamp.

void ISISDLM::show_file_data	(	const IdlRtnDef &	rtn,
		iFile &	file
	)

References ISISDLM::iFile::Cube(), ISISDLM::iFile::getId(), and ISISDLM::iFile::name().

Referenced by isis_query().

Here is the call graph for this function:

std::string ISISDLM::Usage ( ) [inline]

Referenced by isis_add_aggregate(), isis_close(), isis_create(), isis_delete_aggregate(), isis_get_key(), isis_open(), isis_query(), isis_query_key(), isis_read(), isis_read_blob(), isis_read_brick(), isis_read_image(), isis_special_pixels(), isis_write(), and isis_write_image().

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation