pypeline.core package

Submodules

pypeline.core.decors module

pypeline.core.decors.log_scale(func)

pypeline.core.decors.partial_return(part='left')

pypeline.core.decors.proc_along_axis(axis=-1)

pypeline.core.funcwrap module

pypeline.core.funcwrap.c_pipenize(func)

pypeline.core.funcwrap.check_data_in(func)

check if the input data matches the input requirements, the requirements are defined in

the configuration file loaded by load_cfg(func)

Parameters:func (function) – function that will process the input data

pypeline.core.funcwrap.connect(func_list)

connects the functions in the list to form an async pipeline

Parameters:func_list (list) – list of functions in the folder ./settings

pypeline.core.funcwrap.load_ext_cfg(func)

pypeline.core.funcwrap.load_ext_func(ext_name, cfg_file=None)

load function inis file from the ./settings/inis folder

Parameters:

• ext_name (function) – name of the function to be loaded from ‘func_name.py’ in folder ./settings
• cfg_file –
• async (bool) –

pypeline.core.funcwrap.load_impl()

pypeline.core.funcwrap.m_pipenize(func)

pypeline.core.funcwrap.pipenize(func)

pypeline.core.pipeline module

class pypeline.core.pipeline.Pipeline(func_list=[])

Bases: object

pipeline to connect settings for streamline data processing. .. rubric:: Example

p = PipeLine([list of functions]) p.process(data_in) p.close() to close the pipeline

close()

close pipeline, stop yielding results, close the async threads

insert(position, func)

Parameters:

• position (int) – the position to inser the function into the pipeline
• func (function/list of function) – function to be inserted in to the pipeline

pop_by_idx(idx)

Parameters:func_idx (int) – index of function to be popped out of the pipeline this is useful when there are functions with same name but idx will be different

pop_by_name(func_name)

Parameters:func_name (str) – name of function to be popped out of the pipeline

process(data_in)

process data or iterable data_source, then yield the result

Parameters:data_in – input data of the pipeline, this can be data or iterable data source

swap_by_idx(idx1, idx2)

Parameters:

• idx1 – the first index of the function to be swapped
• idx2 – the second index of the function to be swapped

swap_by_name(func1_name, func2_name)

Parameters:

• func1_name – the first name of the function to be swapped
• func2_name – the second name of the function to be swapped

Module contents

pypeline.core

this module contains all the processing method, and advanced algorithms for OCT signal processing

calibrate:

disp_comp:

sp2struct:

@phase, @intensity, @complex

despeckle: (2D, 3D, etc.)

angiograph: (2D, 3D, etc.)

@speckle_var, @