h5rdmtoolbox.convention.standard_names.name.StandardName

h5rdmtoolbox.convention.standard_names.name.StandardName#

class h5rdmtoolbox.convention.standard_names.name.StandardName(name, units=None, description=None, canonical_units=None, isvector=False, alias=None)[source]#

Standard Name class

__init__(name, units=None, description=None, canonical_units=None, isvector=False, alias=None)[source]#

Methods

__init__(name[, units, description, ...])

check(snt)

check if is a valid standard name of the provided table

check_syntax(standard_name)

formal check of the syntax

equal_unit(other_unit)

compares the base units of this standard name with another unit provided as a string or pint.Unit

is_vector()

check if is a vector

to_dict()

Return dictionary representation of StandardName