Class for grid specifications¶

In order to save the specifications of the grid a class in created.

class piv.grid_spec.GridSpec(frame_shape, frame_strides, window_size, search_size, distance)[source]¶

Class for grid specifications.

This class saves and calculates the grid specifications.

Initialization of the shapes and strides.

Setting the values according to parameters. If the window_size and search_size are not the same a padding for the smaller one is added.

Parameters:	frame_shape – shape of the initial image frame_strides – strides of the initial image window_size – size of the interrogation window search_size – size of the search window distance – distance between interrogation window beginnings

For comparing two GridSpec objects a operator is given.

GridSpec.equal_to(grid_spec)[source]¶

Comparison operator for class.

Two GridSpecs are equal if the window_size, the search_size and distance are equal.

Parameters:	grid_spec (GridSpec) – grid spec to compare with
Returns:	True or False

To get the information out of the class, getter functions are given.

GridSpec.get_grid_shape()[source]¶

Getter function for the shape of the grid.

The returned value is the shape of the grid calculated from the arrangement of the interrogation windows.

Returns:	grid shape in x and y direction as tuple

GridSpec.get_interogation_grid_shape()[source]¶

Getter function for the shape of the interrogation window.

Returns:	shape of the interrogation window

GridSpec.get_search_grid_shape()[source]¶

Getter function for the shape of the search window.

Returns:	shape of the search window

GridSpec.get_interogation_grid_strides()[source]¶

Getter function for the strides of the interrogation window.

Returns:	strides of the interrogation window

GridSpec.get_search_grid_strides()[source]¶

Getter function for the strides of the search window.

Returns:	strides of the search window