Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 30 additions & 4 deletions docs/api/fitting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
Fitting
=======

Fitting
-------
Imaging and Interferometer
--------------------------

For fitting a model consisting of one or more galaxies to a dataset.
For fitting a model consisting of one or more galaxies to an imaging or interferometer dataset.

.. currentmodule:: autogalaxy

Expand All @@ -15,4 +15,30 @@ For fitting a model consisting of one or more galaxies to a dataset.
:recursive:

FitImaging
FitInterferometer
FitInterferometer

Ellipse
-------

For fitting ellipses (isophotes) to an imaging dataset to characterise galaxy morphology.

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst
:recursive:

FitEllipse

Quantity
--------

For fitting a derived quantity (e.g. convergence, deflection angles) computed by one mass
or light profile to the same quantity computed by another, enabling model comparison between
different profile families.

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst
:recursive:

FitQuantity
67 changes: 66 additions & 1 deletion docs/api/light.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ Light Profiles
Standard [``ag.lp``]
--------------------

Standard parametric light profiles whose ``intensity`` is a free parameter of the model.

.. currentmodule:: autogalaxy.profiles.light.standard

.. autosummary::
Expand All @@ -27,4 +29,67 @@ Standard [``ag.lp``]
Chameleon
ChameleonSph
ElsonFreeFall
ElsonFreeFallSph
ElsonFreeFallSph

Linear [``ag.lp_linear``]
--------------------------

Linear light profiles whose ``intensity`` is not a free parameter but is instead solved
analytically via a linear matrix inversion during each likelihood evaluation. This allows
many profiles to be combined efficiently without exploding the non-linear parameter space.

.. currentmodule:: autogalaxy.profiles.light.linear

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst
:recursive:

Gaussian
GaussianSph
Sersic
SersicSph
Exponential
ExponentialSph
DevVaucouleurs
DevVaucouleursSph
SersicCore
SersicCoreSph
ExponentialCore
ExponentialCoreSph

Operated [``ag.lp_operated``]
------------------------------

Operated light profiles that represent emission which has already had an instrument
operation (e.g. PSF convolution) applied to it. The ``operated_only`` parameter on
fitting classes controls whether these profiles are included or excluded from a given
image computation.

.. currentmodule:: autogalaxy.profiles.light.operated

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst
:recursive:

Gaussian
Moffat
Sersic

Basis [``ag.lp_basis``]
------------------------

A ``Basis`` groups a collection of light profiles (e.g. a Multi-Gaussian Expansion or
shapelet decomposition) so that they behave as a single profile in the model. When the
constituent profiles are ``LightProfileLinear`` instances their intensities are all solved
simultaneously via a single inversion.

.. currentmodule:: autogalaxy.profiles.basis

.. autosummary::
:toctree: _autosummary
:template: custom-class-template.rst
:recursive:

Basis
2 changes: 2 additions & 0 deletions docs/api/modeling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ It acts as an interface between the data, model and the non-linear search.

AnalysisImaging
AnalysisInterferometer
AnalysisEllipse
AnalysisQuantity

Non-linear Searches
-------------------
Expand Down
Loading