Skip to content

Commit a487265

Browse files
authored
Merge pull request #303 from Jammy2211/docs/api-rst
docs(api): update RST API reference pages for consistency
2 parents 67783ad + 11dee5a commit a487265

File tree

3 files changed

+98
-5
lines changed

3 files changed

+98
-5
lines changed

docs/api/fitting.rst

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
Fitting
33
=======
44

5-
Fitting
6-
-------
5+
Imaging and Interferometer
6+
--------------------------
77

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

1010
.. currentmodule:: autogalaxy
1111

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

1717
FitImaging
18-
FitInterferometer
18+
FitInterferometer
19+
20+
Ellipse
21+
-------
22+
23+
For fitting ellipses (isophotes) to an imaging dataset to characterise galaxy morphology.
24+
25+
.. autosummary::
26+
:toctree: _autosummary
27+
:template: custom-class-template.rst
28+
:recursive:
29+
30+
FitEllipse
31+
32+
Quantity
33+
--------
34+
35+
For fitting a derived quantity (e.g. convergence, deflection angles) computed by one mass
36+
or light profile to the same quantity computed by another, enabling model comparison between
37+
different profile families.
38+
39+
.. autosummary::
40+
:toctree: _autosummary
41+
:template: custom-class-template.rst
42+
:recursive:
43+
44+
FitQuantity

docs/api/light.rst

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Light Profiles
55
Standard [``ag.lp``]
66
--------------------
77

8+
Standard parametric light profiles whose ``intensity`` is a free parameter of the model.
9+
810
.. currentmodule:: autogalaxy.profiles.light.standard
911

1012
.. autosummary::
@@ -27,4 +29,67 @@ Standard [``ag.lp``]
2729
Chameleon
2830
ChameleonSph
2931
ElsonFreeFall
30-
ElsonFreeFallSph
32+
ElsonFreeFallSph
33+
34+
Linear [``ag.lp_linear``]
35+
--------------------------
36+
37+
Linear light profiles whose ``intensity`` is not a free parameter but is instead solved
38+
analytically via a linear matrix inversion during each likelihood evaluation. This allows
39+
many profiles to be combined efficiently without exploding the non-linear parameter space.
40+
41+
.. currentmodule:: autogalaxy.profiles.light.linear
42+
43+
.. autosummary::
44+
:toctree: _autosummary
45+
:template: custom-class-template.rst
46+
:recursive:
47+
48+
Gaussian
49+
GaussianSph
50+
Sersic
51+
SersicSph
52+
Exponential
53+
ExponentialSph
54+
DevVaucouleurs
55+
DevVaucouleursSph
56+
SersicCore
57+
SersicCoreSph
58+
ExponentialCore
59+
ExponentialCoreSph
60+
61+
Operated [``ag.lp_operated``]
62+
------------------------------
63+
64+
Operated light profiles that represent emission which has already had an instrument
65+
operation (e.g. PSF convolution) applied to it. The ``operated_only`` parameter on
66+
fitting classes controls whether these profiles are included or excluded from a given
67+
image computation.
68+
69+
.. currentmodule:: autogalaxy.profiles.light.operated
70+
71+
.. autosummary::
72+
:toctree: _autosummary
73+
:template: custom-class-template.rst
74+
:recursive:
75+
76+
Gaussian
77+
Moffat
78+
Sersic
79+
80+
Basis [``ag.lp_basis``]
81+
------------------------
82+
83+
A ``Basis`` groups a collection of light profiles (e.g. a Multi-Gaussian Expansion or
84+
shapelet decomposition) so that they behave as a single profile in the model. When the
85+
constituent profiles are ``LightProfileLinear`` instances their intensities are all solved
86+
simultaneously via a single inversion.
87+
88+
.. currentmodule:: autogalaxy.profiles.basis
89+
90+
.. autosummary::
91+
:toctree: _autosummary
92+
:template: custom-class-template.rst
93+
:recursive:
94+
95+
Basis

docs/api/modeling.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ It acts as an interface between the data, model and the non-linear search.
1818

1919
AnalysisImaging
2020
AnalysisInterferometer
21+
AnalysisEllipse
22+
AnalysisQuantity
2123

2224
Non-linear Searches
2325
-------------------

0 commit comments

Comments
 (0)