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

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

#include <ExportDescription.h>

Collaboration diagram for Isis::ExportDescription:

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.
Private Attributes
PixelType	m_type
	Pixel type to export the data to, defaults to None.
double	m_outputMin
	Minimum DN in the output, defaults to 0.0.
double	m_outputMax
	Maximum DN in the output, defaults to 255.0.
double	m_outputNull
	DN value to output Null pixels to, defaults to 0.0.
QList< ChannelDescription * > *	m_channels
	List of color channels to be exported into the output image.

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

For internal use only.

History:: 2012-04-04 Travis Addair - Added documentation.

Definition at line 54 of file ExportDescription.h.

Constructor & Destructor Documentation

Isis::ExportDescription::ExportDescription ( )

Construct the export description.

Definition at line 13 of file ExportDescription.cpp.

References m_channels, m_outputMax, m_outputMin, m_outputNull, and m_type.

Isis::ExportDescription::~ExportDescription ( ) [virtual]

Destruct the export description.

Also deletes the list of channels.

Definition at line 27 of file ExportDescription.cpp.

References m_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