YARP
Yet Another Robot Platform
yarp::sig::ImageOf< T > Class Template Reference

Typed image class. More...

#include <yarp/sig/Image.h>

Public Member Functions

 ImageOf ()
 
size_t getPixelSize () const override
 
int getPixelCode () const override
 
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
 
int getPixelCode () const
 
int getPixelCode () const
 
int getPixelCode () const
 
int getPixelCode () const
 
int getPixelCode () const
 
int getPixelCode () const
 
int getPixelCode () const
 
int getPixelCode () const
 
int getPixelCode () const
 
int getPixelCode () const
 
int getPixelCode () const
 
int getPixelCode () const
 
int getPixelCode () const
 

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/file_grabber/file_grabber.cpp, dev/grabber_client/grabber_client.cpp, os/image_process/image_process.cpp, os/image_process_module/image_process_module.cpp, and os/image_source/image_source.cpp.

Definition at line 646 of file Image.h.

Constructor & Destructor Documentation

◆ ImageOf()

template<class T >
yarp::sig::ImageOf< T >::ImageOf ( )
inline

Definition at line 651 of file Image.h.

Member Function Documentation

◆ getPixelCode() [1/15]

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

Definition at line 694 of file Image.h.

◆ getPixelCode() [2/15]

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

Definition at line 699 of file Image.h.

◆ getPixelCode() [3/15]

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

Definition at line 704 of file Image.h.

◆ getPixelCode() [4/15]

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

Definition at line 709 of file Image.h.

◆ getPixelCode() [5/15]

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

Definition at line 714 of file Image.h.

◆ getPixelCode() [6/15]

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

Definition at line 719 of file Image.h.

◆ getPixelCode() [7/15]

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

Definition at line 724 of file Image.h.

◆ getPixelCode() [8/15]

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

Definition at line 729 of file Image.h.

◆ getPixelCode() [9/15]

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

Definition at line 734 of file Image.h.

◆ getPixelCode() [10/15]

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

Definition at line 739 of file Image.h.

◆ getPixelCode() [11/15]

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

Definition at line 744 of file Image.h.

◆ getPixelCode() [12/15]

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

Definition at line 749 of file Image.h.

◆ getPixelCode() [13/15]

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

Definition at line 754 of file Image.h.

◆ getPixelCode() [14/15]

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

Definition at line 759 of file Image.h.

◆ getPixelCode() [15/15]

template<typename T >
int yarp::sig::ImageOf< T >::getPixelCode
inlineoverride

Definition at line 764 of file Image.h.

◆ getPixelSize()

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

Definition at line 657 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 675 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 671 of file Image.h.

◆ pixel() [1/2]

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

Definition at line 663 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 667 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 679 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 684 of file Image.h.


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