From 11dee5a23744fd2953e75868af6398d6011e493f Mon Sep 17 00:00:00 2001 From: Jammy2211 Date: Tue, 10 Mar 2026 17:07:34 +0000 Subject: [PATCH] docs(api): update RST API reference pages for consistency - fitting.rst: add FitEllipse and FitQuantity sections with descriptive headings explaining when each fit class is used - modeling.rst: add AnalysisEllipse and AnalysisQuantity to the Analysis autosummary table - light.rst: add three new sections for linear (ag.lp_linear), operated (ag.lp_operated), and basis (ag.lp_basis) light profiles, each with a brief description explaining the role of that profile family Co-Authored-By: Claude Sonnet 4.6 --- docs/api/fitting.rst | 34 +++++++++++++++++++--- docs/api/light.rst | 67 ++++++++++++++++++++++++++++++++++++++++++- docs/api/modeling.rst | 2 ++ 3 files changed, 98 insertions(+), 5 deletions(-) diff --git a/docs/api/fitting.rst b/docs/api/fitting.rst index e09023a6b..b74e045fb 100644 --- a/docs/api/fitting.rst +++ b/docs/api/fitting.rst @@ -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 @@ -15,4 +15,30 @@ For fitting a model consisting of one or more galaxies to a dataset. :recursive: FitImaging - FitInterferometer \ No newline at end of file + 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 \ No newline at end of file diff --git a/docs/api/light.rst b/docs/api/light.rst index f582ba752..fcaf89354 100644 --- a/docs/api/light.rst +++ b/docs/api/light.rst @@ -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:: @@ -27,4 +29,67 @@ Standard [``ag.lp``] Chameleon ChameleonSph ElsonFreeFall - ElsonFreeFallSph \ No newline at end of file + 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 \ No newline at end of file diff --git a/docs/api/modeling.rst b/docs/api/modeling.rst index d39c1df2f..9c7420a80 100644 --- a/docs/api/modeling.rst +++ b/docs/api/modeling.rst @@ -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 -------------------