Imports images with standard formats into Isis as cubes. More...

#include <ImageImporter.h>

Inheritance diagram for Isis::ImageImporter:

Collaboration diagram for Isis::ImageImporter:

Public Member Functions
	ImageImporter (FileName inputName)
	Construct the importer. More...

virtual	~ImageImporter ()
	Destruct the importer. More...

void	operator() (Buffer &out) const
	The method for processing the output cube in place, called for each line of the output image. More...

Cube *	import (FileName outputName)
	Import the image with default output attributes. More...

Cube *	import (FileName outputName, CubeAttributeOutput &att)
	Import the input image this instance was constructed with into the given output Isis cube with the given output attributes. More...

void	setNullRange (double min, double max)
	Set the range of DN values within which a pixel from the input image will be set to Null in the output. More...

void	setLrsRange (double min, double max)
	Set the range of DN values within which a pixel from the input image will be set to LRS in the output. More...

void	setHrsRange (double min, double max)
	Set the range of DN values within which a pixel from the input image will be set to HRS in the output. More...

void	setSamples (int s)
	Set the sample dimension (width) of the output image. More...

void	setLines (int l)
	Set the line dimension (height) of the output image. More...

void	setBands (int b)
	Set the band dimension (depth) of the output image. More...

int	samples () const
	The sample dimension (width) of the output image. More...

int	lines () const
	The line dimension (height) of the output image. More...

int	bands () const
	The band dimension (depth) of the output image. More...

FileName	filename () const
	The filename of the input image this instance was constructed with. More...

virtual PvlGroup	convertProjection () const
	Pure virtual method for converting projection information in the file being imported to an ISIS Mapping group. More...

virtual bool	isGrayscale () const =0
	Pure virtual method for returning true if the image is grayscale. More...

virtual bool	isRgb () const =0
	Pure virtual method for returning true if the image is RGB (no alpha). More...

virtual bool	isArgb () const =0
	Pure virtual method for returning true if the image is RGBA. More...

Static Public Member Functions
static ImageImporter *	fromFileName (FileName inputName)
	A static (factory) method for constructing an ImageImporter instance from an input filename. More...

Protected Types
typedef int(ImageImporter::*	GetChannelMethod) (int pixel) const
	Friendly alias for a method used to get a particular color channel. More...

Protected Member Functions
Cube *	createOutput (FileName outputName, CubeAttributeOutput &att)
	Create the output cube from the given filename and attributes. More...

void	setDefaultBands ()
	Set the number of bands to be created for the output cube based on the number of color channels in the input image. More...

double	testSpecial (double pixel) const
	Tests a pixel against the Null, HRS, and LRS ranges defined by the importer's handler. More...

virtual GetChannelMethod	getBandChannel (int band) const
	Retrieve the method responsible for fetching the color channel from the input image corresponding to the current band out of output being filled. More...

virtual int	convertRgbToGray (int pixel) const
	Convert the current pixel, taken from an RGB/A image, and blend its RGB components into a single grayscale DN. More...

virtual void	updateRawBuffer (int line, int band) const =0
	Pure virtual method that updates the buffer used to store chunks of the input data at a time. More...

virtual int	getPixel (int s, int l) const =0
	Pure virtual method that returns a representation of a pixel for the input format that can then be broken down into specific gray or RGB/A components. More...

virtual int	getGray (int pixel) const =0
	Pure virtual method for retrieving the gray component of the given pixel. More...

virtual int	getRed (int pixel) const =0
	Pure virtual method for retrieving the red component of the given pixel. More...

virtual int	getGreen (int pixel) const =0
	Pure virtual method for retrieving the green component of the given pixel. More...

virtual int	getBlue (int pixel) const =0
	Pure virtual method for retrieving the blue component of the given pixel. More...

virtual int	getAlpha (int pixel) const =0
	Pure virtual method for retrieving the alpha component of the given pixel. More...

Private Attributes
FileName *	m_inputName
	The filename of the input image. More...

Cube *	m_outCube
	The owned handle on the output cube to be imported to. More...

int	m_samples
	The number of samples to be written to the output. More...

int	m_lines
	The number of lines to be written to the output. More...

int	m_bands
	The number of bands to be written to the output. More...

double	m_nullMin
	The lower bound of the range within which input DNs will be made Null. More...

double	m_nullMax
	The upper bound of the range within which input DNs will be made Null. More...

double	m_lrsMin
	The lower bound of the range within which input DNs will be made LRS. More...

double	m_lrsMax
	The upper bound of the range within which input DNs will be made LRS. More...

double	m_hrsMin
	The lower bound of the range within which input DNs will be made HRS. More...

double	m_hrsMax
	The upper bound of the range within which input DNs will be made HRS. More...

Detailed Description

Imports images with standard formats into Isis as cubes.

Abstract base class for a series of image importers. Each importer handles a specialized suite of standard image formats, and can be used as a black-box with the import() method, or for finer control, the importer can act as a functor in a ProcessByLine routine.

Author: 2012-03-16 Travis Addair

History:: 2012-03-28 Travis Addair - Added documentation.

History:: 2014-01-17 Kimberly Oyama - Added the history label to the output cube. Fixes #1894.

History:: 2014-01-27 Kimberly Oyama - Changed the method of adding the history to the cube from adding it in the import method to using Process' WriteHistory method. References #1894.

Definition at line 39 of file ImageImporter.h.

Member Typedef Documentation

◆ GetChannelMethod

typedef int(ImageImporter::* Isis::ImageImporter::GetChannelMethod) (int pixel) const

protected

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

Definition at line 97 of file ImageImporter.h.

Constructor & Destructor Documentation

◆ ImageImporter()

Isis::ImageImporter::ImageImporter ( FileName inputName )

Construct the importer.

Parameters

inputName The name of the input image

Definition at line 32 of file ImageImporter.cpp.

References m_hrsMax, m_hrsMin, m_inputName, m_lrsMax, m_lrsMin, m_nullMax, m_nullMin, and m_outCube.

◆ ~ImageImporter()

Isis::ImageImporter::~ImageImporter ( )

virtual

Destruct the importer.

Also deletes the output cube handle.

Definition at line 51 of file ImageImporter.cpp.

References m_inputName, and m_outCube.

Member Function Documentation

◆ bands()

int Isis::ImageImporter::bands ( ) const

The band dimension (depth) of the output image.

Returns: The band dimension

Definition at line 298 of file ImageImporter.cpp.

References m_bands.

Referenced by createOutput(), getBandChannel(), import(), and Isis::JP2Importer::JP2Importer().

◆ convertProjection()

PvlGroup Isis::ImageImporter::convertProjection ( ) const

virtual

Pure virtual method for converting projection information in the file being imported to an ISIS Mapping group.

Returns: An ISIS Mapping group

Reimplemented in Isis::TiffImporter.

Definition at line 66 of file ImageImporter.cpp.

Referenced by import().

◆ convertRgbToGray()

int Isis::ImageImporter::convertRgbToGray ( int pixel ) const

protectedvirtual

Convert the current pixel, taken from an RGB/A image, and blend its RGB components into a single grayscale DN.

The three color components are weighted by the following formula:

gray = (red * 11 + green * 16 + blue * 5) / 32

This formula was taken from the Qt documentation on converting an RGB value to grayscale: http://qt-project.org/doc/qt-4.8/qcolor.html#qGray-2

Parameters

pixel The pixel value to be broken up into RGB components and converted to grayscale

Returns: The grayscale DN value

Definition at line 399 of file ImageImporter.cpp.

References getBlue(), getGreen(), and getRed().

Referenced by Isis::JP2Importer::getGray(), and Isis::TiffImporter::getGray().

◆ createOutput()

Cube * Isis::ImageImporter::createOutput	(	FileName	outputName,
		CubeAttributeOutput &	att
	)

protected

Create the output cube from the given filename and attributes.

Set its dimensions based on those encapsulated by the importer.

Parameters

outputName	The filename of the output cube
att	The attributes for writing the output cube

Returns: The newly created cube handle devoid of any data

Definition at line 179 of file ImageImporter.cpp.

References bands(), Isis::Cube::create(), Isis::FileName::expanded(), lines(), m_outCube, samples(), and Isis::Cube::setDimensions().

Referenced by import().

◆ filename()

FileName Isis::ImageImporter::filename ( ) const

The filename of the input image this instance was constructed with.

Returns: A copy of the input filename

Definition at line 308 of file ImageImporter.cpp.

References m_inputName.

Referenced by Isis::JP2Importer::JP2Importer().

◆ fromFileName()

ImageImporter * Isis::ImageImporter::fromFileName ( FileName inputName )

static

A static (factory) method for constructing an ImageImporter instance from an input filename.

The specific subclass of the returned instance is determined from the interpreted image format of the input image. Such tests are done by reading a minimal amount of the input data necessary to determine the format. It is the caller's responsibility to delete the importer instance when they are finished with it. Note that deleting the importer will also delete the cube handle returned by the import() method.

Parameters

inputName The filename of the input image to be imported

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

Definition at line 420 of file ImageImporter.cpp.

References Isis::FileName::expanded(), and Isis::IException::Programmer.

◆ getAlpha()

virtual int Isis::ImageImporter::getAlpha ( int pixel ) const

protectedpure virtual

Pure virtual method for retrieving the alpha component of the given pixel.

Parameters

pixel Representation of a pixel for the input format

Returns: The alpha component

Implemented in Isis::TiffImporter, Isis::QtImporter, and Isis::JP2Importer.

Referenced by getBandChannel().

◆ getBandChannel()

ImageImporter::GetChannelMethod Isis::ImageImporter::getBandChannel ( int band ) const

protectedvirtual

Retrieve the method responsible for fetching the color channel from the input image corresponding to the current band out of output being filled.

This will always be the getGray() method for single band output images. For RGB/A images, band 1 will be red, band 2 green, band 3 blue, and band 4 alpha.

Parameters

band	The current band of the output image

Returns: The method that converts input pixels into the current band's color component

Definition at line 354 of file ImageImporter.cpp.

References bands(), getAlpha(), getBlue(), getGray(), getGreen(), getRed(), and Isis::IException::Programmer.

Referenced by operator()().

◆ getBlue()

virtual int Isis::ImageImporter::getBlue ( int pixel ) const

protectedpure virtual

Pure virtual method for retrieving the blue component of the given pixel.

Parameters

pixel Representation of a pixel for the input format

Returns: The blue component

Implemented in Isis::TiffImporter, Isis::QtImporter, and Isis::JP2Importer.

Referenced by convertRgbToGray(), and getBandChannel().

◆ getGray()

virtual int Isis::ImageImporter::getGray ( int pixel ) const

protectedpure virtual

Pure virtual method for retrieving the gray component of the given pixel.

Parameters

pixel Representation of a pixel for the input format

Returns: The gray component

Implemented in Isis::TiffImporter, Isis::QtImporter, and Isis::JP2Importer.

Referenced by getBandChannel().

◆ getGreen()

virtual int Isis::ImageImporter::getGreen ( int pixel ) const

protectedpure virtual

Pure virtual method for retrieving the green component of the given pixel.

Parameters

pixel Representation of a pixel for the input format

Returns: The green component

Implemented in Isis::TiffImporter, Isis::QtImporter, and Isis::JP2Importer.

Referenced by convertRgbToGray(), and getBandChannel().

◆ getPixel()

virtual int Isis::ImageImporter::getPixel	(	int	s,
		int	l
	)		const

protectedpure virtual

Pure virtual method that returns a representation of a pixel for the input format that can then be broken down into specific gray or RGB/A components.

Parameters

s	The sample of the desired pixel
l	The line of the desired pixel

Returns: The format-specific pixel representation

Implemented in Isis::TiffImporter, Isis::QtImporter, and Isis::JP2Importer.

Referenced by operator()().

◆ getRed()

virtual int Isis::ImageImporter::getRed ( int pixel ) const

protectedpure virtual

Pure virtual method for retrieving the red component of the given pixel.

Parameters

pixel Representation of a pixel for the input format

Returns: The red component

Implemented in Isis::TiffImporter, Isis::QtImporter, and Isis::JP2Importer.

Referenced by convertRgbToGray(), and getBandChannel().

◆ import() [1/2]

Cube * Isis::ImageImporter::import ( FileName outputName )

Import the image with default output attributes.

Parameters

outputName The filename of the output cube

Definition at line 108 of file ImageImporter.cpp.

◆ import() [2/2]

Cube * Isis::ImageImporter::import	(	FileName	outputName,
		CubeAttributeOutput &	att
	)

Import the input image this instance was constructed with into the given output Isis cube with the given output attributes.

This will do a black-box import using a ProcessByLine routine. The BandBin group will be updated in the output cube with the names of the color channels included. The output cube will be returned on completion of the import process so the caller can continue to modify the labels. The importer instance will retain ownership of this cube, such that the cube handle will be deallocated upon destruction of the importer.

Parameters

outputName	The filename of the output cube
att	The attributes for writing the output cube

Returns: A handle on the newly imported Isis cube owned by the importer

Definition at line 129 of file ImageImporter.cpp.

References Isis::PvlObject::addGroup(), bands(), convertProjection(), createOutput(), Isis::ProcessByBrick::EndProcess(), Isis::PvlObject::findObject(), Isis::PvlContainer::keywords(), Isis::Cube::label(), Isis::ProcessByLine::ProcessCubeInPlace(), Isis::IException::Programmer, Isis::ProcessByLine::SetInputCube(), Isis::ProcessByBrick::SetProcessingDirection(), and Isis::Process::WriteHistory().

◆ isArgb()

virtual bool Isis::ImageImporter::isArgb ( ) const

pure virtual

Pure virtual method for returning true if the image is RGBA.

Returns: True if the image is RGBA, false otherwise

Implemented in Isis::TiffImporter, Isis::QtImporter, and Isis::JP2Importer.

Referenced by setDefaultBands().

◆ isGrayscale()

virtual bool Isis::ImageImporter::isGrayscale ( ) const

pure virtual

Pure virtual method for returning true if the image is grayscale.

Returns: True if the image is grayscale, false otherwise

Implemented in Isis::TiffImporter, Isis::QtImporter, and Isis::JP2Importer.

Referenced by setDefaultBands().

◆ isRgb()

virtual bool Isis::ImageImporter::isRgb ( ) const

pure virtual

Pure virtual method for returning true if the image is RGB (no alpha).

Returns: True if the image is RGB, false otherwise

Implemented in Isis::TiffImporter, Isis::QtImporter, and Isis::JP2Importer.

◆ lines()

int Isis::ImageImporter::lines ( ) const

The line dimension (height) of the output image.

Returns: The line dimension

Definition at line 288 of file ImageImporter.cpp.

References m_lines.

Referenced by createOutput(), Isis::TiffImporter::getPixel(), and Isis::TiffImporter::TiffImporter().

◆ operator()()

void Isis::ImageImporter::operator() ( Buffer & out ) const

The method for processing the output cube in place, called for each line of the output image.

Enables the importer to be used as a functor in a custom ProcessByLine routine, bypassing the black-box import() method entirely. Care should be taken, however, to observe the requirements placed on the structure of such a processing routine by this method. For example, the JP2Importer child requires that the processing proceed in the direction of bands before lines, because its input data is structured in a BIL (band interlaced by line) format.

Parameters

out	A reference to a line of output data to be written to

Definition at line 84 of file ImageImporter.cpp.

References Isis::Buffer::Band(), getBandChannel(), getPixel(), Isis::Buffer::Line(), Isis::Buffer::SampleDimension(), testSpecial(), and updateRawBuffer().

◆ samples()

int Isis::ImageImporter::samples ( ) const

The sample dimension (width) of the output image.

Returns: The sample dimension

Definition at line 278 of file ImageImporter.cpp.

References m_samples.

Referenced by createOutput(), Isis::TiffImporter::getPixel(), Isis::JP2Importer::JP2Importer(), and Isis::TiffImporter::TiffImporter().

◆ setBands()

void Isis::ImageImporter::setBands ( int b )

Set the band dimension (depth) of the output image.

Because this importer only works on Grayscale, RGB, and RGBA images, possible values are 1, 3, and 4 for the respective color modes.

Parameters

b	The new band dimension

Definition at line 263 of file ImageImporter.cpp.

References m_bands, and Isis::IException::Programmer.

Referenced by Isis::JP2Importer::JP2Importer(), and setDefaultBands().

◆ setDefaultBands()

void Isis::ImageImporter::setDefaultBands ( )

protected

Set the number of bands to be created for the output cube based on the number of color channels in the input image.

Definition at line 192 of file ImageImporter.cpp.

References isArgb(), isGrayscale(), and setBands().

Referenced by Isis::QtImporter::QtImporter(), and Isis::TiffImporter::TiffImporter().

◆ setHrsRange()

void Isis::ImageImporter::setHrsRange	(	double	min,
		double	max
	)

Set the range of DN values within which a pixel from the input image will be set to HRS in the output.

Parameters

min	Any DN less than this value will not be set to HRS.
max	Any DN greater than this value will not be set to HRS.

Definition at line 230 of file ImageImporter.cpp.

References m_hrsMax, and m_hrsMin.

◆ setLines()

void Isis::ImageImporter::setLines ( int l )

Set the line dimension (height) of the output image.

Parameters

l	The new line dimension

Definition at line 251 of file ImageImporter.cpp.

References m_lines.

Referenced by Isis::JP2Importer::JP2Importer(), Isis::QtImporter::QtImporter(), and Isis::TiffImporter::TiffImporter().

◆ setLrsRange()

void Isis::ImageImporter::setLrsRange	(	double	min,
		double	max
	)

Set the range of DN values within which a pixel from the input image will be set to LRS in the output.

Parameters

min	Any DN less than this value will not be set to LRS.
max	Any DN greater than this value will not be set to LRS.

Definition at line 217 of file ImageImporter.cpp.

References m_lrsMax, and m_lrsMin.

◆ setNullRange()

void Isis::ImageImporter::setNullRange	(	double	min,
		double	max
	)

Set the range of DN values within which a pixel from the input image will be set to Null in the output.

Parameters

min	Any DN less than this value will not be set to Null.
max	Any DN greater than this value will not be set to Null.

Definition at line 204 of file ImageImporter.cpp.

References m_nullMax, and m_nullMin.

◆ setSamples()

void Isis::ImageImporter::setSamples ( int s )

Set the sample dimension (width) of the output image.

Parameters

s	The new sample dimension

Definition at line 241 of file ImageImporter.cpp.

References m_samples.

Referenced by Isis::JP2Importer::JP2Importer(), Isis::QtImporter::QtImporter(), and Isis::TiffImporter::TiffImporter().

◆ testSpecial()

double Isis::ImageImporter::testSpecial ( double pixel ) const

protected

Tests a pixel against the Null, HRS, and LRS ranges defined by the importer's handler.

Any pixel value falling within one of these ranges will be converted into the given type of special pixel. In case of overlapping ranges, these tests will be performed in the order mentioned at the start of this description. By default, these ranges are set such that all incoming pixels will retain their original values.

Parameters

pixel The DN value to be tested

Returns: The valid DN or special pixel if it fell within the special ranges

Definition at line 325 of file ImageImporter.cpp.

References m_hrsMin, m_lrsMin, and m_nullMin.

Referenced by operator()().

◆ updateRawBuffer()

virtual void Isis::ImageImporter::updateRawBuffer	(	int	line,
		int	band
	)		const

protectedpure virtual

Pure virtual method that updates the buffer used to store chunks of the input data at a time.

Does nothing for classes that read the entire input image into memory.

Parameters

line	Current line of the output buffer
band	Current band of the output buffer

Implemented in Isis::TiffImporter, Isis::QtImporter, and Isis::JP2Importer.

Referenced by operator()().

Member Data Documentation

◆ m_bands

int Isis::ImageImporter::m_bands

private

The number of bands to be written to the output.

Definition at line 193 of file ImageImporter.h.

Referenced by bands(), and setBands().

◆ m_hrsMax

double Isis::ImageImporter::m_hrsMax

private

The upper bound of the range within which input DNs will be made HRS.

Definition at line 211 of file ImageImporter.h.

Referenced by ImageImporter(), and setHrsRange().

◆ m_hrsMin

double Isis::ImageImporter::m_hrsMin

private

The lower bound of the range within which input DNs will be made HRS.

Definition at line 208 of file ImageImporter.h.

Referenced by ImageImporter(), setHrsRange(), and testSpecial().

◆ m_inputName

FileName* Isis::ImageImporter::m_inputName

private

The filename of the input image.

Definition at line 181 of file ImageImporter.h.

Referenced by filename(), ImageImporter(), and ~ImageImporter().

◆ m_lines

int Isis::ImageImporter::m_lines

private

The number of lines to be written to the output.

Definition at line 190 of file ImageImporter.h.

Referenced by lines(), and setLines().

◆ m_lrsMax

double Isis::ImageImporter::m_lrsMax

private

The upper bound of the range within which input DNs will be made LRS.

Definition at line 205 of file ImageImporter.h.

Referenced by ImageImporter(), and setLrsRange().

◆ m_lrsMin

double Isis::ImageImporter::m_lrsMin

private

The lower bound of the range within which input DNs will be made LRS.

Definition at line 202 of file ImageImporter.h.

Referenced by ImageImporter(), setLrsRange(), and testSpecial().

◆ m_nullMax

double Isis::ImageImporter::m_nullMax

private

The upper bound of the range within which input DNs will be made Null.

Definition at line 199 of file ImageImporter.h.

Referenced by ImageImporter(), and setNullRange().

◆ m_nullMin

double Isis::ImageImporter::m_nullMin

private

The lower bound of the range within which input DNs will be made Null.

Definition at line 196 of file ImageImporter.h.

Referenced by ImageImporter(), setNullRange(), and testSpecial().

◆ m_outCube

Cube* Isis::ImageImporter::m_outCube

private

The owned handle on the output cube to be imported to.

Definition at line 184 of file ImageImporter.h.

Referenced by createOutput(), ImageImporter(), and ~ImageImporter().

◆ m_samples

int Isis::ImageImporter::m_samples

private

The number of samples to be written to the output.

Definition at line 187 of file ImageImporter.h.

Referenced by samples(), and setSamples().

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

src/base/objs/ImageImporter/ImageImporter.h
src/base/objs/ImageImporter/ImageImporter.cpp

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ GetChannelMethod

Constructor & Destructor Documentation

◆ ImageImporter()

◆ ~ImageImporter()

Member Function Documentation

◆ bands()

◆ convertProjection()

◆ convertRgbToGray()

◆ createOutput()

◆ filename()

◆ fromFileName()

◆ getAlpha()

◆ getBandChannel()

◆ getBlue()

◆ getGray()

◆ getGreen()

◆ getPixel()

◆ getRed()

◆ import() [1/2]

◆ import() [2/2]

◆ isArgb()

◆ isGrayscale()

◆ isRgb()

◆ lines()

◆ operator()()

◆ samples()

◆ setBands()

◆ setDefaultBands()

◆ setHrsRange()

◆ setLines()

◆ setLrsRange()

◆ setNullRange()

◆ setSamples()

◆ testSpecial()

◆ updateRawBuffer()

Member Data Documentation

◆ m_bands

◆ m_hrsMax

◆ m_hrsMin

◆ m_inputName

◆ m_lines

◆ m_lrsMax

◆ m_lrsMin

◆ m_nullMax

◆ m_nullMin

◆ m_outCube

◆ m_samples