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

A hole is a sequence of pixels between two lines. More...

Public Member Functions

 Hole (int index, PolarRadius from_length, PolarRadius to_length)
 Constructor. More...
 
PolarRadius size () const
 The size of the hole in pixels. More...
 

Public Attributes

int index
 The index of the hole. More...
 
PolarRadius from_length
 Beginning of the hole. More...
 
PolarRadius to_length
 Ending of the hole. More...
 

Detailed Description

A hole is a sequence of pixels between two lines.

Definition at line 756 of file mirror_calib.cpp.

Constructor & Destructor Documentation

◆ Hole()

firevision::MirrorCalibTool::Hole::Hole ( int  index,
PolarRadius  from_length,
PolarRadius  to_length 
)
inline

Constructor.

Parameters
indexThe index of the hole.
from_lengthThe beginning of the hole in pixels.
to_lengthThe ending of the hole in pixels.

Definition at line 766 of file mirror_calib.cpp.

Member Function Documentation

◆ size()

PolarRadius firevision::MirrorCalibTool::Hole::size ( ) const
inline

The size of the hole in pixels.

Returns
radius of hole

Definition at line 778 of file mirror_calib.cpp.

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

Member Data Documentation

◆ from_length

PolarRadius firevision::MirrorCalibTool::Hole::from_length

Beginning of the hole.

Definition at line 759 of file mirror_calib.cpp.

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

◆ index

int firevision::MirrorCalibTool::Hole::index

The index of the hole.

Definition at line 758 of file mirror_calib.cpp.

◆ to_length

PolarRadius firevision::MirrorCalibTool::Hole::to_length

Ending of the hole.

Definition at line 760 of file mirror_calib.cpp.

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


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