|
Isis 3.0 Developer's Reference (API) |
Home |
Export Isis cubes into standard formats. More...
#include <ImageExporter.h>
Inherited by Isis::QtExporter, and Isis::StreamExporter.
Public Member Functions | |
| ImageExporter () | |
| Construct the exporter. | |
| virtual | ~ImageExporter () |
| Destruct the exporter. | |
| void | operator() (vector< Buffer * > &in) const |
| The method for writing a line of input image data (with potentially several bands representing color channels) to the output image. | |
| virtual void | write (FileName outputName, int quality=100) |
| Export the Isis cube channels to the given standard image. | |
| int | samples () const |
| Number of samples (columns) in the output image. | |
| int | lines () const |
| Number of lines (rows) in the output image. | |
| int | bands () const |
| Number of bands (channels) in the output image. | |
| double | getInputMinimum (int channel) const |
| Returns the input minimum for the given channel. | |
| double | getInputMaximum (int channel) const |
| Returns the input maximum for the given channel. | |
| void | setOutputRange (double min, double max) |
| Set the input DN floor and ceiling. | |
| virtual void | setGrayscale (ExportDescription &desc)=0 |
| Pure virtual method for setting up an export to a grayscale image. | |
| virtual void | setRgb (ExportDescription &desc)=0 |
| Pure virtual method for setting up an export to an RGB image. | |
| virtual void | setRgba (ExportDescription &desc)=0 |
| Pure virtual method for setting up an export to an RGBA image. | |
Static Public Member Functions | |
| static ImageExporter * | fromFormat (QString format) |
| A static (factory) method for constructing an ImageExporter instance from an output format. | |
Protected Types | |
| typedef void(ImageExporter::* | WriteChannels )(vector< Buffer * > &in) const |
| Friendly alias for a method used to write a particular color channel. | |
Protected Member Functions | |
| void | setExtension (QString extension) |
| Sets the extension for the output image and generates the extension for the world file from it. | |
| Cube * | setInput (ExportDescription &desc) |
| Sets up the export process with the parameters described within the given description. | |
| ProcessExport & | getProcess () const |
| Get a reference to the process object, useful for subclasses to access and manipulate the process. | |
| virtual int | getPixel (double dn) const |
| Return the output clamped integer pixel value from the input double-precision DN. | |
| virtual void | writeGrayscale (vector< Buffer * > &in) const =0 |
| Pure virtual method for writing a line of grayscale data to the output image. | |
| virtual void | writeRgb (vector< Buffer * > &in) const =0 |
| Pure virtual method for writing a line of RGB data to the output image. | |
| virtual void | writeRgba (vector< Buffer * > &in) const =0 |
| Pure virtual method for writing a line of RGBA data to the output image. | |
Export Isis cubes into standard formats.
Abstract base class for a series of image exporters. Each exporter handles a specialized suite of standard image formats, and can be used as a black-box with the write() method, or for finer control, the importer can act as a functor in a ProcessExport routine.
typedef void(ImageExporter::* Isis::ImageExporter::WriteChannels)(vector< Buffer * > &in) const [protected] |
Friendly alias for a method used to write a particular color channel.
| Isis::ImageExporter::ImageExporter | ( | ) |
Construct the exporter.
| Isis::ImageExporter::~ImageExporter | ( | ) | [virtual] |
Destruct the exporter.
Also deletes the process object.
| int Isis::ImageExporter::bands | ( | ) | const |
Number of bands (channels) in the output image.
Referenced by Isis::TiffExporter::createBuffer(), Isis::JP2Exporter::createBuffer(), Isis::TiffExporter::setBuffer(), Isis::TiffExporter::write(), and Isis::JP2Exporter::write().
| ImageExporter * Isis::ImageExporter::fromFormat | ( | QString | format | ) | [static] |
A static (factory) method for constructing an ImageExporter instance from an output format.
The specific subclass of the returned instance is determined from the desired output image format provided. Each subclass has knowledge of whether or not it can write a particular format. Because the ability to export an image format is not mutually exclusive amongst exporters, the order of condieration here matters. For example, using a TIFF exporter takes precedence over a Qt exporter for TIFF images, because the former can process cubes greater than 2GB while the latter cannot. It is the caller's responsibility to delete the exporter instance when they are finished with it.
| format | The format for the output image to be created |
References _FILEINFO_, Isis::JP2Exporter::canWriteFormat(), Isis::QtExporter::canWriteFormat(), Isis::TiffExporter::canWriteFormat(), and Isis::IException::Programmer.
| double Isis::ImageExporter::getInputMaximum | ( | int | channel | ) | const |
Returns the input maximum for the given channel.
Any value of max in the input cube will be mapped to the output max of the output channel.
| channel | Index of the channel within the process |
References Isis::ProcessExport::GetInputMaximum().
| double Isis::ImageExporter::getInputMinimum | ( | int | channel | ) | const |
Returns the input minimum for the given channel.
Any value of min in the input cube will be mapped to the output min of the output channel.
| channel | Index of the channel within the process |
References Isis::ProcessExport::GetInputMinimum().
| int Isis::ImageExporter::getPixel | ( | double | dn | ) | const [protected, virtual] |
Return the output clamped integer pixel value from the input double-precision DN.
| dn | The input DN |
Referenced by Isis::StreamExporter::writeGrayscale(), Isis::QtExporter::writeGrayscale(), Isis::StreamExporter::writeRgb(), Isis::QtExporter::writeRgb(), Isis::StreamExporter::writeRgba(), and Isis::QtExporter::writeRgba().
| ProcessExport & Isis::ImageExporter::getProcess | ( | ) | const [protected] |
Get a reference to the process object, useful for subclasses to access and manipulate the process.
Referenced by setInput(), Isis::StreamExporter::setType(), and write().
| int Isis::ImageExporter::lines | ( | ) | const |
Number of lines (rows) in the output image.
Referenced by Isis::TiffExporter::write(), and Isis::JP2Exporter::write().
| void Isis::ImageExporter::operator() | ( | vector< Buffer * > & | in | ) | const |
The method for writing a line of input image data (with potentially several bands representing color channels) to the output image.
It is called for each line of data in the input images (provides a vector containing the same line from each single-band input image). Enables the exporter to be used as a functor in a custom ProcessExport routine, bypassing the black-box write() method entirely.
| in | Vector containing a line of input data from each input channel |
| int Isis::ImageExporter::samples | ( | ) | const |
Number of samples (columns) in the output image.
Referenced by Isis::TiffExporter::createBuffer(), Isis::JP2Exporter::createBuffer(), Isis::TiffExporter::write(), and Isis::JP2Exporter::write().
| void Isis::ImageExporter::setExtension | ( | QString | extension | ) | [protected] |
Sets the extension for the output image and generates the extension for the world file from it.
| extension | The extension for the output image |
Referenced by Isis::JP2Exporter::JP2Exporter(), Isis::QtExporter::QtExporter(), and Isis::TiffExporter::TiffExporter().
| virtual void Isis::ImageExporter::setGrayscale | ( | ExportDescription & | desc | ) | [pure virtual] |
Pure virtual method for setting up an export to a grayscale image.
| desc | The description describing the export parameters |
Implemented in Isis::QtExporter, and Isis::StreamExporter.
| Cube * Isis::ImageExporter::setInput | ( | ExportDescription & | desc | ) | [protected] |
Sets up the export process with the parameters described within the given description.
Opens cubes for retrieving input data, establishes the dimensions of the output image, and determines whether to write the data as grayscale, RGB, or RGBA.
| desc | The export description |
References _FILEINFO_, Isis::ExportDescription::channelCount(), cube, getProcess(), Isis::Cube::lineCount(), Isis::IException::Programmer, Isis::Cube::sampleCount(), Isis::ProcessExport::SetOutputNull(), Isis::ProcessExport::SetOutputRange(), writeGrayscale(), writeRgb(), and writeRgba().
Referenced by Isis::StreamExporter::initialize(), Isis::QtExporter::setGrayscale(), Isis::QtExporter::setRgb(), and Isis::QtExporter::setRgba().
| void Isis::ImageExporter::setOutputRange | ( | double | min, | |
| double | max | |||
| ) |
Set the input DN floor and ceiling.
All input DNs less than the min will be set to the min in the output. Similarly, all input DNs greater than the max will be set to the max in the output.
| min | The minimum | |
| max | The maximum |
Referenced by Isis::StreamExporter::setType().
| virtual void Isis::ImageExporter::setRgb | ( | ExportDescription & | desc | ) | [pure virtual] |
Pure virtual method for setting up an export to an RGB image.
| desc | The description describing the export parameters |
Implemented in Isis::QtExporter, and Isis::StreamExporter.
| virtual void Isis::ImageExporter::setRgba | ( | ExportDescription & | desc | ) | [pure virtual] |
Pure virtual method for setting up an export to an RGBA image.
| desc | The description describing the export parameters |
Implemented in Isis::QtExporter, and Isis::StreamExporter.
| void Isis::ImageExporter::write | ( | FileName | outputName, | |
| int | quality = 100 | |||
| ) | [virtual] |
Export the Isis cube channels to the given standard image.
If supported by the specific exporter child, will also produce an image with the given scaled quality. This will do a black-box export using a ProcessExport routine. After the export is completed, a world file will also be created if a map projection exists.
| outputName | The filename of the output cube | |
| quality | The quality of the output from 0 to 100, defaults to 100 |
Reimplemented in Isis::JP2Exporter, Isis::QtExporter, and Isis::TiffExporter.
References Isis::FileName::addExtension(), getProcess(), Isis::ProcessExport::HasInputRange(), Isis::ProcessExport::ProcessCubes(), and Isis::ProcessExport::SetInputRange().
| virtual void Isis::ImageExporter::writeGrayscale | ( | vector< Buffer * > & | in | ) | const [protected, pure virtual] |
Pure virtual method for writing a line of grayscale data to the output image.
| in | Vector containing a single grayscale input line |
Implemented in Isis::QtExporter, and Isis::StreamExporter.
Referenced by setInput().
| virtual void Isis::ImageExporter::writeRgb | ( | vector< Buffer * > & | in | ) | const [protected, pure virtual] |
Pure virtual method for writing a line of RGB data to the output image.
| in | Vector containing three input lines (red, green, blue) |
Implemented in Isis::QtExporter, and Isis::StreamExporter.
Referenced by setInput().
| virtual void Isis::ImageExporter::writeRgba | ( | vector< Buffer * > & | in | ) | const [protected, pure virtual] |
Pure virtual method for writing a line of RGBA data to the output image.
| in | Vector containing four input lines (red, green, blue, alpha) |
Implemented in Isis::QtExporter, and Isis::StreamExporter.
Referenced by setInput().