VisualSISParticleFilterIDL IDL Interface to VisualSIRParticleFilter options.
More...
#include <VisualSISParticleFilterIDL.h>
|
| | VisualSISParticleFilterIDL () |
| |
| virtual bool | run_filter () |
| | Initialize and run the visual SIR particle filter. More...
|
| |
| virtual bool | reset_filter () |
| | Reset the visual SIR particle filter. More...
|
| |
| virtual bool | stop_filter () |
| | Stop and reset the SIR particle filter. More...
|
| |
| virtual bool | skip_step (const std::string &what_step, const bool status) |
| | Enable/Disable skipping the filtering step specified in what_step. More...
|
| |
| virtual bool | use_analogs (const bool status) |
| | Use/Don't use the analog values from the right hand to correct the finger poses. More...
|
| |
| virtual std::vector< std::string > | get_info () |
| | Get information about recursive Bayesian filter, like it's status, the available methods, and the current one in use, to extract the state estimate from the particle set. More...
|
| |
| virtual bool | set_estimates_extraction_method (const std::string &method) |
| | Change the current method to extract the state estimates from the particle set. More...
|
| |
| virtual bool | set_mobile_average_window (const int16_t window=20) |
| | Change the window size of mobile averages for estimates extraction. More...
|
| |
| virtual bool | quit () |
| | Gently close the application, deallocating resources. More...
|
| |
| virtual bool | read (yarp::os::ConnectionReader &connection) override |
| |
| virtual std::vector< std::string > | help (const std::string &functionName="--all") |
| |
VisualSISParticleFilterIDL IDL Interface to VisualSIRParticleFilter options.
Definition at line 17 of file VisualSISParticleFilterIDL.h.
◆ VisualSISParticleFilterIDL()
| VisualSISParticleFilterIDL::VisualSISParticleFilterIDL |
( |
| ) |
|
◆ get_info()
| virtual std::vector<std::string> VisualSISParticleFilterIDL::get_info |
( |
| ) |
|
|
virtual |
Get information about recursive Bayesian filter, like it's status, the available methods, and the current one in use, to extract the state estimate from the particle set.
- Returns
- a string with all the available information, 'none' otherwise
Reimplemented in VisualSIS.
◆ help()
| virtual std::vector<std::string> VisualSISParticleFilterIDL::help |
( |
const std::string & |
functionName = "--all" | ) |
|
|
virtual |
◆ quit()
| virtual bool VisualSISParticleFilterIDL::quit |
( |
| ) |
|
|
virtual |
Gently close the application, deallocating resources.
Reimplemented in VisualSIS.
◆ read()
| virtual bool VisualSISParticleFilterIDL::read |
( |
yarp::os::ConnectionReader & |
connection | ) |
|
|
overridevirtual |
◆ reset_filter()
| virtual bool VisualSISParticleFilterIDL::reset_filter |
( |
| ) |
|
|
virtual |
Reset the visual SIR particle filter.
Returns upon successful or failure reset.
- Returns
- true/false on success/failure.
Reimplemented in VisualSIS.
◆ run_filter()
| virtual bool VisualSISParticleFilterIDL::run_filter |
( |
| ) |
|
|
virtual |
Initialize and run the visual SIR particle filter.
Returns upon successful or failure setup.
- Returns
- true/false on success/failure.
Reimplemented in VisualSIS.
◆ set_estimates_extraction_method()
| virtual bool VisualSISParticleFilterIDL::set_estimates_extraction_method |
( |
const std::string & |
method | ) |
|
|
virtual |
Change the current method to extract the state estimates from the particle set.
- Parameters
-
| status | a string with the state estimate extraction method to use; the string shall be one of the available methods returned by the get_info() method. |
- Returns
- true method changed successfully, false otherwise.
Reimplemented in VisualSIS.
◆ set_mobile_average_window()
| virtual bool VisualSISParticleFilterIDL::set_mobile_average_window |
( |
const int16_t |
window = 20 | ) |
|
|
virtual |
Change the window size of mobile averages for estimates extraction.
- Parameters
-
| window | specifies the mobile window size. |
- Returns
- true window size changed successfully, false otherwise.
- Note
- The default value is 20. Minimum value is 2. Maximum value is 90.
Reimplemented in VisualSIS.
◆ skip_step()
| virtual bool VisualSISParticleFilterIDL::skip_step |
( |
const std::string & |
what_step, |
|
|
const bool |
status |
|
) |
| |
|
virtual |
Enable/Disable skipping the filtering step specified in what_step.
what_step can be one of the following: 1) prediction: skips the whole prediction step 2) state: skips the prediction step related to the state transition 3) exogenous: skips the prediction step related exogenous inputs 4) correction: skips the whole correction step
- Parameters
-
| what_step | the step to skipping |
| status | enable/disable skipping |
- Returns
- true/false on success/failure.
Reimplemented in VisualSIS.
◆ stop_filter()
| virtual bool VisualSISParticleFilterIDL::stop_filter |
( |
| ) |
|
|
virtual |
Stop and reset the SIR particle filter.
This method must be called when the SIR particle filter is no longer needed or a new filtering task need to be initialized.
- Returns
- true/false on success/failure.
Reimplemented in VisualSIS.
◆ use_analogs()
| virtual bool VisualSISParticleFilterIDL::use_analogs |
( |
const bool |
status | ) |
|
|
virtual |
Use/Don't use the analog values from the right hand to correct the finger poses.
- Parameters
-
| status | true/false to use/don't use analog values. |
- Returns
- true activation/deactivation success, false otherwise.
Reimplemented in VisualSIS.
The documentation for this class was generated from the following file:
