diff --git a/docs/api/fitting.rst b/docs/api/fitting.rst index b33bc8431..9b2f1848a 100644 --- a/docs/api/fitting.rst +++ b/docs/api/fitting.rst @@ -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 @@ -15,4 +16,18 @@ For fitting a model (composed from ``Galaxy`` objects in a ``Tracer``) to a data :recursive: FitImaging - FitInterferometer \ No newline at end of file + 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 \ No newline at end of file diff --git a/docs/api/galaxy.rst b/docs/api/galaxy.rst index 75d0f5e84..2aaffe1d4 100644 --- a/docs/api/galaxy.rst +++ b/docs/api/galaxy.rst @@ -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:: diff --git a/docs/api/modeling.rst b/docs/api/modeling.rst index 2940aa96c..4af1f8e6c 100644 --- a/docs/api/modeling.rst +++ b/docs/api/modeling.rst @@ -18,6 +18,7 @@ It acts as an interface between the data, model and the non-linear search. AnalysisImaging AnalysisInterferometer + AnalysisQuantity Non-linear Searches ------------------- diff --git a/docs/api/point.rst b/docs/api/point.rst index 8bb6517d2..e740464c3 100644 --- a/docs/api/point.rst +++ b/docs/api/point.rst @@ -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:: @@ -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 \ No newline at end of file