Isis 3 Programmer Reference
ExportDescription.h
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
15namespace 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:
76
79
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:
112
127 QList<ChannelDescription *> *m_channels;
128 };
129};
130
131
132#endif
Manipulate and parse attributes of input cube filenames.
Describes how a cube as a single color channel to be exported.
double inputMinimum() const
Returns the input minimum for this channel.
CubeAttributeInput m_att
Attributes like which band to use from the input cube.
void setInputRange(double min, double max)
Sets the input range for this channel.
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 inputMaximum() const
Returns the input maximum for this channel.
FileName m_filename
Input filename of the cube to be treated as a color channel.
ChannelDescription(FileName &filename, CubeAttributeInput &att)
Construct the channel description with the given input name and attributes.
bool hasCustomRange() const
Returns true if the user of this instance has set a custom input range for this channel.
FileName filename() const
Returns a copy of the filename associated with this channel.
virtual ~ChannelDescription()
Destruct the export description.
double m_inputMax
Maximum DN in the input, defaults to DBL_MAX.
CubeAttributeInput attributes() const
Returns a copy of the input attributes associated with this channel.
Describes how a series of cubes should be exported.
ExportDescription()
Construct the export description.
PixelType m_type
Pixel type to export the data to, defaults to None.
double m_outputPixelNull
Value to which Null DNs will be mapped in the exported image file, defaults to 0.0.
int addChannel(FileName filename, CubeAttributeInput &att)
Add an export color channel for the given input cube and attributes (typically band number).
QList< ChannelDescription * > * m_channels
List of color channels to be exported into the output image.
const ChannelDescription & channel(int i) const
Return the channels description at the given index.
double outputPixelAbsoluteMax() const
Returns the absolute maximum value for output pixels.
double outputPixelValidMin() const
Returns the output pixel value for the valid minimum.
double outputPixelAbsoluteMin() const
Returns the absolute minimum value for output pixels.
double m_outputPixelAbsoluteMin
The smallest allowed pixel value in the exported image file.
double m_outputPixelAbsoluteMax
The largest allowed pixel value in the exported image file.
PixelType pixelType() const
Returns the pixel type.
int channelCount() const
Count of the number of channels in the description.
double outputPixelNull() const
Returns the output pixel value for Null DNs.
void setPixelType(PixelType type)
Set the pixel type for the output image.
ExportDescription & operator=(const ExportDescription &descriptionToCopy)
Assignment operator for the export description.
double outputPixelValidMax() const
Returns the output pixel value for the valid maximum.
double m_outputPixelValidMin
Value to which minimum valid DNs will be mapped in the exported image file, defaults to 0....
virtual ~ExportDescription()
Destruct the export description.
double m_outputPixelValidMax
Value to which maximum valid DNs will be mapped in the exported image file, defaults to 255....
File name manipulation and expansion.
Definition FileName.h:100
This is free and unencumbered software released into the public domain.
Definition Apollo.h:16
PixelType
Enumerations for Isis Pixel Types.
Definition PixelType.h:27