UnrecognizedUnit¶
-
class
astropy.units.
UnrecognizedUnit
(st, doc=None, format=None, namespace=None)[source]¶ Bases:
astropy.units.IrreducibleUnit
A unit that did not parse correctly. This allows for round-tripping it as a string, but no unit operations actually work on it.
- Parameters
- ststr
The name of the unit.
Methods Summary
get_format_name
(self, format)Get a name for this unit that is specific to a particular format.
is_equivalent
(self, other[, equivalencies])Returns
True
if this unit is equivalent toother
.is_unity
(self)Returns
True
if the unit is unscaled and dimensionless.to_string
(self[, format])Output the unit in the given format as a string.
Methods Documentation
-
get_format_name
(self, format)[source]¶ Get a name for this unit that is specific to a particular format.
Uses the dictionary passed into the
format
kwarg in the constructor.- Parameters
- formatstr
The name of the format
- Returns
- namestr
The name of the unit for the given format.
-
is_equivalent
(self, other, equivalencies=None)[source]¶ Returns
True
if this unit is equivalent toother
.- Parameters
- otherunit object or string or tuple
The unit to convert to. If a tuple of units is specified, this method returns true if the unit matches any of those in the tuple.
- equivalencieslist of equivalence pairs, optional
A list of equivalence pairs to try if the units are not directly convertible. See Equivalencies. This list is in addition to possible global defaults set by, e.g.,
set_enabled_equivalencies
. UseNone
to turn off all equivalencies.
- Returns
- bool
-
to_string
(self, format=None)[source]¶ Output the unit in the given format as a string.
- Parameters
- format
astropy.units.format.Base
instance or str The name of a format or a formatter object. If not provided, defaults to the generic format.
- format