fluidimage.works#

Works - processing#

This subpackage defines some works. A work does a processing. It has initialization parameters and after initialization is able to produce an output object from an input object. It can also take more than one input objects and/or return more than one output objects.

A work is made of one or more work units. In particular, it could be useful to define input/output and computational works.

`image2image`	Image to image processing
`piv`	Particle Image Velocimetry (PIV)
`preproc`	Works Preprocess
`bos`	Background-oriented schlieren
`surface_tracking`	Surface tracking
`optical_flow`	Works optical flow
`with_mask`	Masking images

Provides:

class fluidimage.works.BaseWork(params=None)[source]#

Bases: ABC

abstract classmethod _complete_params_with_default(params)[source]#: Complete an object with the default params

classmethod create_default_params()[source]#: Create an object containing the default parameters (class method).

class fluidimage.works.BaseWorkFromSerie(params=None)[source]#

Bases: BaseWorkWithCalculMethod

Base class for work taking as argument a SerieOfArraysFromFiles

classmethod _complete_params_with_default(params)[source]#: Complete an object with the default params

get_serie(index_serie: int | None = None)[source]#: Get a serie as defined by params.series

process_1_serie(index_serie: int | None = None)[source]#: Process one serie and return the result

calcul_from_arrays(*arrays, names=None)[source]#: Calcul from images

class fluidimage.works.BaseWorkFromImage(params=None)[source]#

Bases: BaseWorkWithCalculMethod

Base class for work taking as argument an image

classmethod _complete_params_with_default(params)[source]#: Complete an object with the default params

get_tuple_image_name(index_image: int = 0)[source]#: Get an image and its name

process_1_image(index_serie: int = 0)[source]#: Process one serie and return the result

Functions

load_image(path)

Classes

`BaseWork`([params])
`BaseWorkFromImage`([params])	Base class for work taking as argument an image
`BaseWorkFromSerie`([params])	Base class for work taking as argument a SerieOfArraysFromFiles
`BaseWorkWithCalculMethod`([params])