Isis Developer Reference
ExportDescription.h
Go to the documentation of this file.
1 #ifndef ExportDescription_h
2 #define ExportDescription_h
3 
9 /* SPDX-License-Identifier: CC0-1.0 */
10 
11 #include "CubeAttribute.h"
12 #include "FileName.h"
13 #include "PixelType.h"
14 
15 namespace Isis {
44  public:
59  public:
61 
63  virtual ~ChannelDescription() {};
64 
65  FileName filename() const;
67 
68  void setInputRange(double min, double max);
69  double inputMinimum() const;
70  double inputMaximum() const;
71  bool hasCustomRange() const;
72 
73  private:
75  FileName m_filename;
76 
78  CubeAttributeInput m_att;
79 
81  bool m_customRange;
82 
84  double m_inputMin;
85 
87  double m_inputMax;
88  };
89 
90  public:
92  ExportDescription(const ExportDescription &descriptionToCopy);
93  virtual ~ExportDescription();
94  ExportDescription &operator=(const ExportDescription &descriptionToCopy);
95 
96  void setPixelType(PixelType type);
97  PixelType pixelType() const;
98  double outputPixelNull() const;
99  double outputPixelValidMin() const;
100  double outputPixelValidMax() const;
101  double outputPixelAbsoluteMin() const;
102  double outputPixelAbsoluteMax() const;
103 
104  int addChannel(FileName filename, CubeAttributeInput &att);
105  int addChannel(FileName filename, CubeAttributeInput &att, double min, double max);
106  const ChannelDescription &channel(int i) const;
107  int channelCount() const;
108 
109  private:
111  PixelType m_type;
112 
113  double m_outputPixelNull;
115  double m_outputPixelValidMin;
117  double m_outputPixelValidMax;
119  double m_outputPixelAbsoluteMin;
122  double m_outputPixelAbsoluteMax;
126  QList<ChannelDescription *> *m_channels;
128  };
129 };
130 
131 
132 #endif
Isis::ExportDescription::channelCount
int channelCount() const
Count of the number of channels in the description.
Definition: ExportDescription.cpp:258
FileName.h
Isis::ExportDescription::outputPixelNull
double outputPixelNull() const
Returns the output pixel value for Null DNs.
Definition: ExportDescription.cpp:158
QList
This is free and unencumbered software released into the public domain.
Definition: BoxcarCachingAlgorithm.h:13
Isis::FileName
File name manipulation and expansion.
Definition: FileName.h:100
Isis::ExportDescription::outputPixelAbsoluteMin
double outputPixelAbsoluteMin() const
Returns the absolute minimum value for output pixels.
Definition: ExportDescription.cpp:188
Isis::ExportDescription::addChannel
int addChannel(FileName filename, CubeAttributeInput &att)
Add an export color channel for the given input cube and attributes (typically band number).
Definition: ExportDescription.cpp:212
Isis::ExportDescription::ChannelDescription
Describes how a cube as a single color channel to be exported.
Definition: ExportDescription.h:58
Isis::ExportDescription::channel
const ChannelDescription & channel(int i) const
Return the channels description at the given index.
Definition: ExportDescription.cpp:247
Isis::UnsignedWord
@ UnsignedWord
Definition: PixelType.h:31
Isis::ExportDescription
Describes how a series of cubes should be exported.
Definition: ExportDescription.h:43
Isis::ExportDescription::outputPixelAbsoluteMax
double outputPixelAbsoluteMax() const
Returns the absolute maximum value for output pixels.
Definition: ExportDescription.cpp:198
Isis::ExportDescription::operator=
ExportDescription & operator=(const ExportDescription &descriptionToCopy)
Assignment operator for the export description.
Definition: ExportDescription.cpp:66
Isis::SignedWord
@ SignedWord
Definition: PixelType.h:32
Isis::ExportDescription::ChannelDescription::filename
FileName filename() const
Returns a copy of the filename associated with this channel.
Definition: ExportDescription.cpp:286
Isis::ExportDescription::ChannelDescription::attributes
CubeAttributeInput attributes() const
Returns a copy of the input attributes associated with this channel.
Definition: ExportDescription.cpp:296
Isis::toString
QString toString(bool boolToConvert)
Global function to convert a boolean to a string.
Definition: IString.cpp:211
IString.h
Isis::ExportDescription::ExportDescription
ExportDescription()
Construct the export description.
Definition: ExportDescription.cpp:22
Isis::ExportDescription::ChannelDescription::setInputRange
void setInputRange(double min, double max)
Sets the input range for this channel.
Definition: ExportDescription.cpp:309
Isis::ExportDescription::pixelType
PixelType pixelType() const
Returns the pixel type.
Definition: ExportDescription.cpp:148
PixelType.h
Isis::ExportDescription::setPixelType
void setPixelType(PixelType type)
Set the pixel type for the output image.
Definition: ExportDescription.cpp:106
_FILEINFO_
#define _FILEINFO_
Macro for the filename and line number.
Definition: IException.h:24
ExportDescription.h
Isis::ExportDescription::ChannelDescription::ChannelDescription
ChannelDescription(FileName &filename, CubeAttributeInput &att)
Construct the channel description with the given input name and attributes.
Definition: ExportDescription.cpp:269
Isis::ExportDescription::ChannelDescription::inputMinimum
double inputMinimum() const
Returns the input minimum for this channel.
Definition: ExportDescription.cpp:323
Isis::ExportDescription::ChannelDescription::hasCustomRange
bool hasCustomRange() const
Returns true if the user of this instance has set a custom input range for this channel.
Definition: ExportDescription.cpp:345
Isis::IException
Isis exception class.
Definition: IException.h:91
Isis::ExportDescription::outputPixelValidMax
double outputPixelValidMax() const
Returns the output pixel value for the valid maximum.
Definition: ExportDescription.cpp:178
Isis::ExportDescription::outputPixelValidMin
double outputPixelValidMin() const
Returns the output pixel value for the valid minimum.
Definition: ExportDescription.cpp:168
Isis::PixelType
PixelType
Enumerations for Isis Pixel Types.
Definition: PixelType.h:27
IException.h
Isis::ExportDescription::~ExportDescription
virtual ~ExportDescription()
Destruct the export description.
Definition: ExportDescription.cpp:93
Isis::IException::Programmer
@ Programmer
This error is for when a programmer made an API call that was illegal.
Definition: IException.h:146
Isis::ExportDescription::ChannelDescription::inputMaximum
double inputMaximum() const
Returns the input maximum for this channel.
Definition: ExportDescription.cpp:334
Isis::ExportDescription::ChannelDescription::~ChannelDescription
virtual ~ChannelDescription()
Destruct the export description.
Definition: ExportDescription.h:63
Isis::CubeAttributeInput
Manipulate and parse attributes of input cube filenames.
Definition: CubeAttribute.h:381
Isis::UnsignedByte
@ UnsignedByte
Definition: PixelType.h:29
CubeAttribute.h
Isis
This is free and unencumbered software released into the public domain.
Definition: Apollo.h:16
Isis::None
@ None
Definition: PixelType.h:28