dolfyn.rotate2

dolfyn.rotate2(obj, out_frame='earth', inplace=False)

Rotate a data object to a new coordinate system.

Parameters

objVelocity

The dolfyn velocity-data (ADV or ADP) object to rotate.

out_framestring {‘beam’, ‘inst’, ‘earth’, ‘principal’}

The coordinate system to rotate the data into.

inplacebool

Operate on the input data object (True), or return a copy that has been rotated (False, default).

Returns

objoutVelocity

The rotated data object. Note that when inplace=True, the input object is modified in-place and returned (i.e., objout is obj).

Notes

This function rotates all variables in obj.props['rotate_vars'].