This submodule contains two types of routines, the first reads (data, header) pairs from files in a way similar to FITS files. The other is special readers for files that are commonly used in solar physics.
File input and output functions
read_file(filepath[, filetype]) |
Automatically determine the filetype and read the file. |
read_file_header(filepath[, filetype]) |
Reads the header from a given file. |
write_file(fname, data, header[, filetype]) |
Write a file from a data & header pair using one of the defined file types. |
FileHeader(*args, **kwargs) |
FileHeader is designed to provide a consistent interface to all other sunpy classes that expect a generic file. |
FITS File Reader
Notes
[1] FITS files allow comments to be attached to every value in the header. This is implemented in this module as a KEYCOMMENTS dictionary in the sunpy header. To add a comment to the file on write, add a comment to this dictionary with the same name as a key in the header (upcased).
[2] Due to the way fits works with images the header dictionary may
differ depending on whether is accessed before or after the fits[0].data
is requested. If the header is read before the data then the original
header will be returned. If the header is read after the data has been
accessed then the data will have been scaled and a modified header
reflecting these changes will be returned: BITPIX may differ and
BSCALE and B_ZERO may be dropped in the modified version.
[3] The verify(‘fix’) call attempts to handle violations of the FITS standard. For example, nan values will be converted to “nan” strings. Attempting to cast a pyfits header to a dictionary while it contains invalid header tags will result in an error so verifying it early on makes the header easier to work with later.
References
header_to_fits(header) |
Convert a header dict to a Header. |
read(filepath[, hdus, memmap]) |
Read a fits file |
get_header(afile) |
Read a fits file and return just the headers for all HDU’s. |
write(fname, data, header[, hdu_type]) |
Take a data header pair and write a FITS file. |
extract_waveunit(header) |
Attempt to read the wavelength unit from a given FITS header. |
JPEG 2000 File Reader
read(filepath, **kwargs) |
Reads a JPEG2000 file |
get_header(filepath) |
Reads the header from the file |
write(fname, data, header) |
Place holder for required file writer |
ANA File Reader
Warning
The reading and writing of ana file is not supported under Windows. The C extensions are not built on Windows.
Notes
ANA is a script that allows people to access compressed ana files. It accesses a C library, based on Michiel van Noort’s IDL DLM library ‘f0’ which contains a cleaned up version of the original anarw routines.
Created by Tim van Werkhoven (t.i.m.vanwerkhoven@gmail.com) on 2009-02-11. Copyright (c) 2009–2011 Tim van Werkhoven.
read(filename[, debug]) |
Loads an ANA file and returns the data and a header in a list of (data, header) tuples. |
get_header(filename[, debug]) |
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. |
write(filename, data[, comments, compress, …]) |
Saves a 2D numpy array as an ANA file and returns the bytes written or NULL |