mrpt::img Namespace Reference

Classes
class	CCanvas
	This virtual class defines the interface of any object accepting drawing primitives on it. More...
class	CEnhancedMetaFile
	This class represents a Windows Enhanced Meta File (EMF) for generating and saving graphics. More...
class	CExceptionExternalImageNotFound
	Used in mrpt::img::CImage. More...
class	CImage
	A class for storing images as grayscale or RGB bitmaps. More...
class	CMappedImage
	This class encapsulates a MRPT Image and allows the sampling of individual pixels with sub-pixel accuracy and with a change of coordinates (eg, meters). More...
class	TCamera
	Parameters for the Brown-Conrady camera lens distortion model. More...
struct	TColor
	A RGB color - 8bit. More...
struct	TColorf
	An RGBA color - floats in the range [0,1]. More...
struct	TColorManager
	Manage R, G, B color triads and ask class instance of the next unique RGB combination. More...
struct	TPixelCoord
	A pair (x,y) of pixel coordinates (integer resolution). More...
struct	TPixelCoordf
	A pair (x,y) of pixel coordinates (subpixel resolution). More...
class	TStereoCamera
	Structure to hold the parameters of a pinhole stereo camera model. More...

Typedefs
using	TImageSize = TPixelCoord
	A type for image sizes. More...

Enumerations
enum	PixelDepth : int32_t {   PixelDepth::D8U = 0, PixelDepth::D8S = 1, PixelDepth::D16U = 2, PixelDepth::D16S = 3,   PixelDepth::D32S = 4, PixelDepth::D32F = 5, PixelDepth::D64F = 6 }
enum	TInterpolationMethod { IMG_INTERP_NN = 0, IMG_INTERP_LINEAR = 1, IMG_INTERP_CUBIC = 2, IMG_INTERP_AREA = 3 }
	Interpolation methods for images. More...
enum	TImageChannels : uint8_t { CH_GRAY = 1, CH_RGB = 3 }
	For use in mrpt::img::CImage. More...
enum	ctor_CImage_ref_or_gray { FAST_REF_OR_CONVERT_TO_GRAY = 1 }
	For usage in one of the CImage constructors. More...
enum	copy_type_t { SHALLOW_COPY = 0, DEEP_COPY = 1 }
	Define kind of copies. More...
enum	TColormap { cmNONE = -1, cmGRAYSCALE = 0, cmJET, cmHOT }
	Different colormaps for use in mrpt::img::colormap() More...

Functions
void	hsv2rgb (float h, float s, float v, float &r, float &g, float &b)
	Transform HSV color components to RGB, all of them in the range [0,1]. More...
void	rgb2hsv (float r, float g, float b, float &h, float &s, float &v)
	Transform RGB color components to HSV, all of them in the range [0,1]. More...
void	colormap (const TColormap &color_map, const float color_index, float &r, float &g, float &b)
	Transform a float number in the range [0,1] into RGB components. More...
mrpt::img::TColor	colormap (const TColormap &color_map, const float color_index)
void	jet2rgb (const float color_index, float &r, float &g, float &b)
	Computes the RGB color components (range [0,1]) for the corresponding color index in the range [0,1] using the MATLAB 'jet' colormap. More...
void	hot2rgb (const float color_index, float &r, float &g, float &b)
	Computes the RGB color components (range [0,1]) for the corresponding color index in the range [0,1] using the MATLAB 'hot' colormap. More...
bool	operator== (const mrpt::img::TCamera &a, const mrpt::img::TCamera &b)
bool	operator!= (const mrpt::img::TCamera &a, const mrpt::img::TCamera &b)
std::ostream &	operator<< (std::ostream &o, const TColor &c)
mrpt::serialization::CArchive &	operator<< (mrpt::serialization::CArchive &o, const TColor &c)
mrpt::serialization::CArchive &	operator>> (mrpt::serialization::CArchive &i, TColor &c)
TColor	operator+ (const TColor &first, const TColor &second)
	Pairwise addition of their corresponding RGBA members. More...
TColor	operator- (const TColor &first, const TColor &second)
	Pairwise substraction of their corresponding RGBA members. More...
bool	operator== (const TColor &first, const TColor &second)
std::ostream &	operator<< (std::ostream &o, const TColorf &c)
mrpt::serialization::CArchive &	operator<< (mrpt::serialization::CArchive &o, const TColorf &c)
mrpt::serialization::CArchive &	operator>> (mrpt::serialization::CArchive &i, TColorf &c)
std::ostream &	operator<< (std::ostream &o, const TPixelCoordf &p)
	Prints TPixelCoordf as "(x,y)". More...
std::ostream &	operator<< (std::ostream &o, const TPixelCoord &p)
	Prints TPixelCoord as "(x,y)". More...

Typedef Documentation

TImageSize

using mrpt::img::TImageSize = typedef TPixelCoord

A type for image sizes.

Definition at line 58 of file TPixelCoord.h.

Enumeration Type Documentation

copy_type_t

enum mrpt::img::copy_type_t

Define kind of copies.

Enumerator
SHALLOW_COPY	Shallow copy: the copied object is a reference to the original one.
DEEP_COPY	Deep copy: the copied object has a duplicate of all data, becoming independent.

Definition at line 72 of file img/CImage.h.

ctor_CImage_ref_or_gray

enum mrpt::img::ctor_CImage_ref_or_gray

For usage in one of the CImage constructors.

Enumerator
FAST_REF_OR_CONVERT_TO_GRAY

Definition at line 66 of file img/CImage.h.

PixelDepth

enum mrpt::img::PixelDepth : int32_t

strong

Enumerator
D8U
D8S
D16U
D16S
D32S
D32F
D64F

Definition at line 32 of file img/CImage.h.

TImageChannels

enum mrpt::img::TImageChannels : uint8_t

For use in mrpt::img::CImage.

Enumerator
CH_GRAY
CH_RGB

Definition at line 59 of file img/CImage.h.

Function Documentation

operator!=()

bool mrpt::img::operator!=	(	const mrpt::img::TCamera &	a,
		const mrpt::img::TCamera &	b
	)

Definition at line 238 of file TCamera.cpp.

operator+()

TColor mrpt::img::operator+	(	const TColor &	first,
		const TColor &	second
	)

Pairwise addition of their corresponding RGBA members.

Definition at line 23 of file TColor.cpp.

References mrpt::img::TColor::A, mrpt::img::TColor::B, mrpt::img::TColor::G, and mrpt::img::TColor::R.

operator-()

TColor mrpt::img::operator-	(	const TColor &	first,
		const TColor &	second
	)

Pairwise substraction of their corresponding RGBA members.

Definition at line 34 of file TColor.cpp.

References mrpt::img::TColor::A, mrpt::img::TColor::B, mrpt::img::TColor::G, and mrpt::img::TColor::R.

operator<<() [1/6]

std::ostream & mrpt::img::operator<<	(	std::ostream &	o,
		const TPixelCoordf &	p
	)

Prints TPixelCoordf as "(x,y)".

Definition at line 2190 of file CImage.cpp.

References mrpt::img::TPixelCoordf::x, and mrpt::img::TPixelCoordf::y.

operator<<() [2/6]

std::ostream & mrpt::img::operator<<	(	std::ostream &	o,
		const TPixelCoord &	p
	)

Prints TPixelCoord as "(x,y)".

Definition at line 2195 of file CImage.cpp.

References mrpt::img::TPixelCoord::x, and mrpt::img::TPixelCoord::y.

operator<<() [3/6]

std::ostream & mrpt::img::operator<<	(	std::ostream &	o,
		const TColor &	c
	)

Definition at line 80 of file TColor.cpp.

References mrpt::img::TColor::A, mrpt::img::TColor::B, mrpt::img::TColor::G, mrpt::img::TColor::R, and mrpt::system::os::sprintf().

Here is the call graph for this function:

operator<<() [4/6]

CArchive & mrpt::img::operator<<	(	mrpt::serialization::CArchive &	o,
		const TColor &	c
	)

Definition at line 92 of file TColor.cpp.

References mrpt::img::TColor::A, mrpt::img::TColor::B, mrpt::img::TColor::G, and mrpt::img::TColor::R.

operator<<() [5/6]

std::ostream & mrpt::img::operator<<	(	std::ostream &	o,
		const TColorf &	c
	)

Definition at line 105 of file TColor.cpp.

References mrpt::img::TColorf::A, mrpt::img::TColorf::B, mrpt::img::TColorf::G, mrpt::img::TColorf::R, and mrpt::system::os::sprintf().

Here is the call graph for this function:

operator<<() [6/6]

CArchive & mrpt::img::operator<<	(	mrpt::serialization::CArchive &	o,
		const TColorf &	c
	)

Definition at line 115 of file TColor.cpp.

References mrpt::img::TColorf::A, mrpt::img::TColorf::B, mrpt::img::TColorf::G, and mrpt::img::TColorf::R.

operator==() [1/2]

bool mrpt::img::operator==	(	const TColor &	first,
		const TColor &	second
	)

Definition at line 67 of file TColor.cpp.

References mrpt::img::TColor::A, mrpt::img::TColor::B, mrpt::img::TColor::G, and mrpt::img::TColor::R.

operator==() [2/2]

bool mrpt::img::operator==	(	const mrpt::img::TCamera &	a,
		const mrpt::img::TCamera &	b
	)

Definition at line 231 of file TCamera.cpp.

References mrpt::img::TCamera::dist, mrpt::img::TCamera::focalLengthMeters, mrpt::img::TCamera::intrinsicParams, mrpt::img::TCamera::ncols, and mrpt::img::TCamera::nrows.

operator>>() [1/2]

CArchive & mrpt::img::operator>>	(	mrpt::serialization::CArchive &	i,
		TColor &	c
	)

Definition at line 98 of file TColor.cpp.

References mrpt::img::TColor::A, mrpt::img::TColor::B, mrpt::img::TColor::G, and mrpt::img::TColor::R.

operator>>() [2/2]

CArchive & mrpt::img::operator>>	(	mrpt::serialization::CArchive &	i,
		TColorf &	c
	)

Definition at line 121 of file TColor.cpp.

References mrpt::img::TColorf::A, mrpt::img::TColorf::B, mrpt::img::TColorf::G, and mrpt::img::TColorf::R.