OGIP#

class astropy.units.format.OGIP(*args, **kwargs)[source]#

Bases: FITS

Support the units in Office of Guest Investigator Programs (OGIP) FITS files.

Attributes Summary

name

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: ClassVar[str] = 'ogip'#

Methods Documentation

classmethod parse(s: str, debug: bool = False) → UnitBase[source]#

Convert a string to a unit object.

classmethod to_string(unit: UnitBase, fraction: bool | Literal['inline'] = 'inline') → str[source]#

Convert a unit to its string representation.

Implementation for to_string.

Parameters:
unit|Unit|

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 and unicode formats only; e.g., $\mathrm{\frac{km}{s}}$).

Raises:
ValueError

If fraction is not recognized.