Skip to content

Commit 080c52e

Browse files
committed
docs: document spectral-line datacube modeling in the feature overview
Datacube modeling shipped in May 2026 (list of Interferometer datasets in an af.FactorGraphModel, shared lens model, per-channel source, shared curvature matrix across channels), but the docs never mentioned it — a user reading the feature overview or the "What Dataset Type?" routing had no way to learn cubes were supported. - overview_3_features.md: add a "Data Cubes" one-line summary and a full section covering the list-of-datasets design, the shared-lens/per-channel -source split, and the channel-invariant curvature sharing - overview_2_new_user_guide.md: add a Data Cubes entry to the dataset-type routing list No API change; there is deliberately no cube dataset type to document. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015zxc8vHNQ6FPqsRJaT8tGk
1 parent 5e7e2b4 commit 080c52e

2 files changed

Lines changed: 19 additions & 0 deletions

File tree

docs/overview/overview_2_new_user_guide.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ interested in:
5252

5353
- **CDD Imaging**: For image data from telescopes like Hubble and James Webb, go to [imaging/start_here.ipynb](https://github.com/PyAutoLabs/autolens_workspace/blob/main/notebooks/imaging/start_here.ipynb).
5454
- **Interferometer**: For radio / sub-mm interferometer from instruments like ALMA, go to [interferometer/start_here.ipynb](https://github.com/PyAutoLabs/autolens_workspace/blob/main/notebooks/interferometer/start_here.ipynb).
55+
- **Data Cubes**: For spectral-line data cubes (e.g. ALMA CO cubes), where many frequency channels are fitted simultaneously with a shared lens model, go to [interferometer/features/datacube/start_here.ipynb](https://github.com/PyAutoLabs/autolens_workspace/blob/main/notebooks/interferometer/features/datacube/start_here.ipynb).
5556
- **Point Sources**: For strongly lensed point sources (e.g. lensed quasars, supernovae), go to [point_source/start_here.ipynb](https://github.com/PyAutoLabs/autolens_workspace/blob/main/notebooks/point_source/start_here.ipynb).
5657

5758
## Google Colab

docs/overview/overview_3_features.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ links to the relevant workspace examples.
1313

1414
**Interferometry**: Modeling of interferometer data (e.g. ALMA, LOFAR) directly in the uv-plane.
1515

16+
**Data Cubes**: Modeling spectral-line data cubes (e.g. ALMA CO cubes), fitting every channel simultaneously with a shared lens model.
17+
1618
**Multi Gaussian Expansion (MGE)**: Decomposing the lens galaxy into hundreds of Gaussians, for a clean lens subtraction.
1719

1820
**Groups**: Modeling group-scale strong lenses with multiple lens galaxies and multiple source galaxies.
@@ -103,6 +105,22 @@ such as correlated noise. This uses the non-uniform fast fourier transform algor
103105

104106
Checkout the `autolens_workspace/*/interferometer` package to get started.
105107

108+
## Data Cubes
109+
110+
Spectral-line observations produce a data cube: the same field observed in many adjacent frequency channels, so that
111+
the source's emission-line kinematics can be studied alongside the lens model.
112+
113+
A cube is modeled as a list of `Interferometer` datasets, one per channel, combined into a single fit with
114+
`af.FactorGraphModel`. Every channel shares one lens mass model, while each channel reconstructs its own source, so
115+
the lens is constrained by the whole cube simultaneously rather than channel by channel. There is no separate cube
116+
dataset type to learn — the existing `Interferometer` and `AnalysisInterferometer` objects are reused throughout.
117+
118+
Channel-invariant quantities (the lensing operator's curvature matrix) are computed once and shared across channels
119+
rather than rebuilt per channel, which is what makes fitting a many-channel cube tractable.
120+
121+
Checkout the `autolens_workspace/*/interferometer/features/datacube` package to get started, which includes a
122+
`data_preparation` example covering the conversion from a CASA-style 4D FITS cube to the inputs the fit expects.
123+
106124
## Multi Gaussian Expansion (MGE)
107125

108126
An MGE decomposes the light of a galaxy into tens or hundreds of two dimensional Gaussians:

0 commit comments

Comments
 (0)