UnrecognizedUnit

class astropy.units.UnrecognizedUnit(st, register=None, doc=None, format=None, namespace=None)

Bases: astropy.units.IrreducibleUnit

A unit that did not parse correctly. This allows for roundtripping it as a string, but no unit operations actually work on it.

Parameters:

st : str

The name of the unit.

Methods Summary

get_converter(other[, equivalencies])	Return the conversion function to convert values from self to the specified unit.
get_format_name(format)	Get a name for this unit that is specific to a particular format.
is_equivalent(other[, equivalencies])	Returns True if this unit is equivalent to other.
is_unity()	Returns True if the unit is unscaled and dimensionless.
to_string([format])	Output the unit in the given format as a string.

Methods Documentation

get_converter(other, equivalencies=None)

Return the conversion function to convert values from self to the specified unit.

Parameters:

other : unit object or string

The unit to convert to.

equivalencies : list 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. Use None to turn off all equivalencies.

Returns:

func : callable

A callable that normally expects a single argument that is a scalar value or an array of values (or anything that may be converted to an array).

Raises:

UnitsError

If units are inconsistent

get_format_name(format)

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:

format : str

The name of the format

Returns:

name : str

The name of the unit for the given format.

is_equivalent(other, equivalencies=None)

Returns True if this unit is equivalent to other.

Parameters:

other : unit 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.

equivalencies : list 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. Use None to turn off all equivalencies.

Returns:

bool

is_unity()

Returns True if the unit is unscaled and dimensionless.

to_string(format=u'generic')

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.