OGIP¶
- class astropy.units.format.OGIP(*args, **kwargs)[source]¶
Bases:
Generic
Support the units in Office of Guest Investigator Programs (OGIP) FITS files.
Attributes Summary
Methods Summary
parse
(s[, debug])Convert a string to a unit object.
to_string
(unit[, fraction])Convert a unit to its string representation.
Attributes Documentation
- name = 'ogip'¶
Methods Documentation
- classmethod to_string(unit, fraction='inline')[source]¶
Convert a unit to its string representation.
Implementation for
to_string
.- Parameters:
- unit
UnitBase
The unit to convert.
- 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 (available for the
latex
,console
andunicode
formats only; e.g.,$\mathrm{\frac{km}{s}}$
).
- unit
- Raises:
ValueError
If
fraction
is not recognized.