SpatialFields class

class IMTreatment.core.spatialfields.SpatialFields

Bases: IMTreatment.core.fields.Fields

add_field(field, copy=True)

copy()

Return a copy of the velocityfields

display(compo=None, **plotargs)

get_profile(direction, position, component=None)

Return a profile of the current fields.

Parameters:

• direction (integer) – Direction along which we choose a position (1 for x and 2 for y)
• position (float, interval of float) – Position, interval in which we want a profile
• component (string) – Component wanted for the profile.

Returns:

profile – Wanted profile

Return type:

Profile object

get_value(x, y, unit=False, error=True)

Return the field component(s) on the point (x, y).

Parameters:

• y (x,) – Point coordinates
• unit (boolean, optional) – If ‘True’, component(s) is(are) returned with its unit.
• error (boolean, optional) – If ‘True’, raise an error if the asked point is outside the fields. If ‘False’, return ‘None’

get_values_on_grid(axe_x, axe_y)

Return a all the fields in a single evenly-spaced grid. (Use interpolation to get the data on the grid points)

Parameters:axe_y (axe_x,) – Representing the grid axis.

mask

mask_as_sf

unit_values

unit_x

unit_y

x_max

x_min

y_max

y_min