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
-------
out: ANA compressed archive
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("C extension for ANA is missing, please rebuild")
if comments:
return _pyana.fzwrite(filename, data, int(compress), comments, debug)
else:
return _pyana.fzwrite(filename, data, int(compress), '', debug)
def write(filename, data, comments=False, compress=1, debug=False):
"""
Saves a 2D numpy array as an ANA file and returns the bytes written or NULL
Parameters
----------
filename: string
Name of file to be created.
data: numpy array
Name of data to be stored.
comments: FileHeader, optional
The comments to be stored as a header.
compress: int, optional
To compress the data or not.
1 is to compress, 0 is uncompressed
debug: bool, optional
Prints versbose debug information.
Returns
-------
out: ANA compressed archive
A new ANA compressed archive containing the data and header.
Examples
--------
>>> written = sunpy.io.ana.write(filename, data, comments=Falsem, compress=1)
"""
if _pyana is None:
raise ImportError("C extension for ANA is missing, please rebuild"
) # pragma: no cover
if comments:
return _pyana.fzwrite(filename, data, compress, comments, debug)
else:
return _pyana.fzwrite(filename, data, compress, '', debug)
def write(filename, data, comments=False, compress=1, debug=False):
"""
Saves a 2D numpy array as an ANA file and returns the bytes written or NULL
Parameters
----------
filename: string
Name of file to be created.
data: numpy array
Name of data to be stored.
comments: FileHeader, optional
The comments to be stored as a header.
compress: int, optional
To compress the data or not.
1 is to compress, 0 is uncompressed
debug: bool, optional
Prints versbose debug information.
Returns
-------
out: ANA compressed archive
A new ANA compressed archive containing the data and header.
Examples
--------
>>> written = sunpy.io.ana.write(filename, data, comments=Falsem, compress=1)
"""
if _pyana is None:
raise ImportError("C extension for ANA is missing, please rebuild")# pragma: no cover
if comments:
return _pyana.fzwrite(filename, data, compress, comments, debug)
else:
return _pyana.fzwrite(filename, data, compress, '', debug)
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
-------
out: ANA compressed archive
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("C extension for ANA is missing, please rebuild")
if comments:
return _pyana.fzwrite(filename, data, int(compress), comments, debug)
else:
return _pyana.fzwrite(filename, data, int(compress), '', debug)
