aotpy.io package

Subpackages

• aotpy.io.fits package
  • Submodules
  • aotpy.io.fits.compat module
    • AOTVersion
      • AOTVersion.from_string()
      • AOTVersion.major
      • AOTVersion.minor
      • AOTVersion.patch
  • aotpy.io.fits.reader module
    • AOTFITSReader
      • AOTFITSReader.get_extra_data()
      • AOTFITSReader.get_system()
  • aotpy.io.fits.utils module
    • FITSFileImage
    • FITSURLImage
    • card_from_metadatum()
    • image_from_fits_file()
    • image_from_hdu()
    • image_from_hdus()
    • metadata_from_hdu()
    • metadatum_from_card()
  • aotpy.io.fits.writer module
    • AOTFITSWriter
      • AOTFITSWriter.get_hdulist()
      • AOTFITSWriter.write()
  • Module contents

Submodules

aotpy.io.base module

This module contains base classes for defining writers and readers in aotpy.

class aotpy.io.base.SystemReader(filename: str | PathLike, **kwargs)

Bases: ABC

Abstract class for system readers.

Readers are able to create an AOSystem based on a file of a certain format.

Parameters:

• filename – Path to file to be read into an AOSystem.

• **kwargs – Keyword arguments passed on as options to the file handling function.

abstract get_system() → AOSystem

Return AOSystem that has been read.

class aotpy.io.base.SystemWriter(system: AOSystem)

Bases: ABC

Abstract class for system writers.

Writers are able to write an AOSystem into a file using some format.

Parameters:

system – AOSystem to be written into a file.

abstract write(filename: str | PathLike, **kwargs) → None

Write the initialized system into the specified filename.

Parameters:

• filename – Path to the file that will be written.

• **kwargs – Keyword arguments passed on as options to the file handling function.

Module contents

This subpackage contains modules and packages for handling AOT files using data storage formats supported by aotpy. Currently only FITS is supported.