Fawkes API  Fawkes Development Version
firevision::MirrorCalibTool::Image Class Reference

A container for a YUV-buffer etc. More...

Public Member Functions

 Image (const unsigned char *yuv_buffer, size_t buflen, int width, int height, PolarAngle ori)
 Constructor. More...
 
 Image (const Image &copy)
 Constructor. More...
 
Imageoperator= (const Image &copy)
 Assignment. More...
 
 ~Image ()
 Destructor. More...
 
unsigned char * yuv_buffer ()
 YUV buffer. More...
 
const unsigned char * yuv_buffer () const
 YUV buffer. More...
 
size_t buflen () const
 YUV buffer's length. More...
 
int width () const
 YUV buffer's width. More...
 
int height () const
 YUV buffer's height. More...
 
PolarAngle ori () const
 Angle of marks wrt X axis. More...
 
StepResultList & results ()
 List of results. More...
 
const StepResultList & results () const
 List of results. More...
 
const MarkList & premarks ()
 The premarks. More...
 
MarkList & marks ()
 The (final) marks. More...
 
const MarkList & marks () const
 The (final) marks. More...
 
void add_result (const StepResult &r)
 Appends a result. More...
 
StepResultresult (int i)
 Returns the i-th result. More...
 
const StepResultresult (int i) const
 Returns the i-th result. More...
 
void set_premarks (const MarkList &premarks)
 The premarks. More...
 
void set_marks (const MarkList &marks)
 The (final) marks. More...
 

Detailed Description

A container for a YUV-buffer etc.

Definition at line 783 of file mirror_calib.cpp.

Constructor & Destructor Documentation

◆ Image() [1/2]

firevision::MirrorCalibTool::Image::Image ( const unsigned char *  yuv_buffer,
size_t  buflen,
int  width,
int  height,
PolarAngle  ori 
)
inline

Constructor.

Parameters
yuv_bufferThe YUV buffer.
buflenThe buffer's size.
widthThe width.
heightThe height.
oriThe orientation.

Definition at line 792 of file mirror_calib.cpp.

◆ Image() [2/2]

firevision::MirrorCalibTool::Image::Image ( const Image copy)
inline

Constructor.

Parameters
copy

Definition at line 810 of file mirror_calib.cpp.

◆ ~Image()

firevision::MirrorCalibTool::Image::~Image ( )
inline

Destructor.

Definition at line 850 of file mirror_calib.cpp.

Member Function Documentation

◆ add_result()

void firevision::MirrorCalibTool::Image::add_result ( const StepResult r)
inline

Appends a result.

Parameters
rThe new result.

Definition at line 905 of file mirror_calib.cpp.

Referenced by firevision::MirrorCalibTool::next_step().

◆ buflen()

size_t firevision::MirrorCalibTool::Image::buflen ( ) const
inline

YUV buffer's length.

Returns
YUV buffer's length

Definition at line 869 of file mirror_calib.cpp.

Referenced by firevision::MirrorCalibTool::next_step().

◆ height()

int firevision::MirrorCalibTool::Image::height ( ) const
inline

YUV buffer's height.

Returns
YUV buffer's height

Definition at line 877 of file mirror_calib.cpp.

Referenced by firevision::MirrorCalibTool::draw_mark_lines(), firevision::MirrorCalibTool::next_step(), and firevision::MirrorCalibTool::save().

◆ marks() [1/2]

MarkList& firevision::MirrorCalibTool::Image::marks ( )
inline

The (final) marks.

Returns

Definition at line 897 of file mirror_calib.cpp.

Referenced by firevision::MirrorCalibTool::next_step().

◆ marks() [2/2]

const MarkList& firevision::MirrorCalibTool::Image::marks ( ) const
inline

The (final) marks.

Returns
The (final) marks

Definition at line 901 of file mirror_calib.cpp.

◆ operator=()

Image& firevision::MirrorCalibTool::Image::operator= ( const Image copy)
inline

Assignment.

Parameters
copyimage to copy
Returns
this image

Definition at line 828 of file mirror_calib.cpp.

◆ ori()

PolarAngle firevision::MirrorCalibTool::Image::ori ( ) const
inline

Angle of marks wrt X axis.

Returns
Angle of marks wrt X axis

Definition at line 881 of file mirror_calib.cpp.

Referenced by firevision::MirrorCalibTool::draw_mark_lines(), and firevision::MirrorCalibTool::next_step().

◆ premarks()

const MarkList& firevision::MirrorCalibTool::Image::premarks ( )
inline

The premarks.

Returns
The premarks

Definition at line 893 of file mirror_calib.cpp.

Referenced by firevision::MirrorCalibTool::next_step().

◆ result() [1/2]

StepResult& firevision::MirrorCalibTool::Image::result ( int  i)
inline

Returns the i-th result.

Parameters
iThe index of the result starting with 0.
Returns
result

Definition at line 910 of file mirror_calib.cpp.

Referenced by firevision::MirrorCalibTool::next_step().

◆ result() [2/2]

const StepResult& firevision::MirrorCalibTool::Image::result ( int  i) const
inline

Returns the i-th result.

Parameters
iThe index of the result starting with 0.
Returns
result

Definition at line 915 of file mirror_calib.cpp.

◆ results() [1/2]

StepResultList& firevision::MirrorCalibTool::Image::results ( )
inline

List of results.

Returns
List of results

Definition at line 885 of file mirror_calib.cpp.

Referenced by firevision::MirrorCalibTool::get_state_description(), and firevision::MirrorCalibTool::next_step().

◆ results() [2/2]

const StepResultList& firevision::MirrorCalibTool::Image::results ( ) const
inline

List of results.

Returns
List of results

Definition at line 889 of file mirror_calib.cpp.

◆ set_marks()

void firevision::MirrorCalibTool::Image::set_marks ( const MarkList &  marks)
inline

The (final) marks.

Parameters
marksThe list of marks.

Definition at line 921 of file mirror_calib.cpp.

Referenced by firevision::MirrorCalibTool::next_step().

◆ set_premarks()

void firevision::MirrorCalibTool::Image::set_premarks ( const MarkList &  premarks)
inline

The premarks.

Parameters
premarksThe list of premarks.

Definition at line 918 of file mirror_calib.cpp.

Referenced by firevision::MirrorCalibTool::next_step().

◆ width()

int firevision::MirrorCalibTool::Image::width ( ) const
inline

YUV buffer's width.

Returns
YUV buffer's width

Definition at line 873 of file mirror_calib.cpp.

Referenced by firevision::MirrorCalibTool::draw_mark_lines(), firevision::MirrorCalibTool::next_step(), and firevision::MirrorCalibTool::save().

◆ yuv_buffer() [1/2]

unsigned char* firevision::MirrorCalibTool::Image::yuv_buffer ( )
inline

YUV buffer.

Returns
YUV buffer

Definition at line 861 of file mirror_calib.cpp.

Referenced by firevision::MirrorCalibTool::next_step().

◆ yuv_buffer() [2/2]

const unsigned char* firevision::MirrorCalibTool::Image::yuv_buffer ( ) const
inline

YUV buffer.

Returns

Definition at line 865 of file mirror_calib.cpp.


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