RobWorkProject  24.12.4-
Public Types | Public Member Functions | Protected Attributes | List of all members
FrameGrabber25D Class Referenceabstract

The FrameGrabber25D abstract interface, can be used to grab images from a specialized source. More...

#include <FrameGrabber25D.hpp>

Inherited by GLFrameGrabber25D.

Public Types

typedef rw::core::Ptr< FrameGrabber25DPtr
 Smart pointer type for FrameGrabber25D.
 

Public Member Functions

 FrameGrabber25D (size_t width, size_t height)
 constructor More...
 
virtual ~FrameGrabber25D ()
 destructor
 
size_t getWidth () const
 returns the width of the image More...
 
size_t getHeight () const
 returns the height of the image More...
 
virtual double getFieldOfViewY ()=0
 Returns the field of view measured around the y-axis. More...
 
void resize (size_t width, size_t height)
 resizes the image that this frameGrabber use. The colorcode will default to the one that FrameGrabber25D was initialized with. More...
 
virtual rw::geometry::PointCloudgetImage ()
 returns the image More...
 
virtual void grab (rw::core::Ptr< rw::kinematics::Frame > frame, const rw::kinematics::State &state)=0
 this function grabs a image from the specialized source and copies it to the FrameGrabber25D image.
 
virtual double getMaxDepth ()=0
 maximum depth that this framegrabber can handle More...
 
virtual double getMinDepth ()=0
 minimum depth that this framegrabber can handle More...
 

Protected Attributes

rw::geometry::PointCloud_img
 The image.
 
size_t _width
 Width of the image.
 
size_t _height
 Height of the image.
 

Detailed Description

The FrameGrabber25D abstract interface, can be used to grab images from a specialized source.

Constructor & Destructor Documentation

◆ FrameGrabber25D()

FrameGrabber25D ( size_t  width,
size_t  height 
)
inline

constructor

Parameters
width[in] width of the image that this FrameGrabber25D uses.
height[in] height of the image that this FrameGrabber25D uses.

Member Function Documentation

◆ getFieldOfViewY()

virtual double getFieldOfViewY ( )
pure virtual

Returns the field of view measured around the y-axis.

Returns
Field of view measured around y-axis in radians

Implemented in GLFrameGrabber25D.

◆ getHeight()

size_t getHeight ( ) const
inline

returns the height of the image

Returns
the height of the image

◆ getImage()

virtual rw::geometry::PointCloud& getImage ( )
inlinevirtual

returns the image

Returns
the image

◆ getMaxDepth()

virtual double getMaxDepth ( )
pure virtual

maximum depth that this framegrabber can handle

Returns
maximum depth in meter

Implemented in GLFrameGrabber25D.

◆ getMinDepth()

virtual double getMinDepth ( )
pure virtual

minimum depth that this framegrabber can handle

Returns
minimum depth in meter

Implemented in GLFrameGrabber25D.

◆ getWidth()

size_t getWidth ( ) const
inline

returns the width of the image

Returns
the height of the image

◆ resize()

void resize ( size_t  width,
size_t  height 
)
inline

resizes the image that this frameGrabber use. The colorcode will default to the one that FrameGrabber25D was initialized with.

Parameters
width[in] width of image
height[in] height of image

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