Isis::ExportDescription::ChannelDescription Class Reference

Describes how a cube as a single color channel to be exported. More...

#include <ExportDescription.h>

Collaboration diagram for Isis::ExportDescription::ChannelDescription:

Public Member Functions
	ChannelDescription (FileName &filename, CubeAttributeInput &att)
	Construct the channel description with the given input name and attributes. More...
virtual	~ChannelDescription ()
	Destruct the export description. More...
FileName	filename () const
	Returns a copy of the filename associated with this channel. More...
CubeAttributeInput	attributes () const
	Returns a copy of the input attributes associated with this channel. More...
void	setInputRange (double min, double max)
	Sets the input range for this channel. More...
double	inputMinimum () const
	Returns the input minimum for this channel. More...
double	inputMaximum () const
	Returns the input maximum for this channel. More...
bool	hasCustomRange () const
	Returns true if the user of this instance has set a custom input range for this channel. More...

Private Attributes
FileName	m_filename
	Input filename of the cube to be treated as a color channel. More...
CubeAttributeInput	m_att
	Attributes like which band to use from the input cube. More...
bool	m_customRange
	Whether or not the user has specified a custom input DN range. More...
double	m_inputMin
	Minimum DN in the input, defaults to DBL_MIN. More...
double	m_inputMax
	Maximum DN in the input, defaults to DBL_MAX. More...

Detailed Description

Describes how a cube as a single color channel to be exported.

Specifies the filename, attributes, and input DN range of a cube to be exported as a color channel in a standard image.

Author

2012-04-03 Travis Addair

Definition at line 74 of file ExportDescription.h.

Constructor & Destructor Documentation

ChannelDescription()

Isis::ExportDescription::ChannelDescription::ChannelDescription	(	FileName &	filename,
		CubeAttributeInput &	att
	)

Construct the channel description with the given input name and attributes.

Parameters

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

Definition at line 264 of file ExportDescription.cpp.

References filename(), m_att, m_customRange, m_filename, m_inputMax, and m_inputMin.

~ChannelDescription()

virtual Isis::ExportDescription::ChannelDescription::~ChannelDescription ( )

inlinevirtual

Destruct the export description.

Definition at line 79 of file ExportDescription.h.

Member Function Documentation

attributes()

CubeAttributeInput Isis::ExportDescription::ChannelDescription::attributes

(

)

const

Returns a copy of the input attributes associated with this channel.

Returns

The cube attributes such as band number

Definition at line 291 of file ExportDescription.cpp.

Referenced by Isis::ImageExporter::addChannel(), Isis::ExportDescription::ExportDescription(), and Isis::ExportDescription::operator=().

filename()

FileName Isis::ExportDescription::ChannelDescription::filename

(

)

const

Returns a copy of the filename associated with this channel.

Returns

The name of the cube

Definition at line 281 of file ExportDescription.cpp.

Referenced by Isis::ImageExporter::addChannel(), ChannelDescription(), Isis::ExportDescription::ExportDescription(), and Isis::ExportDescription::operator=().

hasCustomRange()

bool Isis::ExportDescription::ChannelDescription::hasCustomRange

(

)

const

Returns true if the user of this instance has set a custom input range for this channel.

Returns

True if a custom range has been set, false otherwise

Definition at line 340 of file ExportDescription.cpp.

Referenced by Isis::ImageExporter::addChannel(), Isis::ExportDescription::ExportDescription(), and Isis::ExportDescription::operator=().

inputMaximum()

double Isis::ExportDescription::ChannelDescription::inputMaximum

(

)

const

Returns the input maximum for this channel.

Any value of max in the input cube will be mapped to the output max of the output channel.

Returns

The maximum DN in the input mapped to the maximum of the output

Definition at line 329 of file ExportDescription.cpp.

Referenced by Isis::ImageExporter::addChannel(), Isis::ExportDescription::ExportDescription(), and Isis::ExportDescription::operator=().

inputMinimum()

double Isis::ExportDescription::ChannelDescription::inputMinimum

(

)

const

Returns the input minimum for this channel.

Any value of min in the input cube will be mapped to the output min of the output channel.

Returns

The minimum DN in the input mapped to the minimum of the output

Definition at line 318 of file ExportDescription.cpp.

Referenced by Isis::ImageExporter::addChannel(), Isis::ExportDescription::ExportDescription(), and Isis::ExportDescription::operator=().

setInputRange()

void Isis::ExportDescription::ChannelDescription::setInputRange	(	double	min,
		double	max
	)

Sets the input range for this channel.

Any value of min in the input cube will be mapped to the output min of the output channel. Similar for the max.

Parameters

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

Definition at line 304 of file ExportDescription.cpp.

Referenced by Isis::ExportDescription::addChannel().

Member Data Documentation

m_att

CubeAttributeInput Isis::ExportDescription::ChannelDescription::m_att

private

Attributes like which band to use from the input cube.

Definition at line 94 of file ExportDescription.h.

Referenced by ChannelDescription().

m_customRange

bool Isis::ExportDescription::ChannelDescription::m_customRange

private

Whether or not the user has specified a custom input DN range.

Definition at line 97 of file ExportDescription.h.

Referenced by ChannelDescription().

m_filename

FileName Isis::ExportDescription::ChannelDescription::m_filename

private

Input filename of the cube to be treated as a color channel.

Definition at line 91 of file ExportDescription.h.

Referenced by ChannelDescription().

m_inputMax

double Isis::ExportDescription::ChannelDescription::m_inputMax

private

Maximum DN in the input, defaults to DBL_MAX.

Definition at line 103 of file ExportDescription.h.

Referenced by ChannelDescription().

m_inputMin

double Isis::ExportDescription::ChannelDescription::m_inputMin

private

Minimum DN in the input, defaults to DBL_MIN.

Definition at line 100 of file ExportDescription.h.

Referenced by ChannelDescription().

---

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

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