API

This is cosipy’s Application Programming Interface (API). It is an exhaustive list of all available classes and their properties, as well as the inputs and outputs of each method.

If you are instead interested in an overview on how to use cosipy, see out tutorial series instead.

Warning

Under construction. The description of some methods is still missing. If you need the description of a particular class, please open an issue so we can prioritize it.

Contents:

• Detector response
  • Classes
    • PointSourceResponse
    • DetectorResponse
    • FullDetectorResponse
    • ExtendedSourceResponse
• Data IO
  • Classes
    • DataIO
    • UnBinnedData
    • BinnedData
    • ReadTraTest
• Spacecraft File
  • Classes
    • SpacecraftFile
    • SpacecraftAttitudeMap
• COSILike (3ML plugin)
  • Classes
    • COSILike
• TS Map
  • Classes
    • TSMap
    • FastTSMap
    • FastNormFit
• Image deconvolution
  • Algorithm description
  • Classes
    • ImageDeconvolution
    • ImageDeconvolutionDataInterfaceBase
    • DataIF_COSI_DC2
    • ModelBase
    • AllSkyImageModel
    • DeconvolutionAlgorithmBase
    • RichardsonLucy
    • RichardsonLucySimple
    • SpacecraftAttitudeExposureTable
    • CoordsysConversionMatrix
• Polarization
  • Conventions
    • Orthographic
    • Stereographic
    • Converting from one convention and/or frame to another
  • Classes
• Source injector
  • Classes
    • SourceInjector
• Utilities
  • Functions
    • fetch_wasabi_file()