Loading [MathJax]/jax/output/NativeMML/config.js
Isis 3 Developer Reference
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:
91  FileName m_filename;
92 
94  CubeAttributeInput m_att;
95 
97  bool m_customRange;
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:
127  PixelType m_type;
128 
129  double m_outputPixelNull;
131  double m_outputPixelValidMin;
133  double m_outputPixelValidMax;
135  double m_outputPixelAbsoluteMin;
138  double m_outputPixelAbsoluteMax;
142  QList<ChannelDescription *> *m_channels;
144  };
145 };
146 
147 
148 #endif
double inputMaximum() const
Returns the input maximum for this channel.
Definition: ExportDescription.cpp:329
Manipulate and parse attributes of input cube filenames.
Definition: CubeAttribute.h:397
virtual ~ExportDescription()
Destruct the export description.
Definition: ExportDescription.cpp:88
double outputPixelValidMax() const
Returns the output pixel value for the valid maximum.
Definition: ExportDescription.cpp:173
virtual ~ChannelDescription()
Destruct the export description.
Definition: ExportDescription.h:79
File name manipulation and expansion.
Definition: FileName.h:116
ChannelDescription(FileName &filename, CubeAttributeInput &att)
Construct the channel description with the given input name and attributes.
Definition: ExportDescription.cpp:264
double inputMinimum() const
Returns the input minimum for this channel.
Definition: ExportDescription.cpp:318
double outputPixelNull() const
Returns the output pixel value for Null DNs.
Definition: ExportDescription.cpp:153
PixelType
Enumerations for Isis Pixel Types.
Definition: PixelType.h:43
double outputPixelAbsoluteMin() const
Returns the absolute minimum value for output pixels.
Definition: ExportDescription.cpp:183
int addChannel(FileName filename, CubeAttributeInput &att)
Add an export color channel for the given input cube and attributes (typically band number)...
Definition: ExportDescription.cpp:207
void setInputRange(double min, double max)
Sets the input range for this channel.
Definition: ExportDescription.cpp:304
Describes how a series of cubes should be exported.
Definition: ExportDescription.h:59
ExportDescription & operator=(const ExportDescription &descriptionToCopy)
Assignment operator for the export description.
Definition: ExportDescription.cpp:61
Describes how a cube as a single color channel to be exported.
Definition: ExportDescription.h:74
FileName filename() const
Returns a copy of the filename associated with this channel.
Definition: ExportDescription.cpp:281
ExportDescription()
Construct the export description.
Definition: ExportDescription.cpp:17
PixelType pixelType() const
Returns the pixel type.
Definition: ExportDescription.cpp:143
int channelCount() const
Count of the number of channels in the description.
Definition: ExportDescription.cpp:253
void setPixelType(PixelType type)
Set the pixel type for the output image.
Definition: ExportDescription.cpp:101
Definition: BoxcarCachingAlgorithm.h:29
Namespace for ISIS/Bullet specific routines.
Definition: Apollo.h:31
bool hasCustomRange() const
Returns true if the user of this instance has set a custom input range for this channel.
Definition: ExportDescription.cpp:340
const ChannelDescription & channel(int i) const
Return the channels description at the given index.
Definition: ExportDescription.cpp:242
double outputPixelAbsoluteMax() const
Returns the absolute maximum value for output pixels.
Definition: ExportDescription.cpp:193
CubeAttributeInput attributes() const
Returns a copy of the input attributes associated with this channel.
Definition: ExportDescription.cpp:291
double outputPixelValidMin() const
Returns the output pixel value for the valid minimum.
Definition: ExportDescription.cpp:163

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 USGS Astrogeology Discussion Board
To report a bug, or suggest a feature go to: ISIS Github
File Modified: 07/12/2023 23:18:20