Skip to content

Commit fd4d55a

Browse files
Jammy2211claude
authored andcommitted
docs(api): update RST API reference pages for consistency
- fitting.rst: add FitQuantity section with description; split into Imaging/Interferometer and Quantity subsections - point.rst: restructure into Dataset / Solver / Fitting / Position Likelihood / Analysis sections; add FitPointDataset, FitPositionsImagePairAll, FitPositionsImagePairRepeat, FitPositionsSource, FitTimeDelays, PositionsLH - modeling.rst: add AnalysisQuantity to Analysis autosummary table - galaxy.rst: add descriptive text for Galaxy/Galaxies/Tracer section Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent ee980f7 commit fd4d55a

4 files changed

Lines changed: 89 additions & 5 deletions

File tree

docs/api/fitting.rst

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

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

8-
For fitting a model (composed from ``Galaxy`` objects in a ``Tracer``) to a dataset.
8+
For fitting a lens model (composed from ``Galaxy`` objects in a ``Tracer``) to an
9+
imaging or interferometer dataset.
910

1011
.. currentmodule:: autolens
1112

@@ -15,4 +16,18 @@ For fitting a model (composed from ``Galaxy`` objects in a ``Tracer``) to a data
1516
:recursive:
1617

1718
FitImaging
18-
FitInterferometer
19+
FitInterferometer
20+
21+
Quantity
22+
--------
23+
24+
For fitting a derived lensing quantity (e.g. convergence, deflection angles, potential)
25+
predicted by one mass or light model against the same quantity predicted by another, to
26+
enable model comparison between different profile families.
27+
28+
.. autosummary::
29+
:toctree: _autosummary
30+
:template: custom-class-template.rst
31+
:recursive:
32+
33+
FitQuantity

docs/api/galaxy.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ Galaxy / Tracer
55
Galaxy / Tracer
66
---------------
77

8+
``Galaxy`` and ``Galaxies`` model individual galaxies with light and mass profiles at a
9+
given redshift. ``Tracer`` groups galaxies by redshift into planes and performs
10+
multi-plane gravitational lensing ray-tracing, computing lensed images, convergence,
11+
deflection angles, magnification, critical curves, and caustics.
12+
813
.. currentmodule:: autolens
914

1015
.. autosummary::

docs/api/modeling.rst

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

1919
AnalysisImaging
2020
AnalysisInterferometer
21+
AnalysisQuantity
2122

2223
Non-linear Searches
2324
-------------------

docs/api/point.rst

Lines changed: 64 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22
Point Sources
33
=============
44

5+
Point sources arise when the background object is compact (e.g. a quasar, supernova, or
6+
compact radio source) and is modelled by its image-plane positions, flux ratios, and/or
7+
time delays rather than by a resolved surface-brightness distribution.
8+
9+
Dataset
10+
-------
11+
12+
Data structures holding the observed positions, fluxes, and time delays of one or more
13+
named point sources.
14+
515
.. currentmodule:: autolens
616

717
.. autosummary::
@@ -11,7 +21,60 @@ Point Sources
1121

1222
PointDataset
1323
PointDict
24+
25+
Solver
26+
------
27+
28+
The ``PointSolver`` finds the image-plane positions that correspond to a given
29+
source-plane coordinate by solving the lens equation numerically via a triangle-tiling
30+
approach.
31+
32+
.. autosummary::
33+
:toctree: _autosummary
34+
:template: custom-class-template.rst
35+
:recursive:
36+
37+
PointSolver
38+
39+
Fitting
40+
-------
41+
42+
Fit classes for point-source positions, flux ratios, and time delays. ``FitPointDataset``
43+
orchestrates all active components; the individual fit classes can also be used standalone.
44+
45+
.. autosummary::
46+
:toctree: _autosummary
47+
:template: custom-class-template.rst
48+
:recursive:
49+
50+
FitPointDataset
1451
FitPositionsImagePair
52+
FitPositionsImagePairAll
53+
FitPositionsImagePairRepeat
54+
FitPositionsSource
1555
FitFluxes
16-
PointSolver
56+
FitTimeDelays
57+
58+
Position Likelihood
59+
-------------------
60+
61+
``PositionsLH`` adds a penalty to the log likelihood when the observed image positions do
62+
not self-consistently trace back to the same source-plane location, guiding the non-linear
63+
search toward physically consistent mass models.
64+
65+
.. autosummary::
66+
:toctree: _autosummary
67+
:template: custom-class-template.rst
68+
:recursive:
69+
70+
PositionsLH
71+
72+
Analysis
73+
--------
74+
75+
.. autosummary::
76+
:toctree: _autosummary
77+
:template: custom-class-template.rst
78+
:recursive:
79+
1780
AnalysisPoint

0 commit comments

Comments
 (0)