Source code for sunpy.io.ana

"""
This module provides an ANA file Reader.

This is a modified version of `pyana <https://github.com/tvwerkhoven/pyana>`__.

.. warning::

    The reading and writing of ana files is not supported under Windows.

    By default, this module is not installed on platforms other than Linux (x86-64) and macOS (x86-64 and ARM64).
    See the installation guide for more info.
"""
import os

from sunpy.io._header import FileHeader
from sunpy.util.decorators import deprecated
from sunpy.util.io import HDPair

try:
    from sunpy.io import _pyana
except ImportError:
    _pyana = None

ANA_NOT_INSTALLED = (
    "C extension for ANA is missing. For more details see: "
    "https://docs.sunpy.org/en/stable/installation.html#installing-without-conda"
)
__all__ = ['read', 'get_header', 'write']


[docs] @deprecated(since="6.0", message="The ANA reader is un-maintained and will be removed in the future. Please contact sunpy if you are using this.", alternative="https://github.com/ITA-Solar/helita has a ANA reader and writer.") def read(filename, debug=False, **kwargs): """ Loads an ANA file and returns the data and a header in a list of (data, header) tuples. Parameters ---------- filename : `str` Name of file to be read. debug : `bool`, optional Prints verbose debug information. **kwargs : `dict` Unused. Returns ------- `list` A list of (data, header) tuples Examples -------- >>> data = sunpy.io.ana.read(filename) # doctest: +SKIP """ if not os.path.isfile(filename): raise OSError("File does not exist!") if _pyana is None: raise ImportError(ANA_NOT_INSTALLED) data = _pyana.fzread(filename, debug) return [HDPair(data['data'], FileHeader(data['header']))]
[docs] @deprecated(since="6.0", message="The ANA reader is un-maintained and will be removed in the future. Please contact sunpy if you are using this.", alternative="https://github.com/ITA-Solar/helita has a ANA reader and writer.") def get_header(filename, debug=False): """ Loads an ANA file and only return the header consisting of the dimensions, size (defined as the product of all dimensions times the size of the datatype, this not relying on actual filesize) and comments. Parameters ---------- filename : `str` Name of file to be read. debug : `bool`, optional Prints verbose debug information. Returns ------- `list` A list of `~sunpy.io._header.FileHeader` headers. Examples -------- >>> header = sunpy.io.ana.get_header(filename) # doctest: +SKIP """ if _pyana is None: raise ImportError(ANA_NOT_INSTALLED) data = _pyana.fzread(filename, debug) return [FileHeader(data['header'])]
[docs] @deprecated(since="6.0", message="The ANA reader is un-maintained and will be removed in the future. Please contact sunpy if you are using this.", alternative="https://github.com/ITA-Solar/helita has a ANA reader and writer.") def write(filename, data, comments=False, compress=True, debug=False): """ Saves a 2D `numpy.array` as an ANA file and returns the bytes written or ``NULL``. Parameters ---------- filename : `str` Name of file to be created. data : `numpy.ndarray` The data to be stored. comments : `~sunpy.io._header.FileHeader`, optional The comments to be stored as a header. compress : `bool`, optional Compress the data with `True` (the default). debug : `bool`, optional Prints verbose debug information, defaults to `False`. Returns ------- `str` A new ANA compressed archive containing the data and header. Examples -------- >>> written = sunpy.io.ana.write(filename, data, comments=False, compress=True) # doctest: +SKIP """ if _pyana is None: raise ImportError(ANA_NOT_INSTALLED) if comments: return _pyana.fzwrite(filename, data, int(compress), comments, debug) else: return _pyana.fzwrite(filename, data, int(compress), '', debug)