openpiv_cxx.process.get_field_shape

openpiv_cxx.process.get_field_shape(image_size, window_size, overlap)

Get vector field shape.

Compute the shape of the resulting flow field. Given the image size, the interrogation window size and the overlap size, it is possible to calculate the number of rows and columns of the resulting flow field.

Parameters:

• image_size (tuple) – A two dimensional tuple for the pixel size of the image first element is number of rows, second element is the number of columns, easy to obtain using .shape.

• window_size (tuple) – The size of the (square) interrogation window.

• overlap (tuple) – The number of pixel by which two adjacent interrogation windows overlap.

Returns:

field_shape – The shape of the resulting flow field.

Return type:

tuple