cyberglove_calibrer::CybergloveCalibrer Class Reference

List of all members.

Public Member Functions

def __init__
def all_steps_done
def do_step_max
def do_step_min
def get_calibration_steps
def is_step_done
def load_calib
def reorder_calibration
def write_calibration_file

Public Attributes

 calibration_steps
 cyberglove
 description_function
 joints

Detailed Description

A utility to calibrate the cyberglove.

Definition at line 94 of file cyberglove_calibrer.py.


Member Function Documentation

def cyberglove_calibrer::CybergloveCalibrer::__init__ (   self,
  description_function = default_description 
)
Initialize some class variables: a table containing the calibration steps, a connection to the cyberglove
library and a description function for the calibration steps

@param description_function: specify a function you want to use to describe the calibration steps ( text / 
pictures / animation / ... ). Must take a joint name as parameter.

Definition at line 98 of file cyberglove_calibrer.py.

def cyberglove_calibrer::CybergloveCalibrer::all_steps_done (   self  ) 
Check if all the steps were processed.

@return: True if all the steps were processed. 

Definition at line 215 of file cyberglove_calibrer.py.

def cyberglove_calibrer::CybergloveCalibrer::do_step_max (   self,
  index 
)
Run  the given step of the calibration, gets the max values.
As this method is called after the do_step_min() method, we don't display the description

@param index: the index of the step in the calibration file
@return: 0 when the values were read. 

Definition at line 184 of file cyberglove_calibrer.py.

def cyberglove_calibrer::CybergloveCalibrer::do_step_min (   self,
  index 
)
Run  the given step of the calibration, gets the min values.

@param index: the index of the step in the calibration file
@return: 0 when the values were read. 

Definition at line 164 of file cyberglove_calibrer.py.

def cyberglove_calibrer::CybergloveCalibrer::get_calibration_steps (   self  ) 
Read the calibration steps from the xml file.

@return: 0 when the values were read.

Definition at line 121 of file cyberglove_calibrer.py.

def cyberglove_calibrer::CybergloveCalibrer::is_step_done (   self,
  joint_name 
)
Check if the joint is calibrated.

@param joint_name: the name of the joint
@return: 1 if the joint has already been calibrated. 

Definition at line 205 of file cyberglove_calibrer.py.

def cyberglove_calibrer::CybergloveCalibrer::load_calib (   self,
  filename 
)

Definition at line 298 of file cyberglove_calibrer.py.

def cyberglove_calibrer::CybergloveCalibrer::reorder_calibration (   self  ) 
Reorder the calibration: set the raw_min to the min raw_value

Definition at line 227 of file cyberglove_calibrer.py.

def cyberglove_calibrer::CybergloveCalibrer::write_calibration_file (   self,
  filepath 
)
Checks if all the steps were processed by calling self.all_steps_done()
Reorder the calibration
Then writes the whole calibration to a given file.

@param filepath: Where to write the calibration
@return: 0 if the file has been written, 
-1 if the calibration is not finished yet,
-2 if other error     

Definition at line 240 of file cyberglove_calibrer.py.


Member Data Documentation

Definition at line 106 of file cyberglove_calibrer.py.

Definition at line 108 of file cyberglove_calibrer.py.

Definition at line 119 of file cyberglove_calibrer.py.

Definition at line 111 of file cyberglove_calibrer.py.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines


cyberglove
Author(s): Ugo Cupcic
autogenerated on Fri Jan 11 09:12:45 2013