fluidimage.data_objects.piv

PIV objects (fluidimage.data_objects.piv)

class fluidimage.data_objects.piv.ArrayCouple(names=None, arrays=None, paths=None, serie=None, str_path=None, hdf5_parent=None, params_mask=None)

Bases: DataObject

Couple of arrays (images).

class fluidimage.data_objects.piv.HeavyPIVResults(deltaxs=None, deltays=None, xs=None, ys=None, errors=None, correls_max=None, correls=None, couple=None, params=None, str_path=None, hdf5_object=None, secondary_peaks=None, indices_no_displacement=None)

Bases: DataObject

Heavy PIV results containing displacements and correlation.

Attributes:

xs, ys: 1d array of size `num_vectors`

Positions of the vectors in pixels. Depend on the images.

deltaxs, deltays: 1d array of size `num_vectors`

Raw PIV results.

correls: list of `num_vectors` 2d arrays

Correlation matrices for each vector.

correls_max: 1d array of size `num_vectors`

Maximum correlation for each vector.

deltaxs_approx, deltays_approx: 1d array of size `num_vectors_next_pass`

Displacements interpolated on a grid that do not depend on the images.

ixvecs_approx, iyvecs_approx: 1d array of size `num_vectors_next_pass`

Positions in pixels of the vectors in deltaxs_approx, deltays_approx.

deltaxs_final, deltays_final, ixvecs_final, iyvecs_final:

Equivalent to the _approx variables but for the last pass and of size num_vectors.

deltaxs_smooth, deltays_smooth:

Smoothed displacements at the positions xs, ys (present only for TPS interpolation).

get_grid_pixel(index_pass)

Recompute 1d arrays containing the approximate positions of the vectors

Useful to compute a grid on which we can interpolate the displacement fields.

Parameters:

index_pass: int

Index of the pass

Returns:

xs1d: np.ndarray

Indices (2nd, direction “x”) of the pixel in the image

ys1d: np.ndarray

Indices (1st, direction “y”) of the pixel in the image

class fluidimage.data_objects.piv.MultipassPIVResults(str_path=None)

Bases: DataObject

Result of a multipass PIV computation.

get_grid_pixel(index_pass=-1)

Recompute 1d arrays containing the approximate positions of the vectors

Useful to compute a grid on which we can interpolate the displacement fields.

Parameters:

index_pass: int

Index of the pass

Returns:

xs1d: np.ndarray

Indices (2nd, direction “x”) of the pixel in the image

ys1d: np.ndarray

Indices (1st, direction “y”) of the pixel in the image

class fluidimage.data_objects.piv.LightPIVResults(deltaxs_approx=None, deltays_approx=None, ixvecs_grid=None, iyvecs_grid=None, correls_max=None, couple=None, params=None, str_path=None, hdf5_object=None, file_name=None)

Bases: DataObject

Functions

get_name_bos(name, serie)
get_name_piv(serie[, prefix])
get_slices_from_strcrop(strcrop)

Classes

ArrayCouple([names, arrays, paths, serie, ...])	Couple of arrays (images).
ArrayCoupleBOS([names, arrays, paths, ...])	Couple of arrays (images).
DataObject()
HeavyPIVResults([deltaxs, deltays, xs, ys, ...])	Heavy PIV results containing displacements and correlation.
LightPIVResults([deltaxs_approx, ...])
MultipassPIVResults([str_path])	Result of a multipass PIV computation.