seaduck.ocedata.RelCoord and subclasses

class seaduck.ocedata.RelCoord

Bases: dict

NamedTuple that also has update method.

This class is used to store the relative coordinates. Attributes starts with “i” are indexes of the nearest grid point. Attributes starts with “b” are value (time/dep/lat/lon) of the nearest grid point. Attributes starts with “d” are distance between the nearest grid point and its neighboring point in meters or seconds. Attributes starts with “r” are the distance from the point of interest to the nearest non-dimensionalized by the “d” variable. “cs”, “sn” are the cosine and sine of the grid orientation relative to meridian. “face” is the face/tile the point is on, if the dataset has such a dimension.

All of those attributes should be None or 1D numpy array.

update(other)

Inheritated from dictionary.

classmethod create_class(class_name, fields)

Create a subclass with predetermined keys.

subset(which)

Create a subset of all the non-None items.

update_from_subset(sub, which)

Subclasses

class seaduck.ocedata.HRel(*args)

Wrap around the horizontal rel-coords. See also RelCoord.

class seaduck.ocedata.VRel(*args)

Wrap around the vertical centered nearest rel-coords. See also RelCoord.

seaduck.ocedata.VLinRel

alias of NewClass

class seaduck.ocedata.VlRel(*args)

Wrap around the vertical staggered nearest rel-coords. See also RelCoord.

class seaduck.ocedata.VlLinRel(*args)

Wrap around the vertical staggered linear rel-coords. See also RelCoord.

class seaduck.ocedata.TRel(*args)

Wrap around the temporal linear rel-coords. See also RelCoord.

class seaduck.ocedata.TLinRel(*args)