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
23 changes: 19 additions & 4 deletions docs/api/fitting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@
Fitting
=======

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

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

.. currentmodule:: autolens

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

FitImaging
FitInterferometer
FitInterferometer

Quantity
--------

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

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

FitQuantity
5 changes: 5 additions & 0 deletions docs/api/galaxy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ Galaxy / Tracer
Galaxy / Tracer
---------------

``Galaxy`` and ``Galaxies`` model individual galaxies with light and mass profiles at a
given redshift. ``Tracer`` groups galaxies by redshift into planes and performs
multi-plane gravitational lensing ray-tracing, computing lensed images, convergence,
deflection angles, magnification, critical curves, and caustics.

.. currentmodule:: autolens

.. autosummary::
Expand Down
1 change: 1 addition & 0 deletions docs/api/modeling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ It acts as an interface between the data, model and the non-linear search.

AnalysisImaging
AnalysisInterferometer
AnalysisQuantity

Non-linear Searches
-------------------
Expand Down
65 changes: 64 additions & 1 deletion docs/api/point.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@
Point Sources
=============

Point sources arise when the background object is compact (e.g. a quasar, supernova, or
compact radio source) and is modelled by its image-plane positions, flux ratios, and/or
time delays rather than by a resolved surface-brightness distribution.

Dataset
-------

Data structures holding the observed positions, fluxes, and time delays of one or more
named point sources.

.. currentmodule:: autolens

.. autosummary::
Expand All @@ -11,7 +21,60 @@ Point Sources

PointDataset
PointDict

Solver
------

The ``PointSolver`` finds the image-plane positions that correspond to a given
source-plane coordinate by solving the lens equation numerically via a triangle-tiling
approach.

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

PointSolver

Fitting
-------

Fit classes for point-source positions, flux ratios, and time delays. ``FitPointDataset``
orchestrates all active components; the individual fit classes can also be used standalone.

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

FitPointDataset
FitPositionsImagePair
FitPositionsImagePairAll
FitPositionsImagePairRepeat
FitPositionsSource
FitFluxes
PointSolver
FitTimeDelays

Position Likelihood
-------------------

``PositionsLH`` adds a penalty to the log likelihood when the observed image positions do
not self-consistently trace back to the same source-plane location, guiding the non-linear
search toward physically consistent mass models.

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

PositionsLH

Analysis
--------

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

AnalysisPoint
Loading