mmind::api::Frame< ElementType > Class Template Reference

Definition of data structure in device capturing image. More...

#include <MechEyeFrame.hpp>

Public Member Functions
	Frame ()
	~Frame ()
uint32_t	width () const
uint32_t	height () const
bool	empty () const
const ElementType *	data () const
ElementType *	data ()
const ElementType &	operator[] (std::size_t n) const
ElementType &	operator[] (std::size_t n)
const ElementType &	at (uint32_t row, uint32_t col) const
ElementType &	at (uint32_t row, uint32_t col)
void	resize (uint32_t width, uint32_t height)
void	release ()

Detailed Description

template<typename ElementType>
class mmind::api::Frame< ElementType >

Definition of data structure in device capturing image.

Definition at line 100 of file MechEyeFrame.hpp.

Constructor & Destructor Documentation

Frame()

template<typename ElementType >

mmind::api::Frame< ElementType >::Frame ( )

inline

Constructor

Definition at line 106 of file MechEyeFrame.hpp.

~Frame()

template<typename ElementType >

mmind::api::Frame< ElementType >::~Frame ( )

inline

Destructor

Definition at line 110 of file MechEyeFrame.hpp.

Member Function Documentation

at() [1/2]

template<typename ElementType >

ElementType & mmind::api::Frame< ElementType >::at ( uint32_t row, uint32_t col )

inline

Returns an element reference to the specified row and col index in the Frame.

Parameters

row	Index along the dimension height. It will throw an exception if the input row is greater than width.
col	Index along the dimension width. It will throw an exception if the input col is greater than height.

Definition at line 185 of file MechEyeFrame.hpp.

at() [2/2]

template<typename ElementType >

const ElementType & mmind::api::Frame< ElementType >::at ( uint32_t row, uint32_t col ) const

inline

Returns a const element reference to the specified row and col index in the Frame.

Parameters

row	Index along the dimension height. It will throw an exception if the input row is greater than width.
col	Index along the dimension width. It will throw an exception if the input col is greater than height.

Definition at line 170 of file MechEyeFrame.hpp.

data() [1/2]

template<typename ElementType >

ElementType * mmind::api::Frame< ElementType >::data ( )

inline

Returns the pointer to the element data.

Definition at line 135 of file MechEyeFrame.hpp.

data() [2/2]

template<typename ElementType >

const ElementType * mmind::api::Frame< ElementType >::data ( ) const

inline

Returns the pointer to the element data.

Definition at line 130 of file MechEyeFrame.hpp.

empty()

template<typename ElementType >

bool mmind::api::Frame< ElementType >::empty ( ) const

inline

Returns true if the Frame has no elements.

Definition at line 125 of file MechEyeFrame.hpp.

height()

template<typename ElementType >

uint32_t mmind::api::Frame< ElementType >::height ( ) const

inline

Returns the height of the Frame

Definition at line 120 of file MechEyeFrame.hpp.

operator[]() [1/2]

template<typename ElementType >

ElementType & mmind::api::Frame< ElementType >::operator[] ( std::size_t n )

inline

Returns a element reference to the specified index in the Frame using the operator [].

Parameters

n	Index along the one dimension. It will throw an exception if the input n is greater than width * height.

Definition at line 158 of file MechEyeFrame.hpp.

operator[]() [2/2]

template<typename ElementType >

const ElementType & mmind::api::Frame< ElementType >::operator[] ( std::size_t n ) const

inline

Returns a const element reference to the specified index in the Frame using the operator [].

Parameters

n	Index along the one dimension. It will throw an exception if the input n is greater than width * height.

Definition at line 145 of file MechEyeFrame.hpp.

release()

template<typename ElementType >

void mmind::api::Frame< ElementType >::release ( )

inline

Deallocated the Frame data.

Definition at line 209 of file MechEyeFrame.hpp.

resize()

template<typename ElementType >

void mmind::api::Frame< ElementType >::resize ( uint32_t width, uint32_t height )

inline

Change the Frame size to a new one. It will destroy the existing data and reallocate memory according to the new size.

Parameters

width	New number of the Frame width.
height	New number of the Frame height.

Definition at line 196 of file MechEyeFrame.hpp.

width()

template<typename ElementType >

uint32_t mmind::api::Frame< ElementType >::width ( ) const

inline

Returns the width of the Frame

Definition at line 115 of file MechEyeFrame.hpp.

---

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

• include/camera/deprecated/MechEyeFrame.hpp