contour_field¶

hcipy.plotting.contour_field(field, grid=None, ax=None, grid_units=1, *args, **kwargs)¶

Plot contours of a field.

Parameters

fieldField or ndarray: The field that we want to display. If this is an ndarray, then the parameter grid needs to be supplied. If the field is complex, then it will be automatically fed into complex_field_to_rgb(). If the field is a vector field with length 3 or 4, these will be interpreted as an RGB or RGBA field.
gridGrid or None: If a grid is supplied, it will be used instead of the grid of field.
axmatplotlib axes: The axes which to draw on. If it is not given, the current axes will be used.
grid_unitsscalar or array_like: The size of a unit square. The grid will be scaled by the inverse of this number before plotting. If this is a scalar, an isotropic scaling will be applied.

Returns