Skip to content

Commit 285497b

Browse files
committed
Added directory to documentation
1 parent a737687 commit 285497b

4 files changed

Lines changed: 106 additions & 7 deletions

File tree

‎docs/ARL_dask.rst‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,6 @@ page. Below is a snapshot of the diagnostic page when dask is calculating an ima
4545
.. image:: partial.png
4646
:width: 1024px
4747

48-
Below we demonstrate the utility of this view. This shows ICAL for 7 visibility ingests. Note the global
49-
synchronisation point (at 1:40) where the selfcalibration across the full bandwidth occurs.
50-
51-
.. image:: dask-global.png
52-
:width: 1024px
5348

5449
Using ARL and dask on Darwin
5550
****************************

‎docs/ARL_directory.rst‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
.. toctree::
2+
:maxdepth: 2
3+
4+
ARL directory
5+
*************
6+
7+
A simple directory to help those familiar with other calibration and imaging packages navigate the Algorithm Reference
8+
Library.
9+
10+
See also the :ref:`genindex` and :ref:`modindex`
11+
12+
13+
Data containers used by ARL
14+
===========================
15+
16+
See :py:mod:`arl.data.data_models.py` for the following definitions:`
17+
18+
* Telescope Configuration: :py:class:`arl.data.data_models.Configuration`
19+
* GainTable for gain solutions (as (e.g. output from solve_gaintable): :py:class:`arl.data.data_models.GainTable`
20+
* Image (data and WCS header): :py:class:`arl.data.data_models.Image`
21+
* Skycomponent ((data for a point source or a Gaussian source): :py:class:`arl.data.data_models.Skycomponent`
22+
* Baseline based visibility tables shape (npol,), length nvis) :py:class:`arl.data.data_models.Visibility`
23+
* Antenna-based visibility table, shape (nants, nants, nchan, npol), length ntimes): :py:class:`arl.data.data_models.BlockVisibility`
24+
25+
Create empty data set for observation (a-la makeMS)
26+
===================================================
27+
28+
* For Visibility operations: :py:mod:`arl.visibility.base.create_visibility`
29+
* For BlockVisibility: :py:mod:`arl.visibility.base.create_blockvisibility`
30+
31+
Gridding, degridding and weighting
32+
==================================
33+
34+
* Convolutional gridding: :py:mod:`arl.fourier_transforms.convolutional_gridding.convolutional_grid`
35+
* Convolutional degridding: :py:mod:`arl.fourier_transforms.convolutional_gridding.convolutional_degrid`
36+
* Weighting: :py:mod:`arl.fourier_transforms.convolutional_gridding.weight_gridding`
37+
* Tapering: TBD
38+
39+
Visibility Predict
40+
==================
41+
42+
* Predict BlockVisibility for Skycomponent :py:mod:`arl.imaging.base.predict_skycomponent_blockvisibility`
43+
* Predict Visibility for Skycomponent: :py:mod:`arl.imaging.base.predict_skycomponent_visibility`
44+
* Predict by de-gridding visibilities:
45+
46+
* :py:mod:`arl.imaging.base.predict_2d_base`
47+
* :py:mod:`arl.imaging.base.predict_2d`
48+
* :py:mod:`arl.imaging.base.predict_wstack`
49+
* :py:mod:`arl.imaging.base.predict_wprojection`
50+
* :py:mod:`arl.imaging.base.predict_timeslice`
51+
* :py:mod:`arl.imaging.base.predict_facets`
52+
* :py:mod:`arl.imaging.base.predict_facets_wprojection`
53+
* :py:mod:`arl.imaging.base.predict_facets_wstack`
54+
* :py:mod:`arl.imaging.base.predict_wprojection_wstack`
55+
56+
57+
Visibility Invert
58+
=================
59+
60+
* Generate gridding kernels (standard prolate spheroidal or W-projection): :py:mod:`arl.imaging.params.get_kernel_list`
61+
* Invert by gridding visibilities:
62+
63+
* Predict by de-gridding visibilities:
64+
65+
* :py:mod:`arl.imaging.base.invert_2d_base`
66+
* :py:mod:`arl.imaging.base.invert_2d`
67+
* :py:mod:`arl.imaging.base.invert_wstack`
68+
* :py:mod:`arl.imaging.base.invert_wprojection`
69+
* :py:mod:`arl.imaging.base.invert_timeslice`
70+
* :py:mod:`arl.imaging.base.invert_facets`
71+
* :py:mod:`arl.imaging.base.invert_facets_wprojection`
72+
* :py:mod:`arl.imaging.base.invert_facets_wstack`
73+
* :py:mod:`arl.imaging.base.invert_wprojection_wstack`
74+
75+
Deconvolution
76+
=============
77+
78+
* Hogbom Clean: :py:mod:`arl.image.cleaners.hogbom`
79+
* Multi-scale Clean: :py:mod:`arl.image.cleaners.msclean`
80+
* Multi-scale multi-frequency Clean: :py:mod:`arl.image.cleaners.msmfsclean`
81+
* Entry point for above: :py:mod:`arl.image.deconvolution.deconvolve_cube`
82+
83+
Calibration
84+
===========
85+
86+
* Create empty gain table: :py:mod:`arl.calibration.operations.create_gaintable_from_blockvisibility`
87+
* Solve for complex gains: :py:mod:`arl.calibration.solvers.solve_gaintable`
88+
* Apply complex gains: :py:mod:`arl.calibration.operations.apply_gaintable`
89+
* Peel compact sources: :py:mod:`arl.calibration.peeling.peel_skycomponent_blockvisibility`
90+
91+
Coordinate transforms
92+
=====================
93+
94+
* Station/baseline (XYZ <-> UVW): :py:mod:`arl.util.coordinate_support`
95+
* Source (spherical -> tangent plane): :py:mod:`arl.util.coordinate_support`
96+
* Phase rotation: :py:mod:`arl.visibility.base.phaserotate_visibility`
97+
* Polarisation basis conversion (Linear <-> Stokes <-> Circular): :py:mod:`arl.data.polarisation`
98+
99+
Graphs:
100+
=======
101+
102+
* Perform various types of prediction and inversion of visibility data: :py:mod:`arl.graphs.graphs`
103+
* Perform generic image or visibility unary operations: :py:mod:`arl.graphs.generic_graphs`
104+
* Support testing and simulations: :py:mod:`arl.util.graph_support`
105+
* The canonical pipelines:py:mod:`arl.pipelines.graphs`:

‎docs/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ structures such as image, visibility table, gaintable, etc.
1313
:maxdepth: 3
1414

1515
ARL_quickstart
16+
ARL_directory
1617
ARL_definition
1718
ARL_background
1819
ARL_developing
1920
ARL_Fourier_processing
2021
ARL_calibration
2122
ARL_dask
2223
ARL_references
23-
ARL_glossary
2424

2525
Indices and tables
2626
==================

‎tests/test_graphs.py‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,6 @@ def test_predict_facet_wstack_graph(self):
173173
predicted_vis_graph_list = create_predict_facet_wstack_graph(zero_vis_graph_list, flux_model_graph,
174174
facets=2, vis_slices=self.vis_slices)
175175
residual_vis_graph_list = create_subtract_vis_graph_list(self.vis_graph_list, predicted_vis_graph_list)
176-
self.compute=True
177176
if self.compute:
178177
qa = qa_visibility(self.vis_graph_list[0].compute())
179178
numpy.testing.assert_almost_equal(qa.data['maxabs'], 1600.0, 0)

0 commit comments

Comments
 (0)