Typed image class. More...

#include <yarp/sig/Image.h>

Inheritance diagram for yarp::sig::ImageOf< T >:

Public Member Functions
	ImageOf ()

size_t	getPixelSize () const override
	Gets pixel size in memory in bytes.

int	getPixelCode () const override
	Gets pixel type identifier.

T &	pixel (size_t x, size_t y)

T &	pixel (size_t x, size_t y) const

const T &	operator() (size_t x, size_t y) const

T &	operator() (size_t x, size_t y)

T &	safePixel (size_t x, size_t y)

const T &	safePixel (size_t x, size_t y) const

int	getPixelCode () const
	Gets pixel type identifier.

int	getPixelCode () const
	Gets pixel type identifier.

int	getPixelCode () const
	Gets pixel type identifier.

int	getPixelCode () const
	Gets pixel type identifier.

int	getPixelCode () const
	Gets pixel type identifier.

int	getPixelCode () const
	Gets pixel type identifier.

int	getPixelCode () const
	Gets pixel type identifier.

int	getPixelCode () const
	Gets pixel type identifier.

int	getPixelCode () const
	Gets pixel type identifier.

int	getPixelCode () const
	Gets pixel type identifier.

int	getPixelCode () const
	Gets pixel type identifier.

int	getPixelCode () const
	Gets pixel type identifier.

int	getPixelCode () const
	Gets pixel type identifier.

int	getPixelCode () const
	Gets pixel type identifier.

Public Member Functions inherited from yarp::sig::Image
	Image ()
	Default constructor.

	Image (const Image &alt)
	Copy constructor.

	Image (Image &&other) noexcept
	Move constructor.

Image &	operator= (const Image &alt)
	Assignment operator.

Image &	operator= (Image &&other) noexcept
	Move assignment operator.

bool	operator== (const Image &alt) const
	Comparison operator.

	~Image () override
	Destructor.

bool	copy (const Image &alt)
	Copy operator.

bool	copy (const Image &alt, size_t w, size_t h)
	Scaled copy.

bool	move (Image &&alt) noexcept
	move operator.

bool	swap (Image &alt)
	swap operator.

size_t	width () const
	Gets width of image in pixels.

size_t	height () const
	Gets height of image in pixels.

size_t	getRowSize () const
	Size of the underlying image buffer rows.

size_t	getQuantum () const
	The size of a row is constrained to be a multiple of the "quantum".

size_t	getPadding () const
	Returns the number of padding bytes.

unsigned char *	getRow (size_t r)
	Get the address of a the first byte of a row in memory.

const unsigned char *	getRow (size_t r) const
	Get the address of a the first byte of a row in memory, const versions.

unsigned char *	getPixelAddress (size_t x, size_t y) const
	Get address of a pixel in memory.

bool	isPixel (size_t x, size_t y) const
	Check whether a coordinate lies within the image.

void	zero ()
	Set all pixels to 0.

void	resize (size_t imgWidth, size_t imgHeight)
	Reallocate an image to be of a desired size, throwing away its current contents.

void	resize (const Image &alt)
	Reallocate the size of the image to match another, throwing away the actual content of the image.

void	setExternal (const void *data, size_t imgWidth, size_t imgHeight)
	Use this to wrap an external image.

unsigned char *	getRawImage () const
	Access to the internal image buffer.

size_t	getRawImageSize () const
	Access to the internal buffer size information (this is how much memory has been allocated for the image).

bool	read (yarp::os::ConnectionReader &connection) override
	Read image from a connection.

bool	write (yarp::os::ConnectionWriter &connection) const override
	Write image to a connection.

void	setQuantum (size_t imgQuantum)

char **	getRowArray ()
	Get an array of pointers to the rows of the image.

yarp::os::Type	getReadType () const override

Public Member Functions inherited from yarp::os::Portable
virtual Type	getType () const

Public Member Functions inherited from yarp::os::PortReader
virtual	~PortReader ()
	Destructor.

Public Member Functions inherited from yarp::os::PortWriter
virtual	~PortWriter ()
	Destructor.

virtual void	onCompletion () const
	This is called when the port has finished all writing operations.

virtual void	onCommencement () const
	This is called when the port is about to begin writing operations.

virtual yarp::os::Type	getWriteType () const

Additional Inherited Members
Static Public Member Functions inherited from yarp::os::Portable
static bool	copyPortable (const PortWriter &writer, PortReader &reader)
	Copy one portable to another, via writing and reading.

Protected Member Functions inherited from yarp::sig::Image
void	setPixelCode (int imgPixelCode)

void	setPixelSize (size_t imgPixelSize)

Detailed Description

template<class T>
class yarp::sig::ImageOf< T >

Typed image class.

This is a wrapper over yarp::sig::Image providing type security for pixel access. "T" can be any of sig::PixelMono, sig::PixelMono16, sig::PixelRgb, sig::PixelHsv, sig::PixelBgr, sig::PixelMonoSigned, sig::PixelRgbSigned, sig::PixelFloat, sig::PixelRgbFloat, sig::PixelHsvFloat, sig::PixelInt. If ImageOf::copy is called for two such images, a reasonable casting operation will occur if the pixel types are different.

Examples: dev/grabber_client/grabber_client.cpp, dev/grabber_crop/grabber_crop.cpp, imagemagick/main.cpp, and opencv/main.cpp.

Definition at line 602 of file Image.h.

Constructor & Destructor Documentation

◆ ImageOf()

template<class T >

yarp::sig::ImageOf< T >::ImageOf ( )

inline

Definition at line 607 of file Image.h.

Member Function Documentation

◆ getPixelCode() [1/15]

int yarp::sig::ImageOf< yarp::sig::PixelMono >::getPixelCode ( ) const

inlinevirtual

Gets pixel type identifier.

Images have an associated type identifier to permit automatic casting between different image types.

Returns: the image type identifier

Reimplemented from yarp::sig::Image.

Definition at line 649 of file Image.h.

◆ getPixelCode() [2/15]

int yarp::sig::ImageOf< yarp::sig::PixelMono16 >::getPixelCode ( ) const

inlinevirtual

Gets pixel type identifier.

Images have an associated type identifier to permit automatic casting between different image types.

Returns: the image type identifier

Reimplemented from yarp::sig::Image.

Definition at line 654 of file Image.h.

◆ getPixelCode() [3/15]

int yarp::sig::ImageOf< yarp::sig::PixelRgb >::getPixelCode ( ) const

inlinevirtual

Gets pixel type identifier.

Images have an associated type identifier to permit automatic casting between different image types.

Returns: the image type identifier

Reimplemented from yarp::sig::Image.

Definition at line 659 of file Image.h.

◆ getPixelCode() [4/15]

int yarp::sig::ImageOf< yarp::sig::PixelRgba >::getPixelCode ( ) const

inlinevirtual

Gets pixel type identifier.

Images have an associated type identifier to permit automatic casting between different image types.

Returns: the image type identifier

Reimplemented from yarp::sig::Image.

Definition at line 664 of file Image.h.

◆ getPixelCode() [5/15]

int yarp::sig::ImageOf< yarp::sig::PixelHsv >::getPixelCode ( ) const

inlinevirtual

Gets pixel type identifier.

Images have an associated type identifier to permit automatic casting between different image types.

Returns: the image type identifier

Reimplemented from yarp::sig::Image.

Definition at line 669 of file Image.h.

◆ getPixelCode() [6/15]

int yarp::sig::ImageOf< yarp::sig::PixelBgr >::getPixelCode ( ) const

inlinevirtual

Gets pixel type identifier.

Images have an associated type identifier to permit automatic casting between different image types.

Returns: the image type identifier

Reimplemented from yarp::sig::Image.

Definition at line 674 of file Image.h.

◆ getPixelCode() [7/15]

int yarp::sig::ImageOf< yarp::sig::PixelBgra >::getPixelCode ( ) const

inlinevirtual

Gets pixel type identifier.

Images have an associated type identifier to permit automatic casting between different image types.

Returns: the image type identifier

Reimplemented from yarp::sig::Image.

Definition at line 679 of file Image.h.

◆ getPixelCode() [8/15]

int yarp::sig::ImageOf< yarp::sig::PixelMonoSigned >::getPixelCode ( ) const

inlinevirtual

Gets pixel type identifier.

Images have an associated type identifier to permit automatic casting between different image types.

Returns: the image type identifier

Reimplemented from yarp::sig::Image.

Definition at line 684 of file Image.h.

◆ getPixelCode() [9/15]

int yarp::sig::ImageOf< yarp::sig::PixelRgbSigned >::getPixelCode ( ) const

inlinevirtual

Gets pixel type identifier.

Images have an associated type identifier to permit automatic casting between different image types.

Returns: the image type identifier

Reimplemented from yarp::sig::Image.

Definition at line 689 of file Image.h.

◆ getPixelCode() [10/15]

int yarp::sig::ImageOf< yarp::sig::PixelFloat >::getPixelCode ( ) const

inlinevirtual

Gets pixel type identifier.

Images have an associated type identifier to permit automatic casting between different image types.

Returns: the image type identifier

Reimplemented from yarp::sig::Image.

Definition at line 694 of file Image.h.

◆ getPixelCode() [11/15]

int yarp::sig::ImageOf< yarp::sig::PixelRgbFloat >::getPixelCode ( ) const

inlinevirtual

Gets pixel type identifier.

Images have an associated type identifier to permit automatic casting between different image types.

Returns: the image type identifier

Reimplemented from yarp::sig::Image.

Definition at line 699 of file Image.h.

◆ getPixelCode() [12/15]

int yarp::sig::ImageOf< yarp::sig::PixelRgbInt >::getPixelCode ( ) const

inlinevirtual

Gets pixel type identifier.

Images have an associated type identifier to permit automatic casting between different image types.

Returns: the image type identifier

Reimplemented from yarp::sig::Image.

Definition at line 704 of file Image.h.

◆ getPixelCode() [13/15]

int yarp::sig::ImageOf< yarp::sig::PixelHsvFloat >::getPixelCode ( ) const

inlinevirtual

Gets pixel type identifier.

Images have an associated type identifier to permit automatic casting between different image types.

Returns: the image type identifier

Reimplemented from yarp::sig::Image.

Definition at line 709 of file Image.h.

◆ getPixelCode() [14/15]

int yarp::sig::ImageOf< yarp::sig::PixelInt >::getPixelCode ( ) const

inlinevirtual

Gets pixel type identifier.

Images have an associated type identifier to permit automatic casting between different image types.

Returns: the image type identifier

Reimplemented from yarp::sig::Image.

Definition at line 714 of file Image.h.

◆ getPixelCode() [15/15]

template<typename T >

int yarp::sig::ImageOf< T >::getPixelCode ( ) const

inlineoverridevirtual

Gets pixel type identifier.

Images have an associated type identifier to permit automatic casting between different image types.

Returns: the image type identifier

Reimplemented from yarp::sig::Image.

Definition at line 719 of file Image.h.

◆ getPixelSize()

template<class T >

size_t yarp::sig::ImageOf< T >::getPixelSize ( ) const

inlineoverridevirtual

Gets pixel size in memory in bytes.

Returns: the size of the pixels stored in the image, in bytes

Reimplemented from yarp::sig::Image.

Definition at line 613 of file Image.h.

◆ operator()() [1/2]

template<class T >

T & yarp::sig::ImageOf< T >::operator()	(	size_t	x,
		size_t	y
	)

inline

Definition at line 631 of file Image.h.

◆ operator()() [2/2]

template<class T >

const T & yarp::sig::ImageOf< T >::operator()	(	size_t	x,
		size_t	y
	)		const

inline

Definition at line 627 of file Image.h.

◆ pixel() [1/2]

template<class T >

T & yarp::sig::ImageOf< T >::pixel	(	size_t	x,
		size_t	y
	)

inline

Examples: imagemagick/main.cpp.

Definition at line 619 of file Image.h.

◆ pixel() [2/2]

template<class T >

T & yarp::sig::ImageOf< T >::pixel	(	size_t	x,
		size_t	y
	)		const

inline

Definition at line 623 of file Image.h.

◆ safePixel() [1/2]

template<class T >

T & yarp::sig::ImageOf< T >::safePixel	(	size_t	x,
		size_t	y
	)

inline

Definition at line 635 of file Image.h.

◆ safePixel() [2/2]

template<class T >

const T & yarp::sig::ImageOf< T >::safePixel	(	size_t	x,
		size_t	y
	)		const

inline

Definition at line 640 of file Image.h.

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

src/libYARP_sig/src/yarp/sig/Image.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ImageOf()

Member Function Documentation

◆ getPixelCode() [1/15]

◆ getPixelCode() [2/15]

◆ getPixelCode() [3/15]

◆ getPixelCode() [4/15]

◆ getPixelCode() [5/15]

◆ getPixelCode() [6/15]

◆ getPixelCode() [7/15]

◆ getPixelCode() [8/15]

◆ getPixelCode() [9/15]

◆ getPixelCode() [10/15]

◆ getPixelCode() [11/15]

◆ getPixelCode() [12/15]

◆ getPixelCode() [13/15]

◆ getPixelCode() [14/15]

◆ getPixelCode() [15/15]

◆ getPixelSize()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ pixel() [1/2]

◆ pixel() [2/2]

◆ safePixel() [1/2]

◆ safePixel() [2/2]