robokudo.descriptors.analysis_engines.simple_with_parameters

Analysis engine demonstrating parameter configuration.

This module provides an analysis engine that demonstrates how to configure and use parameters in a pipeline. It implements a simple pipeline that uses customized parameters for image preprocessing.

The pipeline implements the following functionality:

  • Kinect camera data input

  • Image preprocessing with custom depth truncation

  • Simulated slow processing

Note

This example shows how to configure annotator parameters through descriptors, which is essential for customizing pipeline behavior without modifying annotator code.

Classes

AnalysisEngine

Analysis engine demonstrating parameter configuration.

Module Contents

class robokudo.descriptors.analysis_engines.simple_with_parameters.AnalysisEngine

Bases: robokudo.analysis_engine.AnalysisEngineInterface

Analysis engine demonstrating parameter configuration.

This class implements a pipeline that shows how to configure annotator parameters using descriptors. It uses a custom depth truncation value for image preprocessing to demonstrate parameter customization.

The pipeline includes:

  • Collection reader for Kinect camera data

  • Image preprocessor with custom depth truncation

  • Slow annotator for processing simulation

Note

The image preprocessor is configured with a depth truncation value of 4.5 meters, which can be adjusted to suit different environments and requirements.

name()

Get the name of the analysis engine.

Returns:

The name identifier of this analysis engine

Return type:

str

implementation()

Create a pipeline with custom parameter configuration.

This method constructs a processing pipeline that demonstrates how to configure annotator parameters. It specifically shows how to set a custom depth truncation value for the image preprocessor.

Pipeline configuration:

  • Kinect camera interface setup

  • Image preprocessor with depth_trunc = 4.5m

  • Slow annotator for processing simulation

Returns:

The configured pipeline with custom parameters

Return type:

robokudo.pipeline.Pipeline