dolfyn.ADVdata

class dolfyn.ADVdata(*args, **kwargs)

The acoustic Doppler velocimeter (ADV) data type.

See also

dolfyn.Velocity

__init__(self, \*args, \*\*kwargs)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(self, \*args, \*\*kwargs)	Initialize self.
append(self, other)	Join two data objects together.
clear()
copy(self)	Create a copy of the data object.
fromkeys(iterable[, value])	Create a new dictionary with keys from iterable and values set to value.
get(self, key[, default])	Return the value for key if key is in the dictionary, else default.
items()
iter_data(self[, include_hidden])	Generate the keys for all data items in this data object, including walking through sub-data objects.
iter_subgroups(self[, include_hidden])	Generate the keys for all sub-groups in this data object, including walking through sub-groups.
keys()
pop(self, indx[, d])	If key is not found, d is returned if given, otherwise KeyError is raised
popitem()	2-tuple; but raise KeyError if D is empty.
rotate2(self, out_frame[, inplace])	Rotate the data object into a new coordinate system.
set_declination(self, declination)	Set the declination of the data object.
set_inst2head_rotmat(self, rotmat)
setdefault(self, key[, default])	Insert key with a value of default if key is not in the dictionary.
to_hdf5(self, buf[, chunks, compression])	Write the data in this object to an hdf5 file.
update()	If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values()

Attributes

U	Horizontal velocity as a complex quantity.
U_angle	Angle of horizontal velocity vector (radians clockwise from east/X/streamwise).
U_mag	Horizontal velocity magnitude.
n_time	The number of timesteps in the data object.
shape	The shape of ‘scalar’ data in this data object.
shortcuts
subset	Subset is an indexer for creating subsets of the data object using Python slice syntax.
u	The first velocity component.
v	The second velocity component.
w	The third velocity component.