.. _api:

API
===

Top-level indices
-----------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`



Core Modules
------------

.. automodule:: ixpeobssim.core.fitsio
   :members:

.. automodule:: ixpeobssim.core.fitting
   :members:

.. automodule:: ixpeobssim.core.geometry
   :members:

.. automodule:: ixpeobssim.core.hist
   :members:

.. automodule:: ixpeobssim.core.modeling
   :members:

.. automodule:: ixpeobssim.core.pipeline
   :members:

.. automodule:: ixpeobssim.core.rand
   :members:

.. automodule:: ixpeobssim.core.spline
   :members:

.. automodule:: ixpeobssim.core.stokes
   :members:



Binned data products
--------------------

.. automodule:: ixpeobssim.binning.base
   :members:

.. automodule:: ixpeobssim.binning.detector
   :members:

.. automodule:: ixpeobssim.binning.exposure
   :members:

.. automodule:: ixpeobssim.binning.fmt
   :members:

.. automodule:: ixpeobssim.binning.misc
   :members:

.. automodule:: ixpeobssim.binning.polarization
   :members:



Event-level analysis
--------------------

.. automodule:: ixpeobssim.evt.align
   :members:

.. automodule:: ixpeobssim.evt.animate
   :members:

.. automodule:: ixpeobssim.evt.deconvolution
   :members:

.. automodule:: ixpeobssim.evt.display
   :members:

.. automodule:: ixpeobssim.evt.event
   :members:

.. automodule:: ixpeobssim.evt.fmt
   :members:

.. automodule:: ixpeobssim.evt.gti
   :members:

.. automodule:: ixpeobssim.evt.ixpesim
   :members:

.. automodule:: ixpeobssim.evt.kislat2015
   :members:

.. automodule:: ixpeobssim.evt.sonify
   :members:

.. automodule:: ixpeobssim.evt.subselect
   :members:

.. automodule:: ixpeobssim.evt.xspec_
   :members:


Instrument
----------

.. automodule:: ixpeobssim.instrument.charging
   :members:

.. automodule:: ixpeobssim.instrument.du
   :members:

.. automodule:: ixpeobssim.instrument.gpd
   :members:

.. automodule:: ixpeobssim.instrument.mma
   :members:

.. automodule:: ixpeobssim.instrument.sc
   :members:

.. automodule:: ixpeobssim.instrument.traj
   :members:


Response Functions
------------------

.. automodule:: ixpeobssim.irf.arf
   :members:

.. automodule:: ixpeobssim.irf.base
   :members:

.. automodule:: ixpeobssim.irf.caldb
   :members:

.. automodule:: ixpeobssim.irf.modf
   :members:

.. automodule:: ixpeobssim.irf.mrf
   :members:

.. automodule:: ixpeobssim.irf.psf
   :members:

.. automodule:: ixpeobssim.irf.rmf
   :members:

.. automodule:: ixpeobssim.irf.vign
   :members:


IRF Generation
--------------

.. automodule:: ixpeobssim.irfgen.alphas
   :members:

.. automodule:: ixpeobssim.irfgen.astar
   :members:

.. automodule:: ixpeobssim.irfgen.auxiliary
   :members:

.. automodule:: ixpeobssim.irfgen.base
   :members:

.. automodule:: ixpeobssim.irfgen.du
   :members:

.. automodule:: ixpeobssim.irfgen.gpd
   :members:

.. automodule:: ixpeobssim.irfgen.xcom
   :members:


Source Models
-------------

.. automodule:: ixpeobssim.srcmodel.bkg
   :members:

.. automodule:: ixpeobssim.srcmodel.calibsrc
   :members:

.. automodule:: ixpeobssim.srcmodel.ephemeris
   :members:

.. automodule:: ixpeobssim.srcmodel.gabs
   :members:

.. automodule:: ixpeobssim.srcmodel.img
   :members:

.. automodule:: ixpeobssim.srcmodel.magnetar
   :members:

.. automodule:: ixpeobssim.srcmodel.polarization
   :members:

.. automodule:: ixpeobssim.srcmodel.roi
   :members:

.. automodule:: ixpeobssim.srcmodel.spectrum
   :members:

.. automodule:: ixpeobssim.srcmodel.tdelays
   :members:



Utilities
---------

.. automodule:: ixpeobssim.utils.argparse_
   :members:

.. automodule:: ixpeobssim.utils.chandra
   :members:

.. automodule:: ixpeobssim.utils.codestyle
   :members:

.. automodule:: ixpeobssim.utils.fmtaxis
   :members:

.. automodule:: ixpeobssim.utils.logging_
   :members:

.. automodule:: ixpeobssim.utils.math_
   :members:

.. automodule:: ixpeobssim.utils.matplotlib_
   :members:

.. automodule:: ixpeobssim.utils.misc
   :members:

.. automodule:: ixpeobssim.utils.os_
   :members:

.. automodule:: ixpeobssim.utils.packaging_
   :members:

.. automodule:: ixpeobssim.utils.profile
   :members:

.. automodule:: ixpeobssim.utils.system_
   :members:

.. automodule:: ixpeobssim.utils.time_
   :members:

.. automodule:: ixpeobssim.utils.units_
   :members: