Imports JPEG 2000 images as Isis cubes. More...

#include <JP2Importer.h>

Inheritance diagram for Isis::JP2Importer:

Collaboration diagram for Isis::JP2Importer:

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

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

virtual bool	isGrayscale () const
	Tests to see if the input image is single-banded, implying grayscale (no RGB/A). More...

virtual bool	isRgb () const
	Tests to see if the input image is triple-banded, implying RGB (no alpha). More...

virtual bool	isArgb () const
	Tests to see if the input image is quadruple-banded, implying RGBA. 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...

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
virtual void	updateRawBuffer (int line, int band) const
	Updates the buffer used to store chunks of the input data at a time. More...

virtual int	getPixel (int s, int l) const
	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
	Retrieves the gray component of the given pixel. More...

virtual int	getRed (int pixel) const
	Retrieves the red component of the given pixel from the first band of the input buffer. More...

virtual int	getGreen (int pixel) const
	Retrieves the green component of the given pixel from the second band of the input buffer. More...

virtual int	getBlue (int pixel) const
	Retrieves the blue component of the given pixel from the third band of the input buffer. More...

virtual int	getAlpha (int pixel) const
	Retrieves the alpha component of the given pixel from the fourth band of the input buffer. More...

int	getFromBuffer (int s, int b) const
	Retrieves the pixel value from the input buffer corresponding to the given sample and band (the buffer contains an entire line). More...

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

Private Attributes
JP2Decoder *	m_decoder
	Takes a raw stream of JPEG 2000 data and reads it into a buffer. More...

char **	m_buffer
	Buffer that stores a line of JPEG 2000 data and all its color bands. More...

Isis::PixelType	m_pixelType
	Pixel type of the input image needed for reading data into the buffer. More...

Detailed Description

Imports JPEG 2000 images as Isis cubes.

Takes a JPEG 2000 input image and imports it into Isis in the cube format.

Author: 2012-03-16 Travis Addair

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

Definition at line 46 of file JP2Importer.h.

Member Typedef Documentation

◆ GetChannelMethod

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

protectedinherited

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

Definition at line 113 of file ImageImporter.h.

Constructor & Destructor Documentation

◆ JP2Importer()

Isis::JP2Importer::JP2Importer ( FileName inputName )

Construct the importer.

Parameters

inputName The name of the input image

Definition at line 17 of file JP2Importer.cpp.

References _FILEINFO_, Isis::ImageImporter::bands(), Isis::FileName::expanded(), Isis::ImageImporter::filename(), m_buffer, m_decoder, m_pixelType, Isis::JP2Decoder::OpenFile(), Isis::IException::Programmer, Isis::ImageImporter::samples(), Isis::ImageImporter::setBands(), Isis::ImageImporter::setLines(), Isis::ImageImporter::setSamples(), Isis::SizeOf(), and Isis::IException::User.

◆ ~JP2Importer()

Isis::JP2Importer::~JP2Importer ( )

virtual

Destruct the importer.

Definition at line 62 of file JP2Importer.cpp.

References m_buffer, and m_decoder.

Member Function Documentation

◆ bands()

int Isis::ImageImporter::bands ( ) const

inherited

The band dimension (depth) of the output image.

Returns: The band dimension

Definition at line 292 of file ImageImporter.cpp.

References Isis::ImageImporter::m_bands.

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

◆ convertProjection()

PvlGroup Isis::ImageImporter::convertProjection ( ) const

virtualinherited

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 60 of file ImageImporter.cpp.

Referenced by Isis::ImageImporter::import().

◆ convertRgbToGray()

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

protectedvirtualinherited

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 393 of file ImageImporter.cpp.

References Isis::ImageImporter::getBlue(), Isis::ImageImporter::getGreen(), and Isis::ImageImporter::getRed().

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

◆ createOutput()

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

protectedinherited

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 173 of file ImageImporter.cpp.

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

Referenced by Isis::ImageImporter::import().

◆ filename()

FileName Isis::ImageImporter::filename ( ) const

inherited

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

Returns: A copy of the input filename

Definition at line 302 of file ImageImporter.cpp.

References Isis::ImageImporter::m_inputName.

Referenced by JP2Importer().

◆ fromFileName()

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

staticinherited

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 414 of file ImageImporter.cpp.

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

◆ getAlpha()

int Isis::JP2Importer::getAlpha ( int pixel ) const

protectedvirtual

Retrieves the alpha component of the given pixel from the fourth band of the input buffer.

Parameters

pixel Index into the line buffer corresponding to a sample

Returns: The alpha component

Implements Isis::ImageImporter.

Definition at line 204 of file JP2Importer.cpp.

References getFromBuffer().

◆ getBandChannel()

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

protectedvirtualinherited

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 348 of file ImageImporter.cpp.

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

Referenced by Isis::ImageImporter::operator()().

◆ getBlue()

int Isis::JP2Importer::getBlue ( int pixel ) const

protectedvirtual

Retrieves the blue component of the given pixel from the third band of the input buffer.

Parameters

pixel Index into the line buffer corresponding to a sample

Returns: The blue component

Implements Isis::ImageImporter.

Definition at line 191 of file JP2Importer.cpp.

References getFromBuffer().

◆ getFromBuffer()

int Isis::JP2Importer::getFromBuffer	(	int	s,
		int	b
	)		const

protected

Retrieves the pixel value from the input buffer corresponding to the given sample and band (the buffer contains an entire line).

Dependent upon the pixel type of the input data.

Parameters

s	Index into the line buffer corresponding to a sample
b	Index into the line buffer corresponding to a band

Returns: The pixel value of the given component

Definition at line 219 of file JP2Importer.cpp.

References _FILEINFO_, m_buffer, m_pixelType, and Isis::IException::Programmer.

Referenced by getAlpha(), getBlue(), getGray(), getGreen(), and getRed().

◆ getGray()

int Isis::JP2Importer::getGray ( int pixel ) const

protectedvirtual

Retrieves the gray component of the given pixel.

For grayscale images, simply returns the value in the single band. For RGB/A, converts the RGB components into grayscale.

Parameters

pixel Index into the line buffer corresponding to a sample

Returns: The gray component

Implements Isis::ImageImporter.

Definition at line 152 of file JP2Importer.cpp.

References Isis::ImageImporter::convertRgbToGray(), getFromBuffer(), and isGrayscale().

◆ getGreen()

int Isis::JP2Importer::getGreen ( int pixel ) const

protectedvirtual

Retrieves the green component of the given pixel from the second band of the input buffer.

Parameters

pixel Index into the line buffer corresponding to a sample

Returns: The green component

Implements Isis::ImageImporter.

Definition at line 178 of file JP2Importer.cpp.

References getFromBuffer().

◆ getPixel()

int Isis::JP2Importer::getPixel	(	int	s,
		int	l
	)		const

protectedvirtual

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 current sample, used as an index into the data buffer

Todo:: This design was created before it was determined that JPEG 2000 does not have a traditional pixel representation used to get color components, so this is somewhat of a hack.

Implements Isis::ImageImporter.

Definition at line 138 of file JP2Importer.cpp.

◆ getRed()

int Isis::JP2Importer::getRed ( int pixel ) const

protectedvirtual

Retrieves the red component of the given pixel from the first band of the input buffer.

Parameters

pixel Index into the line buffer corresponding to a sample

Returns: The red component

Implements Isis::ImageImporter.

Definition at line 165 of file JP2Importer.cpp.

References getFromBuffer().

◆ import() [1/2]

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

inherited

Import the image with default output attributes.

Parameters

outputName The filename of the output cube

Definition at line 102 of file ImageImporter.cpp.

◆ import() [2/2]

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

inherited

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 123 of file ImageImporter.cpp.

References _FILEINFO_, Isis::PvlObject::addGroup(), Isis::ImageImporter::bands(), Isis::ImageImporter::convertProjection(), Isis::ImageImporter::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()

bool Isis::JP2Importer::isArgb ( ) const

virtual

Tests to see if the input image is quadruple-banded, implying RGBA.

Returns: True if the image is RGBA, false otherwise

Implements Isis::ImageImporter.

Definition at line 97 of file JP2Importer.cpp.

References m_decoder.

◆ isGrayscale()

bool Isis::JP2Importer::isGrayscale ( ) const

virtual

Tests to see if the input image is single-banded, implying grayscale (no RGB/A).

Returns: True if the image is grayscale, false otherwise

Implements Isis::ImageImporter.

Definition at line 77 of file JP2Importer.cpp.

References m_decoder.

Referenced by getGray().

◆ isRgb()

bool Isis::JP2Importer::isRgb ( ) const

virtual

Tests to see if the input image is triple-banded, implying RGB (no alpha).

Returns: True if the image is RGB, false otherwise

Implements Isis::ImageImporter.

Definition at line 87 of file JP2Importer.cpp.

References m_decoder.

◆ lines()

int Isis::ImageImporter::lines ( ) const

inherited

The line dimension (height) of the output image.

Returns: The line dimension

Definition at line 282 of file ImageImporter.cpp.

References Isis::ImageImporter::m_lines.

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

◆ operator()()

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

inherited

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 78 of file ImageImporter.cpp.

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

◆ samples()

int Isis::ImageImporter::samples ( ) const

inherited

The sample dimension (width) of the output image.

Returns: The sample dimension

Definition at line 272 of file ImageImporter.cpp.

References Isis::ImageImporter::m_samples.

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

◆ setBands()

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

inherited

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 257 of file ImageImporter.cpp.

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

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

◆ setDefaultBands()

void Isis::ImageImporter::setDefaultBands ( )

protectedinherited

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 186 of file ImageImporter.cpp.

References Isis::ImageImporter::isArgb(), Isis::ImageImporter::isGrayscale(), and Isis::ImageImporter::setBands().

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

◆ setHrsRange()

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

inherited

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 224 of file ImageImporter.cpp.

References Isis::ImageImporter::m_hrsMax, and Isis::ImageImporter::m_hrsMin.

◆ setLines()

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

inherited

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

Parameters

l	The new line dimension

Definition at line 245 of file ImageImporter.cpp.

References Isis::ImageImporter::m_lines.

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

◆ setLrsRange()

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

inherited

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 211 of file ImageImporter.cpp.

References Isis::ImageImporter::m_lrsMax, and Isis::ImageImporter::m_lrsMin.

◆ setNullRange()

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

inherited

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 198 of file ImageImporter.cpp.

References Isis::ImageImporter::m_nullMax, and Isis::ImageImporter::m_nullMin.

◆ setSamples()

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

inherited

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

Parameters

s	The new sample dimension

Definition at line 235 of file ImageImporter.cpp.

References Isis::ImageImporter::m_samples.

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

◆ testSpecial()

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

protectedinherited

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 319 of file ImageImporter.cpp.

References Isis::ImageImporter::m_hrsMin, Isis::ImageImporter::m_lrsMin, and Isis::ImageImporter::m_nullMin.

Referenced by Isis::ImageImporter::operator()().

◆ updateRawBuffer()

void Isis::JP2Importer::updateRawBuffer	(	int	line,
		int	band
	)		const

protectedvirtual

Updates the buffer used to store chunks of the input data at a time.

Reads a single line of data from the input with all its color channels. Uses the pixel type to determine the size of each pixel value to read in.

Parameters

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

Implements Isis::ImageImporter.

Definition at line 110 of file JP2Importer.cpp.

References m_buffer, m_decoder, m_pixelType, and Isis::JP2Decoder::Read().

Member Data Documentation

◆ m_buffer

char** Isis::JP2Importer::m_buffer

private

Buffer that stores a line of JPEG 2000 data and all its color bands.

Definition at line 72 of file JP2Importer.h.

Referenced by getFromBuffer(), JP2Importer(), updateRawBuffer(), and ~JP2Importer().

◆ m_decoder

JP2Decoder* Isis::JP2Importer::m_decoder

private

Takes a raw stream of JPEG 2000 data and reads it into a buffer.

Definition at line 69 of file JP2Importer.h.

Referenced by isArgb(), isGrayscale(), isRgb(), JP2Importer(), updateRawBuffer(), and ~JP2Importer().

◆ m_pixelType

Isis::PixelType Isis::JP2Importer::m_pixelType

private

Pixel type of the input image needed for reading data into the buffer.

Definition at line 75 of file JP2Importer.h.

Referenced by getFromBuffer(), JP2Importer(), and updateRawBuffer().

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

src/base/objs/JP2Importer/JP2Importer.h
src/base/objs/JP2Importer/JP2Importer.cpp

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ GetChannelMethod

Constructor & Destructor Documentation

◆ JP2Importer()

◆ ~JP2Importer()

Member Function Documentation

◆ bands()

◆ convertProjection()

◆ convertRgbToGray()

◆ createOutput()

◆ filename()

◆ fromFileName()

◆ getAlpha()

◆ getBandChannel()

◆ getBlue()

◆ getFromBuffer()

◆ 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_buffer

◆ m_decoder

◆ m_pixelType