Isis::ExportDescription Class Reference
[High Level Cube I/O]

Describes how a series of cubes should be exported. More...

#include <ExportDescription.h>

List of all members.

Classes
class	ChannelDescription
	Describes how a cube as a single color channel to be exported. More...
Public Member Functions
	ExportDescription ()
	Construct the export description.
virtual	~ExportDescription ()
	Destruct the export description.
void	setPixelType (PixelType type)
	Set the pixel type for the output image.
PixelType	getPixelType () const
	Returns the pixel type.
double	getOutputMinimum () const
	Returns the output minimum.
double	getOutputMaximum () const
	Returns the output maximum.
double	getOutputNull () const
	Returns the output value for Null pixels.
int	addChannel (FileName filename, CubeAttributeInput &att)
	Add an export color channel for the given input cube and attributes (typically band number).
int	addChannel (FileName filename, CubeAttributeInput &att, double min, double max)
	Add an export color channel for the given input cube, attributes (typically band number), and input DN range.
const ChannelDescription &	getChannel (int i) const
	Return the channels description at the given index.
int	channelCount () const
	Count of the number of channels in the description.

---

Detailed Description

Describes how a series of cubes should be exported.

This container class encapsulates the parameters required to specify how an Isis cube should be exported to a standard image format. This encapsulation is useful to applications like "isis2std" for passing its user parameters down to processing classes such as ImageExporters without needing to create new method signatures that take a growing list of parameters. The ExportDescription contains top-level data about the export as a whole, such as bit type. It also contains a list of ChannelDescriptions, each describing the input cubes, attributes, and DN ranges for a channel of color information (gray, red, blue, green, or alpha).

Author:

2012-04-03 Travis Addair

---

Constructor & Destructor Documentation

Isis::ExportDescription::ExportDescription

(

)

Construct the export description.

References Isis::None.

Isis::ExportDescription::~ExportDescription

(

)

[virtual]

Destruct the export description.

Also deletes the list of channels.

---

Member Function Documentation

int Isis::ExportDescription::addChannel	(	FileName	filename,
		CubeAttributeInput &	att,
		double	min,
		double	max
	)

Add an export color channel for the given input cube, attributes (typically band number), and input DN range.

Parameters:

	filename	The name of the cube
	att	The cube attributes such as band number
	min	The minimum DN in the input mapped to the minimum of the output
	max	The maximum DN in the input mapped to the maximum of the output

Returns:

The index of the newly added channel

References Isis::ExportDescription::ChannelDescription::setInputRange().

int Isis::ExportDescription::addChannel	(	FileName	filename,
		CubeAttributeInput &	att
	)

Add an export color channel for the given input cube and attributes (typically band number).

Parameters:

	filename	The name of the cube
	att	The cube attributes such as band number

Returns:

The index of the newly added channel

int Isis::ExportDescription::channelCount

(

)

const

Count of the number of channels in the description.

Returns:

The channel count

Referenced by Isis::ImageExporter::setInput().

const ExportDescription::ChannelDescription & Isis::ExportDescription::getChannel

(

int

i

)

const

Return the channels description at the given index.

Parameters:

i

Index of the desired channel

Returns:

Constant reference to the channel

double Isis::ExportDescription::getOutputMaximum

(

)

const

Returns the output maximum.

Defaults to 255.0 if not set by the user.

Returns:

The output maximum

Referenced by Isis::StreamExporter::setType().

double Isis::ExportDescription::getOutputMinimum

(

)

const

Returns the output minimum.

Defaults to 0.0 if not set by the user.

Returns:

The output minimum

Referenced by Isis::StreamExporter::setType().

double Isis::ExportDescription::getOutputNull

(

)

const

Returns the output value for Null pixels.

Defaults to 0.0 if not set by the user.

Returns:

The output value for Nulls

Referenced by Isis::StreamExporter::setType().

PixelType Isis::ExportDescription::getPixelType

(

)

const

Returns the pixel type.

Defaults to None if not set by the user.

Returns:

The pixel type: {None, UnsignedByte, SignedWord, UnsignedWord}

Referenced by Isis::StreamExporter::setType().

void Isis::ExportDescription::setPixelType

(

PixelType

type

)

Set the pixel type for the output image.

Automatically establishes valid output minimum, maximum, and null values based on the type.

Parameters:

type

The pixel type: {UnsignedByte, SignedWord, UnsignedWord}

References _FILEINFO_, Isis::IException::Programmer, Isis::SignedWord, Isis::toString(), Isis::UnsignedByte, and Isis::UnsignedWord.

---

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

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