List of all members | Public Member Functions | Static Public Member Functions | Public Attributes
ImageBase Class Referenceabstract

A class mediating between the ImageProvider/Processor APIs (based on IVT CByteImages or raw pixel buffers) and the ARON image API (based on cv::Mat). More...

#include <VisionX/libraries/armem/vision/images/core/Image.h>

Public Member Functions

void addQuery (armarx::armem::client::query::Builder &queryBuilder) const
 
virtual const cv::Mat & getImage () const =0
 
virtual cv::Mat & getImage ()=0
 
 ImageBase (const armarx::armem::MemoryID &instanceID, size_t imageIndex)
 
virtual std::string printFormat () const =0
 
virtual void resetImage (int rows, int cols)=0
 
virtual armarx::aron::data::DictPtr toAron () const =0
 
virtual CByteImage toCByteImage () const =0
 
virtual bool updateAronImage (const armarx::armem::wm::Memory &memory)=0
 
virtual bool usePixels (CByteImage **inputImages)
 
virtual bool usePixels (CByteImage *inputImage)=0
 
virtual bool usePixels (void **inputPixelBuffers)
 
virtual bool usePixels (void *inputPixelBuffers)=0
 
virtual ~ImageBase ()
 

Static Public Member Functions

static bool areSameSize (const CByteImage &lhs, const CByteImage &rhs)
 
static bool areSameSize (const CByteImage &lhs, const cv::Mat &rhs)
 
static bool areSameSize (const cv::Mat &lhs, const CByteImage &rhs)
 
static bool areSameSize (const cv::Mat &lhs, const cv::Mat &rhs)
 

Public Attributes

size_t imageIndex = 0
 
armarx::armem::MemoryID instanceID
 
bool updated = false
 

Detailed Description

A class mediating between the ImageProvider/Processor APIs (based on IVT CByteImages or raw pixel buffers) and the ARON image API (based on cv::Mat).

This is the non-template base class of Image.

Definition at line 34 of file Image.h.

Constructor & Destructor Documentation

◆ ImageBase()

ImageBase ( const armarx::armem::MemoryID &  instanceID,
size_t  imageIndex 
)

Definition at line 24 of file Image.cpp.

◆ ~ImageBase()

~ImageBase ( )
virtual

Definition at line 30 of file Image.cpp.

Member Function Documentation

◆ addQuery()

void addQuery ( armarx::armem::client::query::Builder &  queryBuilder) const

Definition at line 47 of file Image.cpp.

+ Here is the call graph for this function:

◆ areSameSize() [1/4]

bool areSameSize ( const CByteImage &  lhs,
const CByteImage &  rhs 
)
static

Definition at line 56 of file Image.cpp.

+ Here is the caller graph for this function:

◆ areSameSize() [2/4]

bool areSameSize ( const CByteImage &  lhs,
const cv::Mat &  rhs 
)
static

Definition at line 74 of file Image.cpp.

+ Here is the call graph for this function:

◆ areSameSize() [3/4]

bool areSameSize ( const cv::Mat &  lhs,
const CByteImage &  rhs 
)
static

Definition at line 68 of file Image.cpp.

◆ areSameSize() [4/4]

bool areSameSize ( const cv::Mat &  lhs,
const cv::Mat &  rhs 
)
static

Definition at line 62 of file Image.cpp.

◆ getImage() [1/2]

virtual const cv::Mat& getImage ( ) const
pure virtual

◆ getImage() [2/2]

virtual cv::Mat& getImage ( )
pure virtual

◆ printFormat()

virtual std::string printFormat ( ) const
pure virtual

◆ resetImage()

virtual void resetImage ( int  rows,
int  cols 
)
pure virtual

◆ toAron()

virtual armarx::aron::data::DictPtr toAron ( ) const
pure virtual

◆ toCByteImage()

virtual CByteImage toCByteImage ( ) const
pure virtual

◆ updateAronImage()

virtual bool updateAronImage ( const armarx::armem::wm::Memory &  memory)
pure virtual

◆ usePixels() [1/4]

bool usePixels ( CByteImage **  inputImages)
virtual

Definition at line 35 of file Image.cpp.

+ Here is the caller graph for this function:

◆ usePixels() [2/4]

virtual bool usePixels ( CByteImage *  inputImage)
pure virtual

◆ usePixels() [3/4]

bool usePixels ( void **  inputPixelBuffers)
virtual

Definition at line 41 of file Image.cpp.

+ Here is the call graph for this function:

◆ usePixels() [4/4]

virtual bool usePixels ( void *  inputPixelBuffers)
pure virtual

Member Data Documentation

◆ imageIndex

size_t imageIndex = 0

Definition at line 74 of file Image.h.

◆ instanceID

armarx::armem::MemoryID instanceID

Definition at line 73 of file Image.h.

◆ updated

bool updated = false

Definition at line 76 of file Image.h.

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