Field.derivative(axis, wrap=None, one_sided_at_boundary=False, inplace=False, i=False, cyclic=None)[source]

Return the derivative along the specified axis.

The derivative is calculated by centred finite differences along the specified axis.

If the axis is cyclic then the boundary is wrapped around, otherwise missing values are used at the boundary unless one-sided finite differences are requested.


The axis , defined by that which would be selected by passing the given axis description to a call of the field construct’s domain_axis method. For example, for a value of 'X', the domain axis construct returned by f.domain_axis('X')) is selected.

wrap: bool, optional

If True then the boundary is wrapped around, otherwise the value of one_sided_at_boundary determines the boundary condition. If None then the cyclicity of the axis is autodetected.

one_sided_at_boundary: bool, optional

If True then one-sided finite differences are used at the boundary, otherwise missing values are used.

inplace: bool, optional

If True then do the operation in-place and return None.

i: deprecated at version 3.0.0

Use the inplace parameter instead.

Field or None

TODO , or None if the operation was in-place.