A class to hold image data. It consists of three things: the actual image data, the corresponding metadata and some operations that can be executed on an image as a whole. The image data arev stored as a vector of ArrayGrids that represent the spectral bands (like red, green, blue, ...) of an image. More...

#include <Image.h>

Public Member Functions
	Image (int width, int height)
	Constructor. Creates an empty image with given width and height. More...

	Image (int width, int height, int nrBands)
	Constructor. Creates an image with one band with given width, height and number of bands. More...

	Image (ArrayGrid< double > *pDataGrid)
	Constructor. Creates an image with one band ArrayGrid as the only band. More...

	Image (ArrayGrid< bool > *pBoolGrid)
	Constructor. Creates an image with one band created from a boolean grid with value 0 for false and 255 for true = 255. More...

	~Image ()
	Destructor.

std::string	GetImageName ()
	gets the name for this image

void	SetImageName (std::string imagename)
	sets the name for this image to "imagename" More...

Image *	Clone ()
	Makes a new image that is an exact, independant copy of the current image. Also known as "deep copy".

	Image (Image &otherImage)
	Copy constructor. More...

Image *	ExtractROIAsNewImage (common::RectangularROI< int > rroi)
	Creates a new image cropped from ROI of this image. More...

bool	InsertSubImage (Image *pSubImage, int xTop, int yTop)
	overwrites part of an image with a subimage More...

void	AddBand (ArrayGrid< double > *pBand)
	adds a new band to the image. More...

void	RemoveBand (ArrayGrid< double > *pBand)
	removes a band from the image. More...

void	RemoveBand (int i)
	removes a band from the image. More...

void	ReplaceBand (ArrayGrid< double > pBandOld, ArrayGrid< double > pBandNew)
	replaces the old band by the new band The old band is deleted!! More...

std::vector< ArrayGrid< double > * > &	GetBands ()
	gets the STL vector containing the image bands.

int	GetWidth ()
	gets the width of this images.

int	GetHeight ()
	gets the height of this image.

int	GetNumberOfBands ()
	gets the number of bands in this image.

void	GetMinMax (double &outMin, double &outMax, int &minBandNr, int &maxBandNr)
	Gets the minimum and maximum present in the current image. More...

void	GetMinMax (double &outMin, double &outMax)
	Gets the minimum and maximum present in the current image. More...

double	GetAbsMax ()
	Gets the largest absolute value present in this image. More...

void	Rescale (double mmin=0.0, double mmax=255.0)
	Linearly rescales image intensities Values are rescaled from old min and max value over all bands to new min and max value for all bands. More...

void	CopyImageValues (Image *pOtherImage)
	replace intensities in this image by intensities of another image Condition: image has same width, height and number of bands; if not, nothing happens...

void	ClipImageValues (double clippedMin, double clippedMax)

void	MultiplyWith (Image *pImg)
	multiplies image point by point with another image More...

void	Scale (double factor)
	scales all image intensities with a certain factor More...

void	AddGaussianNoise (double sigma, bool isColored=true)
	adds Gaussian noise to current image More...

void	ApplyPoissonNoise (double factor, bool isColored=true)
	applies Poisson noise to current image Here, we assume that the image is scaled for visualization, and that the underlying measured intensities can be recomputed by applying a factor More...

void	ApplySaltAnPepperNoise (double fraction, bool isColored=true)
	applies salt&pepper noise to current image More...

ColorValue	GetColor (int x, int y)
	Gets color at given coordinates (x, y) More...

ColorValue	GetColor (common::Point< int > pt)
	Gets color at given coordinates (x, y) More...

void	SetColor (int x, int y, ColorValue cv)
	Gets color at given coordinates (x, y) More...

void	SetColor (common::Point< int > pt, ColorValue cv)
	Sets color at given point pt. More...

bool	HSVToRGB ()
	Converts image from HSV color representation to RGB. More...

bool	RGBToHSV ()
	Converts image from RGB color representation to HSV. More...

bool	HSIToRGB ()
	Converts image from HSI color representation to RGB. More...

bool	RGBToHSI ()
	Converts image from RGB color representation to HSI. More...

bool	HSLToRGB ()
	Converts image from HSL color representation to RGB. More...

bool	RGBToHSL ()
	Converts image from RGB color representation to HSL. More...

bool	sRGBToXYZ (ColorValue referenceIlluminant=ColorConstants::sD65_XYZ)
	Converts image from sRGB color representation to XYZ. More...

bool	XYZTosRGB (ColorValue referenceIlluminant=ColorConstants::sD65_XYZ)
	Converts image from XYZ color representation to sRGB. More...

bool	AdobeRGBToXYZ (ColorValue referenceIlluminant=ColorConstants::sD65_XYZ)
	Converts image from AdobeRGB color representation to XYZ. More...

bool	XYZToAdobeRGB (ColorValue referenceIlluminant=ColorConstants::sD65_XYZ)
	Converts image from XYZ color representation to AdobeRGB. More...

bool	sRGBToLuv (ColorValue referenceIlluminant=ColorConstants::sD65_XYZ)
	Converts image from sRGB color representation to Luv. More...

bool	LuvTosRGB (ColorValue referenceIlluminant=ColorConstants::sD65_XYZ)
	Converts image from Luv color representation to sRGB. More...

bool	sRGBToLab (ColorValue referenceIlluminant=ColorConstants::sD65_XYZ)
	Converts image from sRGB color representation to (CIE)Lab. More...

bool	LabTosRGB (ColorValue referenceIlluminant=ColorConstants::sD65_XYZ)
	Converts image from (CIE)Lab color representation to sRGB. More...

bool	RGBToYUV ()
	Converts image from RGB color representation to YUV. More...

bool	YUVToRGB ()
	Converts image from YUV color representation to RGB. More...

bool	RGBToCMY ()
	Converts image from RGB color representation to CMY. More...

bool	CMYToRGB ()
	Converts image from XYZ color representation to sRGB. More...

Detailed Description

A class to hold image data. It consists of three things: the actual image data, the corresponding metadata and some operations that can be executed on an image as a whole. The image data arev stored as a vector of ArrayGrids that represent the spectral bands (like red, green, blue, ...) of an image.

Constructor & Destructor Documentation

stira::imagedata::Image::Image	(	int	width,
		int	height
	)

Constructor. Creates an empty image with given width and height.

This image just has metadata, and no data structures allocated yet!! Bands must still be added.

Parameters

width	width of image to be constructed
height	height of image to be constructed
type	underlying data type of image (not used yet)

stira::imagedata::Image::Image	(	int	width,
		int	height,
		int	nrBands
	)

Constructor. Creates an image with one band with given width, height and number of bands.

Parameters

width	width of image to be constructed
height	height of image to be constructed
nrBands	number of bands for image to be constructed

stira::imagedata::Image::Image ( ArrayGrid< double > * pDataGrid )

Constructor. Creates an image with one band ArrayGrid as the only band.

Parameters

pDataGrid data grid to take as band in the image

Warning: the image does take ownership of this band; don't delete it somewhere else!!

References stira::imagedata::ArrayGrid< T >::GetHeight(), and stira::imagedata::ArrayGrid< T >::GetWidth().

stira::imagedata::Image::Image ( ArrayGrid< bool > * pBoolGrid )

Constructor. Creates an image with one band created from a boolean grid with value 0 for false and 255 for true = 255.

Parameters

pBoolGrid data grid to take as band in the image

Warning: the image does NOT take ownership of the boolean grid; you have to delete it yourself when you're finished with it!!

References stira::imagedata::ArrayGrid< T >::GetHeight(), stira::imagedata::ArrayGrid< T >::GetValue(), stira::imagedata::ArrayGrid< T >::GetWidth(), and stira::imagedata::ArrayGrid< T >::SetValue().

stira::imagedata::Image::Image ( Image & otherImage )

Copy constructor.

Parameters

otherImage image to construct new image from

References GetBands(), GetHeight(), GetImageName(), GetNumberOfBands(), and GetWidth().

Member Function Documentation

void stira::imagedata::Image::AddBand ( ArrayGrid< double > * pBand )

adds a new band to the image.

Warning: the image does take ownership of this band; don't delete it somewhere else!!

Parameters

pBand band to be added to the image

References stira::imagedata::ArrayGrid< T >::GetHeight(), and stira::imagedata::ArrayGrid< T >::GetWidth().

void stira::imagedata::Image::AddGaussianNoise	(	double	sigma,
		bool	isColored = `true`
	)

adds Gaussian noise to current image

Parameters

sigma	sigma of the noise to add
isColored	flag if the noise to apply is colored or not

Warning: overwrites old image values; assumes image values are in range between 0 and 255

References stira::common::MathUtils::ClipValue(), stira::imagedata::ArrayGrid< T >::GetValue(), and stira::imagedata::ArrayGrid< T >::SetValue().

bool stira::imagedata::Image::AdobeRGBToXYZ ( ColorValue referenceIlluminant = ColorConstants::sD65_XYZ )

Converts image from AdobeRGB color representation to XYZ.

Parameters

referenceIlluminant reference illuminant (or white point)

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!

References stira::imagedata::TransformColorSpace::AdobeRGBtoXYZ(), and stira::imagedata::TransformColorSpace::SetReferenceWhite().

void stira::imagedata::Image::ApplyPoissonNoise	(	double	factor,
		bool	isColored = `true`
	)

applies Poisson noise to current image Here, we assume that the image is scaled for visualization, and that the underlying measured intensities can be recomputed by applying a factor

Parameters

factor	factor with which the "measured" image values were multiplied to get them in the current range
isColored	flag if the noise to apply is colored or not

Warning: overwrites old image values; assumes image values are in range between 0 and 255

References stira::imagedata::ColorValue::c, stira::common::MathUtils::ClipValue(), stira::imagedata::ArrayGrid< T >::GetValue(), stira::imagedata::TransformColorSpace::HSVtoRGB(), stira::imagedata::TransformColorSpace::RGBtoHSV(), and stira::imagedata::ArrayGrid< T >::SetValue().

void stira::imagedata::Image::ApplySaltAnPepperNoise	(	double	fraction,
		bool	isColored = `true`
	)

applies salt&pepper noise to current image

Parameters

fraction	fraction of the pixels to be corrupted
isColored	flag if the noise to apply is colored or not

Warning: overwrites old image values; assumes image values are in range between 0 and 255

References stira::imagedata::ArrayGrid< T >::SetValue().

bool stira::imagedata::Image::CMYToRGB ( )

Converts image from XYZ color representation to sRGB.

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!; these color spaces are not device independant

References stira::imagedata::TransformColorSpace::CMYtoRGB().

Image * stira::imagedata::Image::ExtractROIAsNewImage ( common::RectangularROI< int > rroi )

Creates a new image cropped from ROI of this image.

Parameters

rroi	rectangular ROI to create new subimage from

Returns: new subimage with same dimensions as rroi, which becomes the responsability of the caller to delete

References GetBands(), stira::common::RectangularROI< T >::GetHeight(), stira::common::RectangularROI< T >::GetTopLeftCorner(), stira::common::RectangularROI< T >::GetWidth(), stira::common::Point< T >::x, and stira::common::Point< T >::y.

double stira::imagedata::Image::GetAbsMax ( )

Gets the largest absolute value present in this image.

Returns: the largest absolute value in this image

ColorValue stira::imagedata::Image::GetColor	(	int	x,
		int	y
	)

Gets color at given coordinates (x, y)

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!

References stira::imagedata::ColorValue::c.

Referenced by stira::imagetools::ChromaticAdaptation::AdaptLabColor(), stira::imagetools::ImageTools::ConvertToGrayImage(), stira::imagetools::ImageTools::CreateIntArrayFromColorImage(), and stira::imagetools::ColorBalancer::RunPerfectReflector().

ColorValue stira::imagedata::Image::GetColor ( common::Point< int > pt )

Gets color at given coordinates (x, y)

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!

References stira::common::Point< T >::x, and stira::common::Point< T >::y.

void stira::imagedata::Image::GetMinMax	(	double &	outMin,
		double &	outMax,
		int &	minBandNr,
		int &	maxBandNr
	)

Gets the minimum and maximum present in the current image.

Parameters

outMin	minimum value actually present in current image
outMax	maximum value actually present in current image
minBandNr	number of color band in which the minimum value was found
maxBandNr	number of color band in which the maximum value was found

void stira::imagedata::Image::GetMinMax	(	double &	outMin,
		double &	outMax
	)

Gets the minimum and maximum present in the current image.

Parameters

outMin	minimum value actually present in current image
outMax	maximum value actually present in current image

bool stira::imagedata::Image::HSIToRGB ( )

Converts image from HSI color representation to RGB.

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!; these color spaces are not device independant

References stira::imagedata::TransformColorSpace::HSItoRGB().

Referenced by stira::contrastenhance::HistogramTools::HistogramEqualizeHSI().

bool stira::imagedata::Image::HSLToRGB ( )

Converts image from HSL color representation to RGB.

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!; these color spaces are not device independant

References stira::imagedata::TransformColorSpace::HSLtoRGB().

bool stira::imagedata::Image::HSVToRGB ( )

Converts image from HSV color representation to RGB.

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!; these color spaces are not device independant

References stira::imagedata::TransformColorSpace::HSVtoRGB().

bool stira::imagedata::Image::InsertSubImage	(	Image *	pSubImage,
		int	xTop,
		int	yTop
	)

overwrites part of an image with a subimage

Parameters

pSubImage	image to insert
xTop	x coordinate in parent image where to insert top left corner of sub image
yTop	y coordinate in parent image where to insert top left corner of sub image

References GetBands(), GetHeight(), GetNumberOfBands(), and GetWidth().

bool stira::imagedata::Image::LabTosRGB ( ColorValue referenceIlluminant = ColorConstants::sD65_XYZ )

Converts image from (CIE)Lab color representation to sRGB.

Parameters

referenceIlluminant reference illuminant (or white point)

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!

References stira::imagedata::TransformColorSpace::LabtosRGB(), and stira::imagedata::TransformColorSpace::SetReferenceWhite().

Referenced by stira::contrastenhance::HistogramTools::ColorHistogramEqualize().

bool stira::imagedata::Image::LuvTosRGB ( ColorValue referenceIlluminant = ColorConstants::sD65_XYZ )

Converts image from Luv color representation to sRGB.

Parameters

referenceIlluminant reference illuminant (or white point)

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!

References stira::imagedata::TransformColorSpace::LuvtosRGB(), and stira::imagedata::TransformColorSpace::SetReferenceWhite().

void stira::imagedata::Image::MultiplyWith ( Image * pImg )

multiplies image point by point with another image

Warning: overwrites current image; old pixel values are lost

Parameters

pImg	other image to multiply current image with

References GetBands(), GetHeight(), GetNumberOfBands(), and GetWidth().

Referenced by stira::contrastenhance::Retinex::RunMSRCR().

void stira::imagedata::Image::RemoveBand ( ArrayGrid< double > * pBand )

removes a band from the image.

Warning: this band is also deleted; make sure it is no longer used somewhere else!!

Parameters

pBand band to be removed from the image

void stira::imagedata::Image::RemoveBand ( int i )

removes a band from the image.

Warning: this band is also deleted; make sure it is no longer used somewhere else!!

Parameters

i	index of band to be removed from the image

void stira::imagedata::Image::ReplaceBand	(	ArrayGrid< double > *	pBandOld,
		ArrayGrid< double > *	pBandNew
	)

replaces the old band by the new band The old band is deleted!!

Parameters

pBandOld	pointer to old band
pBandNew	pointer to band that will replace the old band

void stira::imagedata::Image::Rescale	(	double	mmin = `0.0`,
		double	mmax = `255.0`
	)

Linearly rescales image intensities Values are rescaled from old min and max value over all bands to new min and max value for all bands.

Parameters

mmin	minimum value after rescaling
mmax	maximum value after rescaling

bool stira::imagedata::Image::RGBToCMY ( )

Converts image from RGB color representation to CMY.

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!; these color spaces are not device independant

References stira::imagedata::TransformColorSpace::RGBtoCMY().

bool stira::imagedata::Image::RGBToHSI ( )

Converts image from RGB color representation to HSI.

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!; these color spaces are not device independant

References stira::imagedata::TransformColorSpace::RGBtoHSI().

Referenced by stira::contrastenhance::HistogramTools::HistogramEqualizeHSI().

bool stira::imagedata::Image::RGBToHSL ( )

Converts image from RGB color representation to HSL.

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!; these color spaces are not device independant

References stira::imagedata::TransformColorSpace::RGBtoHSL().

bool stira::imagedata::Image::RGBToHSV ( )

Converts image from RGB color representation to HSV.

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!! H is between 0 and 360 degrees; S and V are between 0 and 1; these color spaces are not device independant

References stira::imagedata::TransformColorSpace::RGBtoHSV().

bool stira::imagedata::Image::RGBToYUV ( )

Converts image from RGB color representation to YUV.

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!; these color spaces are not device independant

References stira::imagedata::TransformColorSpace::RGBtoYUV().

Referenced by stira::imagetools::ColorBalancer::RunPerfectReflector().

void stira::imagedata::Image::Scale ( double factor )

scales all image intensities with a certain factor

Warning: overwrites current image; old pixel values are lost

Parameters

factor factor to scale pixel intensities with

void stira::imagedata::Image::SetColor	(	int	x,
		int	y,
		ColorValue	cv
	)

Gets color at given coordinates (x, y)

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!

References stira::imagedata::ColorValue::c.

void stira::imagedata::Image::SetColor	(	common::Point< int >	pt,
		ColorValue	cv
	)

Sets color at given point pt.

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!

References stira::common::Point< T >::x, and stira::common::Point< T >::y.

void stira::imagedata::Image::SetImageName ( std::string imagename )

sets the name for this image to "imagename"

Parameters

imagename name to set for this image

bool stira::imagedata::Image::sRGBToLab ( ColorValue referenceIlluminant = ColorConstants::sD65_XYZ )

Converts image from sRGB color representation to (CIE)Lab.

Parameters

referenceIlluminant reference illuminant (or white point)

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!

References stira::imagedata::TransformColorSpace::SetReferenceWhite(), and stira::imagedata::TransformColorSpace::sRGBtoLab().

Referenced by stira::contrastenhance::HistogramTools::ColorHistogramEqualize(), and stira::imagetools::ColorBalancer::RunPerfectReflector().

bool stira::imagedata::Image::sRGBToLuv ( ColorValue referenceIlluminant = ColorConstants::sD65_XYZ )

Converts image from sRGB color representation to Luv.

Parameters

referenceIlluminant reference illuminant (or white point)

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!

References stira::imagedata::TransformColorSpace::SetReferenceWhite(), and stira::imagedata::TransformColorSpace::sRGBtoLuv().

bool stira::imagedata::Image::sRGBToXYZ ( ColorValue referenceIlluminant = ColorConstants::sD65_XYZ )

Converts image from sRGB color representation to XYZ.

Parameters

referenceIlluminant reference illuminant (or white point)

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!

References stira::imagedata::TransformColorSpace::SetReferenceWhite(), and stira::imagedata::TransformColorSpace::sRGBtoXYZ().

bool stira::imagedata::Image::XYZToAdobeRGB ( ColorValue referenceIlluminant = ColorConstants::sD65_XYZ )

Converts image from XYZ color representation to AdobeRGB.

Parameters

referenceIlluminant reference illuminant (or white point)

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!

References stira::imagedata::TransformColorSpace::SetReferenceWhite(), and stira::imagedata::TransformColorSpace::XYZtoAdobeRGB().

bool stira::imagedata::Image::XYZTosRGB ( ColorValue referenceIlluminant = ColorConstants::sD65_XYZ )

Converts image from XYZ color representation to sRGB.

Parameters

referenceIlluminant reference illuminant (or white point)

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!

References stira::imagedata::TransformColorSpace::SetReferenceWhite(), and stira::imagedata::TransformColorSpace::XYZtosRGB().

bool stira::imagedata::Image::YUVToRGB ( )

Converts image from YUV color representation to RGB.

Warning: : assumes 3 color bands; make sure first you have (at least) three color bands!!; these color spaces are not device independant

References stira::imagedata::TransformColorSpace::YUVtoRGB().

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

imagedata/datastructures/Image.h
imagedata/datastructures/Image.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation