fluidimage.topologies.surface_tracking#

Topology for surface tracking(`fluidimage.topologies.surface_tracking`)#

class fluidimage.topologies.surface_tracking.TopologySurfaceTracking(params, logging_level='info', nb_max_workers=None)[source]#

Topology for SurfaceTracking.

Parameters:

paramsNone: A ParamContainer containing the parameters for the computation.
logging_levelstr, {‘warning’, ‘info’, ‘debug’, …}: Logging level.
nb_max_workersNone, int: Maximum numbers of “workers”. If None, a number is computed from the number of cores detected. If there are memory errors, you can try to decrease the number of workers.

classmethod create_default_params()[source]#: Class method returning the default parameters.

Todo

Make this code usable:

Surface Tracking parameters:

xmin: int (default 475)

xmin to crop the image im[xmin:xmax, ymin:ymax].
xmax: int (default 640)

xmax to crop the image im[xmin:xmax, ymin:ymax]
ymin: int (default 50)

ymin to crop the image im[xmin:xmax, ymin:ymax]
ymax: int (default 700)

ymax to crop the image im[xmin:xmax, ymin:ymax]
distance_lens: float (default 0.36)

distance in [m] lenses of camera/projetor
distance_object: float (default 1.07)

distance in [m] camera/projector and surface
pix_size: float (default 2.4 * 10 ** -4)

pixel size
startref_frame: int (default 0)

indice of first reference image
lastref_frame: int (default 49)

indice of last reference image
sur: int (default 16)
k_x: float (default 70.75)

wave vector oj. grid (approx. value, will set accurate later)
k_y: float (default 0)

wave vector of the grid y-axis
slicer: int (default 4)

cut the borders
red_factor: int (default 1)

reduction factor to for the pixels to take tp speed up
n_frames_stock: int (default 1)

number of frames to stock in one file
crop_edge: boolean (default False)

searches for the structure and crops the part of the frame outside of the structure
borders: int (default 7)

pixel to set zero height additional to the borders if the structure was cropped to avoid jerks
correct_pos: boolean (default=False)

correct position of the height (necessary for large heights)
correct_height: boolean (default=False)

correct height by a reference (provided from path_ref)
offset: float (default 0.0)

height of the reference surface in [m] to zero level

Parameters indicating the input image set.

path : str, {‘’}

String indicating the input images (can be a full path towards an image file or a string given to glob).
path_ref : str, {‘’}

String indicating the reference input images (can be a full path towards an image file or a string given to glob).
str_subset_ref : None

String indicating as a Python slicing how to select reference images from the serie of reference images on the disk (in order to compute k_x value necessary for gain and filter). If None, no selection so all images are going to be processed.
str_subset : None

String indicating as a Python slicing how to select images from the serie of images on the disk. If None, no selection so all images are going to be processed.

Saving of the results.

path : None or str

Path of the directory where the data will be saved. If None, the path is obtained from the input path and the parameter postfix.
how : str {‘ask’}

‘ask’, ‘new_dir’, ‘complete’ or ‘recompute’.
postfix : str

Postfix from which the output file is computed.

im2im : str {None}

Function or class to be used to process the images.
args_init : object {None}

An argument given to the init function of the class used to process the images.

Classes

`Topology`	alias of `TopologySurfaceTracking`
`TopologySurfaceTracking`(params[, ...])	Topology for SurfaceTracking.