src.pipeline.pipeline_executor

Classes

PipelineExecutor(maker, **kwargs)

Exceptions

PipelineExecutorException([message])

exception src.pipeline.pipeline_executor.PipelineExecutorException(message='')
Author:

Alberto M. Esmoris Pena

Class for exceptions related to the execution of pipelines. See VL3DException.

__init__(message='')
class src.pipeline.pipeline_executor.PipelineExecutor(maker, **kwargs)
Author:

Alberto M. Esmoris Pena

Class to handle the execution of components in the context of a pipeline.

Variables:

  • maker (Pipeline) – The pipeline that instantiated the executor.

  • out_prefix (str) – Optional attribute (can be None) that specifies the output prefix for any component that needs to append it to its output paths.

  • pre_fnames (list) – Cached feature names before preprocessing. Can be used to merge consecutive miners.

__init__(maker, **kwargs)

Handle the root-level (most basic) initialization of any pipeline executor.

Parameters:

  • maker (Pipeline) – The pipeline that instantiated the executor.

  • kwargs – The attributes for the PipelineExecutor

__call__(state, comp, comp_id, comps)

Execute the component of the pipeline associated to the given identifier.

By default, comp_id is expected to be an integer and comps a list such that comps[comp_id] = comp.

See src.pipeline.pipeline_executor.PipelineExecutor.pre_process(), src.pipeline.pipeline_executor.PipelineExecutor.process(), and src.pipeline.pipeline_executor.PipelineExecutor.post_process().

Parameters:

  • state – The pipeline’s state. See npu.pipeline.state.pipeline_state.PipelineState.

  • comp – The component to be executed.

  • comp_id – The identifier of the component. Typically, it should be possible to use it to retrieve the component from comps.

  • comps – The components composing the pipeline.

Returns:

Nothing.

load_input(state, **kwargs)

Load the input point cloud in the pipeline’s state.

Parameters:

  • state (PipelineState) – The pipeline’s state.

  • kwargs – The key-word arguments. They can be used to specify the path to the input point cloud through the “in_pcloud” key.

Returns:

Nothing but the state is updated.

pre_process(state, comp, comp_id, comps)

Handles the operations before the execution of the main logic, i.e., before running the logic of the current component.

See src.pipeline.pipeline_executor.PipelineExecutor.__call__().

process(state, comp, comp_id, comps)

Handles the execution of the main logic, i.e., running the current component and updating the pipeline state consequently.

See src.pipeline.pipeline_executor.PipelineExecutor.__call__().

post_process(state, comp, comp_id, comps)

Handles the operations after the execution of the main logic, i.e., after running the logic of the current component.

See pipeline_executor.PipelineExecutor.__call__().