{ } Raw JSON

bundles / astropy 7.0.1 / astropy / io / fits / convenience / info

function

astropy.io.fits.convenience:info

source: /astropy/io/fits/convenience.py :803

Signature

def   info ( filename output = None ** kwargs )

Summary

Print the summary information on a FITS file.

Extended Summary

This includes the name, type, length of header, data shape and type for each HDU.

Parameters

filename : path-like or file-like

FITS file to obtain info from. If opened, mode must be one of the following: rb, rb+, or ab+ (i.e. the file must be readable).

output : file, bool, optional

A file-like object to write the output to. If False, does not output to a file and instead returns a list of tuples representing the HDU info. Writes to sys.stdout by default.

**kwargs

Any additional keyword arguments to be passed to astropy.io.fits.open. Note: This function sets ignore_missing_end=True by default.

Aliases

  • astropy.io.fits.info