Skip to main content
`Ctrl`+`K`

# OGIP

class astropy.units.format.OGIP(*args, **kwargs)

  Bases: `Base`, `_ParsingFormatMixin`

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

  Attributes Summary

  `name` |

  Methods Summary

  `format_exponential_notation`(val[, format_spec]) | Formats a value in exponential notation.
  `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 format_exponential_notation(val, format_spec='g')

    Formats a value in exponential notation.

    Parameters:
      val number

        The value to be formatted

      format_spec `python:str`, optional

        Format used to split up mantissa and exponent

    Returns:
      `python:str`

        The value in exponential notation in a this class’s format.

  classmethod parse(s, debug=False)

    Convert a string to a unit object.

  classmethod to_string(unit, fraction='inline')

    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 if possible (available for the `latex`, `console` and `unicode` formats; e.g., `$\mathrm{\frac{km}{s}}$`). If not possible, use ‘inline’.

    Raises:
      `ValueError`

        If `fraction` is not recognized.