FITS#
- class astropy.units.format.FITS(*args, **kwargs)[source]#
Bases:
Base,_GenericParserMixinThe FITS standard unit format.
This supports the format defined in the Units section of the FITS Standard.
Attributes Summary
Methods Summary
parse(s[, debug])Convert a string to a unit object.
to_string(unit[, fraction, deprecations])Convert a unit to its string representation.
Attributes Documentation
- name = 'fits'#
Methods Documentation
- classmethod to_string(unit, fraction=False, deprecations=DeprecatedUnitAction.WARN)[source]#
Convert a unit to its string representation.
Implementation for
to_string.- Parameters:
- unit|Unit|
The unit to convert.
- deprecations{“warn”, “silent”, “raise”, “convert”}, optional, keyword-only
Whether deprecated units should emit a warning, be handled silently or raise an error. The “convert” option replaces the deprecated unit if possible and emits a warning otherwise.
- fraction{False|True|’inline’|’multiline’}, optional
Options are as follows:
False: display unit bases with negative powers as they are (e.g.,km s-1);‘inline’ or
True: use a single-line fraction (e.g.,km / s);‘multiline’ : use a multiline fraction if possible (available for the
latex,consoleandunicodeformats; e.g.,$\mathrm{\frac{km}{s}}$). If not possible, use ‘inline’.
- Raises:
ValueErrorIf
fractionis not recognized.