ftsdata documentation

FTSData provides the Fourier-transform spectrometer data containers, transforms, FITS/HDF5 I/O and co-addition routines.

• FTSData — spectral and interferogram cubes
  • Class hierarchy
  • Data model
  • Constructing from arrays
  • Interferogram → spectrum: to_spectra
  • Instrumental Line Shape (ILS)
  • Spectral corrections
  • Forward model: spectrum → interferogram (to_itg)
  • FITS I/O
  • IDIA HDF5 format
  • Combining cubes
  • Choosing inversion parameters
  • Binning correction in detail
• API Reference
  • ftsdata.FTSData
  • ftsdata.SpecData
  • ftsdata.SingleSidedOpdData
  • ftsdata.DoubleSidedOpdData
  • ftsdata.OneSidedOpdData
  • ftsdata.apply_blockwise
  • ftsdata.get_ils_kernel
  • ftsdata.get_itg_binning_correction
  • ftsdata.forman
  • ftsdata.has_axis_type
  • ftsdata.is_spectral
  • ftsdata.is_itg
  • ftsdata.merge_metas
  • ftsdata.fits_ftsdata_reader
  • ftsdata.fits_ftsdata_writer
  • ftsdata.hdf5_ftsdata_reader
  • ftsdata.hdf5_ftsdata_writer
  • ftsdata.is_idia_hdf5
  • ftsdata.plot_cube_preview
  • ftsdata.ftsdata_average
• Minimum supported versions
  • Policy
  • Current floors
  • Legacy stack removal target
  • Updating the floors
• Releasing
  • Version numbers
  • Release checklist
  • Moving or re-creating a tag
  • GitHub Actions (default)
  • GitLab CI (optional)
  • Manual upload

Installation

python -m pip install -e .

Optional extras:

python -m pip install -e ".[all]"

Import paths

from ftsdata import FTSData, SpecData, ftsdata_average

Existing code can keep using the compatibility shim:

from kidsdata.ftsdata import FTSData

Building these docs

python -m pip install -e ".[docs]"
python -m sphinx -b html docs docs/_build/html