image_preprocessing
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
image_preprocessing::HSVSegmentationAndBlur Class Reference

The task context provides and requires services. It uses an ExecutionEngine to perform its functions. Essential interfaces are operations, data flow ports and properties. These interfaces have been defined using the oroGen specification. In order to modify the interfaces you should (re)use oroGen and rely on the associated workflow. More...

#include <HSVSegmentationAndBlur.hpp>

Inheritance diagram for image_preprocessing::HSVSegmentationAndBlur:

Public Member Functions

 HSVSegmentationAndBlur (std::string const &name="image_preprocessing::HSVSegmentationAndBlur", TaskCore::TaskState initial_state=Stopped)
 
 HSVSegmentationAndBlur (std::string const &name, RTT::ExecutionEngine *engine, TaskCore::TaskState initial_state=Stopped)
 
 ~HSVSegmentationAndBlur ()
 
bool configureHook ()
 The following lines are template definitions for the various state machine. More...
 
bool startHook ()
 
void updateHook ()
 
void errorHook ()
 
void stopHook ()
 
void cleanupHook ()
 

Protected Member Functions

void init ()
 

Protected Attributes

RTT::extras::ReadOnlyPointer< base::samples::frame::Frame > in_frame
 
RTT::extras::ReadOnlyPointer< base::samples::frame::Frame > out_frame
 
RTT::extras::ReadOnlyPointer< base::samples::frame::Frame > h_frame
 
RTT::extras::ReadOnlyPointer< base::samples::frame::Frame > v_frame
 
RTT::extras::ReadOnlyPointer< base::samples::frame::Frame > s_frame
 
RTT::extras::ReadOnlyPointer< base::samples::frame::Frame > h_frame_debug
 
RTT::extras::ReadOnlyPointer< base::samples::frame::Frame > v_frame_debug
 
RTT::extras::ReadOnlyPointer< base::samples::frame::Frame > s_frame_debug
 
RTT::extras::ReadOnlyPointer< base::samples::frame::Frame > hsv_frame
 
RTT::extras::ReadOnlyPointer< base::samples::frame::Frame > hsv_v_frame
 
RTT::extras::ReadOnlyPointer< base::samples::frame::Frame > binary
 

Friends

class HSVSegmentationAndBlurBase
 

Detailed Description

The task context provides and requires services. It uses an ExecutionEngine to perform its functions. Essential interfaces are operations, data flow ports and properties. These interfaces have been defined using the oroGen specification. In order to modify the interfaces you should (re)use oroGen and rely on the associated workflow.

The name of a TaskContext is primarily defined via:

deployment 'deployment_name'
    task('custom_task_name','image_preprocessing::HSVSegmentationAndBlur')
end

It can be dynamically adapted when the deployment is called with a prefix argument.

Constructor & Destructor Documentation

HSVSegmentationAndBlur::HSVSegmentationAndBlur ( std::string const &  name = "image_preprocessing::HSVSegmentationAndBlur",
TaskCore::TaskState  initial_state = Stopped 
)

TaskContext constructor for HSVSegmentationAndBlur

Parameters
nameName of the task. This name needs to be unique to make it identifiable via nameservices.
initial_stateThe initial TaskState of the TaskContext. Default is Stopped state.
HSVSegmentationAndBlur::HSVSegmentationAndBlur ( std::string const &  name,
RTT::ExecutionEngine *  engine,
TaskCore::TaskState  initial_state = Stopped 
)

TaskContext constructor for HSVSegmentationAndBlur

Parameters
nameName of the task. This name needs to be unique to make it identifiable for nameservices.
engineThe RTT Execution engine to be used for this task, which serialises the execution of all commands, programs, state machines and incoming events for a task.
initial_stateThe initial TaskState of the TaskContext. Default is Stopped state.
HSVSegmentationAndBlur::~HSVSegmentationAndBlur ( )

Default deconstructor of HSVSegmentationAndBlur

Member Function Documentation

void HSVSegmentationAndBlur::cleanupHook ( )

This hook is called by Orocos when the state machine transitions from Stopped to PreOperational, requiring the call to configureHook() before calling start() again.

bool HSVSegmentationAndBlur::configureHook ( )

The following lines are template definitions for the various state machine.

This hook is called by Orocos when the state machine transitions from PreOperational to Stopped. If it returns false, then the component will stay in PreOperational. Otherwise, it goes into Stopped.

It is meaningful only if the #needs_configuration has been specified in the task context definition with (for example):

task_context "TaskName" do
  needs_configuration
  ...
end
void HSVSegmentationAndBlur::errorHook ( )

This hook is called by Orocos when the component is in the RunTimeError state, at each activity step. See the discussion in updateHook() about triggering options.

Call recover() to go back in the Runtime state.

void HSVSegmentationAndBlur::init ( )
protected
bool HSVSegmentationAndBlur::startHook ( )

This hook is called by Orocos when the state machine transitions from Stopped to Running. If it returns false, then the component will stay in Stopped. Otherwise, it goes into Running and updateHook() will be called.

void HSVSegmentationAndBlur::stopHook ( )

This hook is called by Orocos when the state machine transitions from Running to Stopped after stop() has been called.

void HSVSegmentationAndBlur::updateHook ( )

This hook is called by Orocos when the component is in the Running state, at each activity step. Here, the activity gives the "ticks" when the hook should be called.

The error(), exception() and fatal() calls, when called in this hook, allow to get into the associated RunTimeError, Exception and FatalError states.

In the first case, updateHook() is still called, and recover() allows you to go back into the Running state. In the second case, the errorHook() will be called instead of updateHook(). In Exception, the component is stopped and recover() needs to be called before starting it again. Finally, FatalError cannot be recovered.

Friends And Related Function Documentation

friend class HSVSegmentationAndBlurBase
friend

Member Data Documentation

RTT::extras::ReadOnlyPointer<base::samples::frame::Frame> image_preprocessing::HSVSegmentationAndBlur::binary
protected
RTT::extras::ReadOnlyPointer<base::samples::frame::Frame> image_preprocessing::HSVSegmentationAndBlur::h_frame
protected
RTT::extras::ReadOnlyPointer<base::samples::frame::Frame> image_preprocessing::HSVSegmentationAndBlur::h_frame_debug
protected
RTT::extras::ReadOnlyPointer<base::samples::frame::Frame> image_preprocessing::HSVSegmentationAndBlur::hsv_frame
protected
RTT::extras::ReadOnlyPointer<base::samples::frame::Frame> image_preprocessing::HSVSegmentationAndBlur::hsv_v_frame
protected
RTT::extras::ReadOnlyPointer<base::samples::frame::Frame> image_preprocessing::HSVSegmentationAndBlur::in_frame
protected
RTT::extras::ReadOnlyPointer<base::samples::frame::Frame> image_preprocessing::HSVSegmentationAndBlur::out_frame
protected
RTT::extras::ReadOnlyPointer<base::samples::frame::Frame> image_preprocessing::HSVSegmentationAndBlur::s_frame
protected
RTT::extras::ReadOnlyPointer<base::samples::frame::Frame> image_preprocessing::HSVSegmentationAndBlur::s_frame_debug
protected
RTT::extras::ReadOnlyPointer<base::samples::frame::Frame> image_preprocessing::HSVSegmentationAndBlur::v_frame
protected
RTT::extras::ReadOnlyPointer<base::samples::frame::Frame> image_preprocessing::HSVSegmentationAndBlur::v_frame_debug
protected

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