superquadric-model
Public Member Functions
superquadricModel_IDL Class Reference

superquadricModel_IDL IDL Interface to superquadric-model services. More...

#include <superquadricModel_IDL.h>

Inheritance diagram for superquadricModel_IDL:
SuperqModule

Public Member Functions

virtual bool set_tag_file (const std::string &entry)
 Set the tag for storing files. More...
 
virtual std::string get_tag_file ()
 Return the tag used for storing files. More...
 
virtual yarp::os::Property get_superq (const std::vector< yarp::sig::Vector > &point_cloud, const bool filtered_or_not, const bool reset_or_not)
 Get the parameters of the reconstructed superquadric. More...
 
virtual bool set_points_filtering (const std::string &entry)
 On/off point cloud filtering. More...
 
virtual std::string get_points_filtering ()
 Say if points filtering is on or not. More...
 
virtual bool set_superq_filtering (const std::string &entry)
 On/off superquadric filtering. More...
 
virtual std::string get_superq_filtering ()
 Say if superquadric filtering is on or not. More...
 
virtual bool set_save_points (const std::string &entry)
 Set if you want to save the acquired point cloud. More...
 
virtual std::string get_save_points ()
 Set if you are saving the acquired point cloud. More...
 
virtual yarp::os::Property get_options (const std::string &field)
 Get the parameters of the module. More...
 
virtual bool set_options (const yarp::os::Property &options, const std::string &field)
 Set the parameters of the module. More...
 
virtual bool set_visualization (const std::string &e)
 Set if the visualization has to be enabled. More...
 
virtual std::string get_visualization ()
 Get if visualization is enabled. More...
 
virtual bool read (yarp::os::ConnectionReader &connection)
 
virtual std::vector< std::string > help (const std::string &functionName="--all")
 

Detailed Description

superquadricModel_IDL IDL Interface to superquadric-model services.

Definition at line 19 of file superquadricModel_IDL.h.

Member Function Documentation

◆ get_options()

virtual yarp::os::Property superquadricModel_IDL::get_options ( const std::string &  field)
virtual

Get the parameters of the module.

The user must pay attention in changing them.

Parameters
fieldcan be "points_filter", "superq_filter", "optimization", "visualization" or "statistics". depending on which parameters we are interested in.
Returns
the Property including all the parameter values.

Reimplemented in SuperqModule.

◆ get_points_filtering()

virtual std::string superquadricModel_IDL::get_points_filtering ( )
virtual

Say if points filtering is on or not.

Returns
on/off string if points filtering is on/off.

Reimplemented in SuperqModule.

◆ get_save_points()

virtual std::string superquadricModel_IDL::get_save_points ( )
virtual

Set if you are saving the acquired point cloud.

Returns
"on" or "off".

Reimplemented in SuperqModule.

◆ get_superq()

virtual yarp::os::Property superquadricModel_IDL::get_superq ( const std::vector< yarp::sig::Vector > &  point_cloud,
const bool  filtered_or_not,
const bool  reset_or_not 
)
virtual

Get the parameters of the reconstructed superquadric.

Parameters
point_cloudis the 3D point cloud of the object we want to model with the superquadric, for instance: ((100.0 102.0) (100.0 103.0) ... ).
filtered_or_notis a bool variable specifing if we want the superquadric to be filtered (true/1) or not (false/0).
reset_or_notis a bool variable specifing if we want to reset the superquadric filtered (if enabled) or not.
Returns
the 12 parameters (x0, .. x11) of the current superquadric. In particular, the parameters are grouped in a Property as follows: "dimensions" (x0, x1, x2) are the three semi-axes lenghts; "exponents" (x3 and x4) are the exponents, responsible for the superquadric shape; "center"(x5, x6, x7) contains the coordinate of the superquadric center; and "orientation" (x8, x9, 10, x11) is the axis-angle representation obtained from the Euler angles.

◆ get_superq_filtering()

virtual std::string superquadricModel_IDL::get_superq_filtering ( )
virtual

Say if superquadric filtering is on or not.

Returns
on/off string if superquadeic filtering is on/off.

Reimplemented in SuperqModule.

◆ get_tag_file()

virtual std::string superquadricModel_IDL::get_tag_file ( )
virtual

Return the tag used for storing files.

Returns
the tag name.

Reimplemented in SuperqModule.

◆ get_visualization()

virtual std::string superquadricModel_IDL::get_visualization ( )
virtual

Get if visualization is enabled.

Returns
"on" or "off".

Reimplemented in SuperqModule.

◆ set_options()

virtual bool superquadricModel_IDL::set_options ( const yarp::os::Property &  options,
const std::string &  field 
)
virtual

Set the parameters of the module.

The user must pay attention in changing them.

Parameters
optionsis a Property containing the parameters the user want to change.
fieldis a string specifying which can of parameter we are going to change. Field can be: "points_filter", "superq_filter", "optimization" or "visualization". You can set the parameters typing: command: set_options ((filter_radius <radius-value>) (filter_nnThreshold <nnThreshold-value>)) points_filter.
Returns
true/false on success/failure.

Reimplemented in SuperqModule.

◆ set_points_filtering()

virtual bool superquadricModel_IDL::set_points_filtering ( const std::string &  entry)
virtual

On/off point cloud filtering.

Parameters
entryis "on/off" if you want/do not want to filter points.
Returns
true/false on success/failure.

Reimplemented in SuperqModule.

◆ set_save_points()

virtual bool superquadricModel_IDL::set_save_points ( const std::string &  entry)
virtual

Set if you want to save the acquired point cloud.

Parameters
entrycan be: "on" or "off".
Returns
true/false on success/failure.

Reimplemented in SuperqModule.

◆ set_superq_filtering()

virtual bool superquadricModel_IDL::set_superq_filtering ( const std::string &  entry)
virtual

On/off superquadric filtering.

Parameters
entryis "on/off" if you want/do not want to filter the estimated superquadric.
Returns
true/false on success/failure.

Reimplemented in SuperqModule.

◆ set_tag_file()

virtual bool superquadricModel_IDL::set_tag_file ( const std::string &  entry)
virtual

Set the tag for storing files.

Parameters
entryis the tag that will be used in file names.
Returns
true.

Reimplemented in SuperqModule.

◆ set_visualization()

virtual bool superquadricModel_IDL::set_visualization ( const std::string &  e)
virtual

Set if the visualization has to be enabled.

Returns
true/false on success/failure.

Reimplemented in SuperqModule.


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