API Reference

OpdData is the generic entry point when the OPD geometry is unknown. It is an alias of SingleSidedOpdData, so OpdData.from_array and OpdData.read inspect the OPD axis and return the matching subclass (DoubleSidedOpdData, OneSidedOpdData or SingleSidedOpdData). Direct construction, OpdData(...), does not dispatch: use from_array or read when the geometry is not known in advance. FTSData remains the retro-compatibility class.

FTSData

Retro-compatibility class.

SpecData

Class to handle spectral cube from FTS data.

SingleSidedOpdData

Class to handle OPD cube of FTS cubes.

DoubleSidedOpdData

Interferogram cube with a symmetric OPD axis, ZPD at the centre.

OneSidedOpdData

Interferogram cube with the ZPD at the start of the OPD axis.

apply_blockwise

Apply func to a cube in parallel, over blocks of pixels.

get_ils_kernel

Retrieve the ILS of a given FTS observation as an astropy.convolution.Kernel.

get_itg_binning_correction

Compute the itg binning correction to spectra

forman

Return Forman window.

has_axis_type

is_spectral

is_itg

merge_metas

fits_ftsdata_reader

Generate a FTS Data object from a FITS file.

fits_ftsdata_writer

Write FTSData object to FITS file.

hdf5_ftsdata_reader

Generate an FTSData object from an IDIA HDF5 file.

hdf5_ftsdata_writer

Write an FTSData object to an IDIA HDF5 file.

is_idia_hdf5

Determine whether origin is a IDIA HDF5 file.

plot_cube_preview

ftsdata_average

Return weighted average of severak FTSData, using inverse variance as the weights