ftsdata.hdf5_ftsdata_reader

ftsdata.hdf5_ftsdata_reader(filename, unit=None, dset_mask='MASK', dset_uncertainty='UNCERT', dset_hits='HITS', dset_flags=None, key_uncertainty_type='UTYPE', cls=None)[source]

Generate an FTSData object from an IDIA HDF5 file.

Parameters:

filenamestr: Name of the HDF5 file to read.
unitUnit, optional: Units of the image data. If this argument is provided and there is a unit for the image in the FITS header (the keyword BUNIT is used as the unit, if present), this argument is used for the unit. Default is None.
dset_mask, dset_uncertainty, dset_flags, dset_hitsstr or None, optional: If it is a string append this attribute to the dataset dictionnary as ndarray. Flags are not supported at this time. If None this attribute is not appended. Default is 'MASK' for mask, 'UNCERT' for uncertainty, 'HITS' for hits and None for flags.
key_uncertainty_typestr, optional: The header key name for the class name of the uncertainty (if any) that is used to store the uncertainty type in the uncertainty hdu. Default is UTYPE.