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

Typed image class. More...

#include <yarp/sig/Image.h>

Detailed Description

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

Typed image class.

This is a wrapper over YARPGenericImage 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.

Definition at line 28 of file 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
 

Constructor & Destructor Documentation

◆ ImageOf()

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

Definition at line 589 of file Image.h.

Member Function Documentation

◆ getPixelCode() [1/15]

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

Definition at line 632 of file Image.h.

◆ getPixelCode() [2/15]

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

Definition at line 637 of file Image.h.

◆ getPixelCode() [3/15]

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

Definition at line 642 of file Image.h.

◆ getPixelCode() [4/15]

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

Definition at line 647 of file Image.h.

◆ getPixelCode() [5/15]

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

Definition at line 652 of file Image.h.

◆ getPixelCode() [6/15]

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

Definition at line 657 of file Image.h.

◆ getPixelCode() [7/15]

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

Definition at line 662 of file Image.h.

◆ getPixelCode() [8/15]

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

Definition at line 667 of file Image.h.

◆ getPixelCode() [9/15]

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

Definition at line 672 of file Image.h.

◆ getPixelCode() [10/15]

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

Definition at line 677 of file Image.h.

◆ getPixelCode() [11/15]

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

Definition at line 682 of file Image.h.

◆ getPixelCode() [12/15]

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

Definition at line 687 of file Image.h.

◆ getPixelCode() [13/15]

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

Definition at line 692 of file Image.h.

◆ getPixelCode() [14/15]

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

Definition at line 697 of file Image.h.

◆ getPixelCode() [15/15]

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

Definition at line 702 of file Image.h.

◆ getPixelSize()

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

Definition at line 595 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 613 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 609 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 601 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 605 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 617 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 622 of file Image.h.


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