Isis 3 Programmer Reference
Public Member Functions | Private Attributes | List of all members
Isis::ExportDescription::ChannelDescription Class Reference
High Level Cube I/O

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

#include <ExportDescription.h>

Collaboration diagram for Isis::ExportDescription::ChannelDescription:
Collaboration graph

Public Member Functions

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

Private Attributes

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

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 58 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
filenameThe name of the cube
attThe cube attributes such as band number

Definition at line 269 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 63 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 296 of file ExportDescription.cpp.

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

◆ 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 286 of file ExportDescription.cpp.

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

◆ 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 345 of file ExportDescription.cpp.

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

◆ 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 334 of file ExportDescription.cpp.

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

◆ 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 323 of file ExportDescription.cpp.

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

◆ 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
minThe minimum DN in the input mapped to the minimum of the output
maxThe maximum DN in the input mapped to the maximum of the output

Definition at line 309 of file ExportDescription.cpp.

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 78 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 81 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 75 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 87 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 84 of file ExportDescription.h.

Referenced by ChannelDescription().

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