Isis 3.0 Programmer Reference
Back | Home
ExportDescription.h
Go to the documentation of this file.
1 #ifndef ExportDescription_h
2 #define ExportDescription_h
3 
27 #include "CubeAttribute.h"
28 #include "FileName.h"
29 #include "PixelType.h"
30 
31 namespace Isis {
60  public:
75  public:
77 
79  virtual ~ChannelDescription() {};
80 
81  FileName filename() const;
83 
84  void setInputRange(double min, double max);
85  double inputMinimum() const;
86  double inputMaximum() const;
87  bool hasCustomRange() const;
88 
89  private:
92 
95 
98 
100  double m_inputMin;
101 
103  double m_inputMax;
104  };
105 
106  public:
108  ExportDescription(const ExportDescription &descriptionToCopy);
109  virtual ~ExportDescription();
110  ExportDescription &operator=(const ExportDescription &descriptionToCopy);
111 
112  void setPixelType(PixelType type);
113  PixelType pixelType() const;
114  double outputPixelNull() const;
115  double outputPixelValidMin() const;
116  double outputPixelValidMax() const;
117  double outputPixelAbsoluteMin() const;
118  double outputPixelAbsoluteMax() const;
119 
120  int addChannel(FileName filename, CubeAttributeInput &att);
121  int addChannel(FileName filename, CubeAttributeInput &att, double min, double max);
122  const ChannelDescription &channel(int i) const;
123  int channelCount() const;
124 
125  private:
128 
144  };
145 };
146 
147 
148 #endif
Manipulate and parse attributes of input cube filenames.
virtual ~ExportDescription()
Destruct the export description.
CubeAttributeInput m_att
Attributes like which band to use from the input cube.
double m_outputPixelValidMin
Value to which minimum valid DNs will be mapped in the exported image file, defaults to 0...
virtual ~ChannelDescription()
Destruct the export description.
File name manipulation and expansion.
Definition: FileName.h:111
PixelType pixelType() const
Returns the pixel type.
double m_inputMax
Maximum DN in the input, defaults to DBL_MAX.
double m_outputPixelAbsoluteMin
The smallest allowed pixel value in the exported image file.
bool m_customRange
Whether or not the user has specified a custom input DN range.
double outputPixelValidMax() const
Returns the output pixel value for the valid maximum.
ChannelDescription(FileName &filename, CubeAttributeInput &att)
Construct the channel description with the given input name and attributes.
int channelCount() const
Count of the number of channels in the description.
PixelType m_type
Pixel type to export the data to, defaults to None.
PixelType
Enumerations for Isis Pixel Types.
Definition: PixelType.h:43
FileName filename() const
Returns a copy of the filename associated with this channel.
FileName m_filename
Input filename of the cube to be treated as a color 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.
double outputPixelValidMin() const
Returns the output pixel value for the valid minimum.
int addChannel(FileName filename, CubeAttributeInput &att)
Add an export color channel for the given input cube and attributes (typically band number)...
const ChannelDescription & channel(int i) const
Return the channels description at the given index.
QList< ChannelDescription * > * m_channels
List of color channels to be exported into the output image.
double m_outputPixelValidMax
Value to which maximum valid DNs will be mapped in the exported image file, defaults to 255...
double outputPixelAbsoluteMin() const
Returns the absolute minimum value for output pixels.
void setInputRange(double min, double max)
Sets the input range for this channel.
Describes how a series of cubes should be exported.
CubeAttributeInput attributes() const
Returns a copy of the input attributes associated with this channel.
ExportDescription & operator=(const ExportDescription &descriptionToCopy)
Assignment operator for the export description.
Describes how a cube as a single color channel to be exported.
double m_outputPixelNull
Value to which Null DNs will be mapped in the exported image file, defaults to 0.0.
ExportDescription()
Construct the export description.
double outputPixelNull() const
Returns the output pixel value for Null DNs.
void setPixelType(PixelType type)
Set the pixel type for the output image.
double inputMinimum() const
Returns the input minimum for this channel.
double outputPixelAbsoluteMax() const
Returns the absolute maximum value for output pixels.
double m_outputPixelAbsoluteMax
The largest allowed pixel value in the exported image file.
double m_inputMin
Minimum DN in the input, defaults to DBL_MIN.

U.S. Department of the Interior | U.S. Geological Survey
ISIS | Privacy & Disclaimers | Astrogeology Research Program
To contact us, please post comments and questions on the ISIS Support Center
File Modified: 07/12/2023 23:17:58