Public Member Functions | Protected Attributes

cloud< observation_type > Class Template Reference

#include <cloud.h>

Inheritance diagram for cloud< observation_type >:
observation< observation_type >

List of all members.

Public Member Functions

 cloud (const options &opts, const calibration &_calib)
 ~cloud ()
virtual bool refresh (bool goto_next=true)=0
virtual size_t size () const =0
virtual void show () const =0

Protected Attributes

int frame
const double scale
bool use_depth_threshold
double depth_threshold
const calibrationcalib

Detailed Description

template<class observation_type>
class cloud< observation_type >

An abstract class for representing data from a stereo camera. The template parameter controls the type of observation the camera generates. Examples of such observations include 3D points and triangles in 3D.

The data should internally be represented in the world coordinate system rather than the camera coordinate system.


Constructor & Destructor Documentation

template<class observation_type>
cloud< observation_type >::cloud ( const options opts,
const calibration _calib 
) [inline]

Constructor for the cloud class. The constructor initialises some variables, but does not actually read any data.

Parameters:
[in] opts An object of class options that contains configuration information. The cloud constructor reads the following options:

  • data_template
  • data_start_idx
  • external_view
  • data_scaling (optional)
  • depth_threshold (optional)
[in] _calib A reference to the calibration object defining the coordinate systems of the world.
template<class observation_type>
cloud< observation_type >::~cloud (  )  [inline]

Member Function Documentation

template<class observation_type>
virtual bool cloud< observation_type >::refresh ( bool  goto_next = true  )  [pure virtual]

Reads data from the next frame. This function should be implemented by a class inheriting from the cloud class.

Parameters:
[in] goto_next This optional parameter determines if the next frame should be read (default) or the current frame should be re-read. The latter is useful if you have changed parameters of the point_cloud object, such as the translation or rotation of the data.
Returns:
If the frame was succesfully read the function returns true, otherwise it returns false.

Implements observation< observation_type >.

Implemented in kinect_cloud, mocap_data< observation_type >, point_cloud, triclops_cloud, cloud_and_stick< point_cloud >, and mocap_data< cloud_type >.

template<class observation_type>
virtual void cloud< observation_type >::show (  )  const [pure virtual]

Draw the data currently held in the object. This function must be implemented by a class inheriting from cloud.

Implements observation< observation_type >.

Implemented in cloud3, kinect_cloud, mocap_data< observation_type >, cloud_and_stick< point_cloud >, and mocap_data< cloud_type >.

template<class observation_type>
virtual size_t cloud< observation_type >::size (  )  const [pure virtual]
Returns:
Returns the number of observation elements in the currently held frame.

Implemented in cloud3, mocap_data< observation_type >, and mocap_data< cloud_type >.


Member Data Documentation

template<class observation_type>
const calibration& cloud< observation_type >::calib [protected]
template<class observation_type>
double cloud< observation_type >::depth_threshold [protected]
template<class observation_type>
int cloud< observation_type >::frame [protected]
template<class observation_type>
const double cloud< observation_type >::scale [protected]
template<class observation_type>
bool cloud< observation_type >::use_depth_threshold [protected]

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