Exports cubes into a standard format in incremental pieces. More...

#include <StreamExporter.h>

Inheritance diagram for Isis::StreamExporter:

Collaboration diagram for Isis::StreamExporter:

Public Member Functions
	StreamExporter ()
	Construct the stream exporter. More...

virtual	~StreamExporter ()
	Destruct the exporter. More...

virtual void	setGrayscale (ExportDescription &desc)
	Generic initialization with the export description. More...

virtual void	setRgb (ExportDescription &desc)
	Generic initialization with the export description. More...

virtual void	setRgba (ExportDescription &desc)
	Generic initialization with the export description. More...

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. More...

virtual void	write (FileName outputName, int quality=100, QString compression="none")
	Export the Isis cube channels to the given standard image. More...

int	samples () const
	Number of samples (columns) in the output image. More...

int	lines () const
	Number of lines (rows) in the output image. More...

int	bands () const
	Number of bands (channels) in the output image. More...

double	inputMinimum (int channel) const
	Returns the input minimum for the given channel. More...

double	inputMaximum (int channel) const
	Returns the input maximum for the given channel. More...

void	setOutputPixelRange (double outputPixelMinimum, double outputPixelMaximum)
	Set the DN floor and ceiling for the exported image. More...

Static Public Member Functions
static ImageExporter *	fromFormat (QString format)
	A static (factory) method for constructing an ImageExporter instance from an output format. More...

Protected Types
typedef void(ImageExporter::*	WriteChannels) (vector< Buffer *> &in) const
	Friendly alias for a method used to write a particular color channel. More...

Protected Member Functions
virtual void	initialize (ExportDescription &desc)
	Generic initialization with the export description. More...

virtual void	writeGrayscale (vector< Buffer *> &in) const
	Write a line of grayscale data to the output image. More...

virtual void	writeRgb (vector< Buffer *> &in) const
	Write a line of RGB data to the output image. More...

virtual void	writeRgba (vector< Buffer *> &in) const
	Write a line of RGBA data to the output image. More...

virtual void	createBuffer ()=0
	Pure virtual method for creating the buffer to store a chunk of streamed line data with one or more bands. More...

virtual void	setBuffer (int s, int b, int dn) const =0
	Pure virtual method for setting a particular index of the line buffer to the given DN. More...

virtual void	writeLine (int l) const =0
	Pure virtual method for writing a line of buffered data to the output image on disk. More...

void	setExtension (QString extension)
	Sets the extension for the output image and generates the extension for the world file from it. More...

void	setExportDescription (ExportDescription &desc)
	Sets the description for the output image. More...

Cube *	initializeProcess ()
	Sets up the export process with the parameters described within the given description. More...

QString	extension () const
	Gets the extension for the output image. More...

ExportDescription &	exportDescription () const
	Gets the description for the output image. More...

ProcessExport &	process () const
	Get a reference to the process object, useful for subclasses to access and manipulate the process. More...

PixelType	pixelType () const
	Returns the pixel type. More...

virtual int	outputPixelValue (double dn) const
	Return the output clamped integer pixel value from the input double-precision DN. More...

Detailed Description

Exports cubes into a standard format in incremental pieces.

Abstract base class for a series of stream image exporters. Stream exporters are specialized in that they write out data as a stream of lines as opposed to keeping the export data all in memory. In this way, they can be run on arbitrarily large images.

Author: 2012-04-03 Travis Addair

History:

2012-04-04 Travis Addair - Added documentation.

2013-06-05 Jeannie Backer - Removed setType() and pixelType() methods and pixel type member variable since these are now handled by ImageExporter. Changed ImageExporter calls to new method names, where needed. References #1380.

Definition at line 50 of file StreamExporter.h.

Member Typedef Documentation

◆ WriteChannels

typedef void(ImageExporter::* Isis::ImageExporter::WriteChannels) (vector< Buffer * > &in) const

protectedinherited

Friendly alias for a method used to write a particular color channel.

Definition at line 114 of file ImageExporter.h.

Constructor & Destructor Documentation

◆ StreamExporter()

Isis::StreamExporter::StreamExporter ( )

Construct the stream exporter.

Definition at line 15 of file StreamExporter.cpp.

◆ ~StreamExporter()

Isis::StreamExporter::~StreamExporter ( )

virtual

Destruct the exporter.

Definition at line 22 of file StreamExporter.cpp.

Member Function Documentation

◆ bands()

int Isis::ImageExporter::bands ( ) const

inherited

Number of bands (channels) in the output image.

Returns: The depth of the output

Definition at line 132 of file ImageExporter.cpp.

Referenced by Isis::QtExporter::checkDataSize(), Isis::JP2Exporter::createBuffer(), Isis::TiffExporter::createBuffer(), Isis::TiffExporter::setBuffer(), Isis::JP2Exporter::write(), and Isis::TiffExporter::write().

◆ createBuffer()

virtual void Isis::StreamExporter::createBuffer ( )

protectedpure virtual

Pure virtual method for creating the buffer to store a chunk of streamed line data with one or more bands.

Implemented in Isis::TiffExporter, and Isis::JP2Exporter.

Referenced by initialize().

◆ exportDescription()

ExportDescription & Isis::ImageExporter::exportDescription ( ) const

protectedinherited

Gets the description for the output image.

Returns: The export description

Definition at line 220 of file ImageExporter.cpp.

◆ extension()

QString Isis::ImageExporter::extension ( ) const

protectedinherited

Gets the extension for the output image.

Returns: The extension for the output image

Definition at line 202 of file ImageExporter.cpp.

Referenced by Isis::JP2Exporter::write(), Isis::TiffExporter::write(), and Isis::QtExporter::write().

◆ fromFormat()

ImageExporter * Isis::ImageExporter::fromFormat ( QString format )

staticinherited

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.

Parameters

format The format for the output image to be created

Returns: A pointer to the instantiated exporter owned by the caller

Definition at line 384 of file ImageExporter.cpp.

References _FILEINFO_, Isis::JP2Exporter::canWriteFormat(), Isis::TiffExporter::canWriteFormat(), Isis::QtExporter::canWriteFormat(), and Isis::IException::Programmer.

◆ initialize()

void Isis::StreamExporter::initialize ( ExportDescription & desc )

protectedvirtual

Generic initialization with the export description.

Set the input, set the pixel type, and create the buffer.

Parameters

desc	Export description containing necessary channel information

Implements Isis::ImageExporter.

Definition at line 68 of file StreamExporter.cpp.

References createBuffer(), and Isis::ImageExporter::initialize().

Referenced by setGrayscale(), setRgb(), and setRgba().

◆ initializeProcess()

Cube * Isis::ImageExporter::initializeProcess ( )

protectedinherited

Sets up the export process with the parameters described within the given description.

This method determines determines whether to write the data as grayscale, RGB, or RGBA. It then opens a cube for retrieving the input data and establishing the dimensions of the output image. Next, the ProcessExport format is set to BIL and the ProcessExport output pixel type, output valid data range, and output null are set based on the given export description. Last, the absolute output pixel range is set based on the given description (this is the smallest and largest allowed pixel values in the output, including "special" pixel values).

Returns: A cube pointer to the first channel created, owned by the process

Definition at line 240 of file ImageExporter.cpp.

References _FILEINFO_, Isis::ProcessExport::BIL, Isis::Cube::lineCount(), Isis::IException::Programmer, Isis::Cube::sampleCount(), Isis::ProcessExport::setFormat(), Isis::ProcessExport::SetOutputNull(), Isis::ProcessExport::SetOutputRange(), Isis::ProcessExport::SetOutputType(), Isis::ImageExporter::writeGrayscale(), Isis::ImageExporter::writeRgb(), and Isis::ImageExporter::writeRgba().

◆ inputMaximum()

double Isis::ImageExporter::inputMaximum ( int channel ) const

inherited

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.

Parameters

channel Index of the channel within the process

Returns: The maximum DN in the input mapped to the maximum of the output

Definition at line 158 of file ImageExporter.cpp.

◆ inputMinimum()

double Isis::ImageExporter::inputMinimum ( int channel ) const

inherited

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.

Parameters

channel Index of the channel within the process

Returns: The minimum DN in the input mapped to the minimum of the output

Definition at line 145 of file ImageExporter.cpp.

◆ lines()

int Isis::ImageExporter::lines ( ) const

inherited

Number of lines (rows) in the output image.

Returns: The height of the output

Definition at line 122 of file ImageExporter.cpp.

Referenced by Isis::QtExporter::checkDataSize(), Isis::QtExporter::setGrayscale(), Isis::QtExporter::setRgb(), Isis::QtExporter::setRgba(), Isis::JP2Exporter::write(), and Isis::TiffExporter::write().

◆ operator()()

void Isis::ImageExporter::operator() ( vector< Buffer *> & in ) const

inherited

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.

Parameters

in	Vector containing a line of input data from each input channel

Definition at line 78 of file ImageExporter.cpp.

◆ outputPixelValue()

int Isis::ImageExporter::outputPixelValue ( double dn ) const

protectedvirtualinherited

Return the output clamped integer pixel value from the input double-precision DN.

Parameters

dn	The input DN

Returns: The pixel value for the output

Definition at line 319 of file ImageExporter.cpp.

Referenced by writeGrayscale(), Isis::QtExporter::writeGrayscale(), writeRgb(), Isis::QtExporter::writeRgb(), writeRgba(), and Isis::QtExporter::writeRgba().

◆ pixelType()

PixelType Isis::ImageExporter::pixelType ( ) const

protectedinherited

Returns the pixel type.

Defaults to None if not set by the user.

Returns: The pixel type: {None, UnsignedByte, SignedWord, UnsignedWord}

Definition at line 301 of file ImageExporter.cpp.

Referenced by Isis::JP2Exporter::createBuffer(), Isis::TiffExporter::createBuffer(), Isis::JP2Exporter::setBuffer(), Isis::TiffExporter::setBuffer(), Isis::JP2Exporter::write(), Isis::TiffExporter::write(), and Isis::JP2Exporter::writeLine().

◆ process()

ProcessExport & Isis::ImageExporter::process ( ) const

protectedinherited

Get a reference to the process object, useful for subclasses to access and manipulate the process.

Returns: A reference to the process object

Definition at line 291 of file ImageExporter.cpp.

◆ samples()

int Isis::ImageExporter::samples ( ) const

inherited

Number of samples (columns) in the output image.

Returns: The width of the output

Definition at line 112 of file ImageExporter.cpp.

Referenced by Isis::QtExporter::checkDataSize(), Isis::JP2Exporter::createBuffer(), Isis::TiffExporter::createBuffer(), Isis::QtExporter::setGrayscale(), Isis::QtExporter::setRgb(), Isis::QtExporter::setRgba(), Isis::JP2Exporter::write(), and Isis::TiffExporter::write().

◆ setBuffer()

virtual void Isis::StreamExporter::setBuffer	(	int	s,
		int	b,
		int	dn
	)		const

protectedpure virtual

Pure virtual method for setting a particular index of the line buffer to the given DN.

Parameters

s	The sample index into the buffer
b	The band index into the buffer
dn	The value to set at the given index

Implemented in Isis::TiffExporter, and Isis::JP2Exporter.

Referenced by writeGrayscale(), writeRgb(), and writeRgba().

◆ setExportDescription()

void Isis::ImageExporter::setExportDescription ( ExportDescription & desc )

protectedinherited

Sets the description for the output image.

Parameters

desc	The export description

Definition at line 211 of file ImageExporter.cpp.

◆ setExtension()

void Isis::ImageExporter::setExtension ( QString extension )

protectedinherited

Sets the extension for the output image and generates the extension for the world file from it.

Parameters

extension The extension for the output image

Definition at line 187 of file ImageExporter.cpp.

Referenced by Isis::JP2Exporter::JP2Exporter(), Isis::QtExporter::QtExporter(), and Isis::TiffExporter::TiffExporter().

◆ setGrayscale()

void Isis::StreamExporter::setGrayscale ( ExportDescription & desc )

virtual

Generic initialization with the export description.

Stream exporters do not do anything special to export a grayscale image beyond setting up the appropriate number of color channels.

Parameters

desc	Export description containing necessary channel information

Implements Isis::ImageExporter.

Definition at line 33 of file StreamExporter.cpp.

References initialize().

◆ setOutputPixelRange()

void Isis::ImageExporter::setOutputPixelRange	(	double	outputPixelMinimum,
		double	outputPixelMaximum
	)

inherited

Set the DN floor and ceiling for the exported image.

All DNs less than the min will be set to the min in the exported image. Similarly, all DNs greater than the max will be set to the max in the exported image.

Note: These values may be "special". For example, if Null pixels are exported to 0.0 and the minimum valid pixels are exported to 2.0, then 0.0 should be passed in for the value of the min parameter.

Parameters

min	The absolute minimum output DN value.
max	The absolute maximum output DN value.

Definition at line 175 of file ImageExporter.cpp.

◆ setRgb()

void Isis::StreamExporter::setRgb ( ExportDescription & desc )

virtual

Generic initialization with the export description.

Stream exporters do not do anything special to export an RGB image beyond setting up the appropriate number of color channels.

Parameters

desc	Export description containing necessary channel information

Implements Isis::ImageExporter.

Definition at line 45 of file StreamExporter.cpp.

References initialize().

◆ setRgba()

void Isis::StreamExporter::setRgba ( ExportDescription & desc )

virtual

Generic initialization with the export description.

Stream exporters do not do anything special to export an RGBA image beyond setting up the appropriate number of color channels.

Parameters

desc	Export description containing necessary channel information

Implements Isis::ImageExporter.

Definition at line 57 of file StreamExporter.cpp.

References initialize().

◆ write()

void Isis::ImageExporter::write	(	FileName	outputName,
		int	quality = `100`,
		QString	compression = `"none"`
	)

virtualinherited

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. Will also use the selected compression algorithm if supported by the image format. 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.

Parameters

outputName	The filename of the output cube
quality	The quality of the output from 0 to 100, defaults to 100
compression	The compression algorithm used. Image format specific.

Reimplemented in Isis::QtExporter, Isis::TiffExporter, and Isis::JP2Exporter.

Definition at line 95 of file ImageExporter.cpp.

References Isis::FileName::addExtension(), and Isis::ProcessExport::SetInputRange().

Referenced by Isis::JP2Exporter::write(), Isis::TiffExporter::write(), and Isis::QtExporter::write().

◆ writeGrayscale()

void Isis::StreamExporter::writeGrayscale ( vector< Buffer *> & in ) const

protectedvirtual

Write a line of grayscale data to the output image.

Parameters

in	Vector containing a single grayscale input line

Implements Isis::ImageExporter.

Definition at line 79 of file StreamExporter.cpp.

References Isis::Buffer::Line(), Isis::ImageExporter::outputPixelValue(), Isis::Buffer::SampleDimension(), setBuffer(), and writeLine().

◆ writeLine()

virtual void Isis::StreamExporter::writeLine ( int l ) const

protectedpure virtual

Pure virtual method for writing a line of buffered data to the output image on disk.

Parameters

l	The line of the output image to write to

Implemented in Isis::TiffExporter, and Isis::JP2Exporter.

Referenced by writeGrayscale(), writeRgb(), and writeRgba().

◆ writeRgb()

void Isis::StreamExporter::writeRgb ( vector< Buffer *> & in ) const

protectedvirtual

Write a line of RGB data to the output image.

Parameters

in	Vector containing three input lines (red, green, blue)

Implements Isis::ImageExporter.

Definition at line 97 of file StreamExporter.cpp.

References Isis::Buffer::Line(), Isis::ImageExporter::outputPixelValue(), Isis::Buffer::SampleDimension(), setBuffer(), and writeLine().

◆ writeRgba()

void Isis::StreamExporter::writeRgba ( vector< Buffer *> & in ) const

protectedvirtual

Write a line of RGBA data to the output image.

Parameters

in	Vector containing four input lines (red, green, blue, alpha)

Implements Isis::ImageExporter.

Definition at line 121 of file StreamExporter.cpp.

References Isis::Buffer::Line(), Isis::ImageExporter::outputPixelValue(), Isis::Buffer::SampleDimension(), setBuffer(), and writeLine().

The documentation for this class was generated from the following files:

src/base/objs/StreamExporter/StreamExporter.h
src/base/objs/StreamExporter/StreamExporter.cpp

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ WriteChannels

Constructor & Destructor Documentation

◆ StreamExporter()

◆ ~StreamExporter()

Member Function Documentation

◆ bands()

◆ createBuffer()

◆ exportDescription()

◆ extension()

◆ fromFormat()

◆ initialize()

◆ initializeProcess()

◆ inputMaximum()

◆ inputMinimum()

◆ lines()

◆ operator()()

◆ outputPixelValue()

◆ pixelType()

◆ process()

◆ samples()

◆ setBuffer()

◆ setExportDescription()

◆ setExtension()

◆ setGrayscale()

◆ setOutputPixelRange()

◆ setRgb()

◆ setRgba()

◆ write()

◆ writeGrayscale()

◆ writeLine()

◆ writeRgb()

◆ writeRgba()