radial_fig: docs API formatting

MPoL-dev · Dec 10, 2023 · 453b6e6 · 453b6e6
1 parent 294dfd5
commit 453b6e6
Showing 1 changed file with 19 additions and 18 deletions.
diff --git a/src/mpol/plot.py b/src/mpol/plot.py
@@ -888,30 +888,31 @@ def radial_fig(model, geom, u=None, v=None, V=None, weights=None, dist=None,
                channel=0, save_prefix=None):
     """
     Figure for analysis of 1D (radial) brightness profile of MPoL model image,
-    using a user-supplied geometry. Plots:
-    - MPoL model image
-    - 1D (radial) brightness profile extracted from MPoL image 
-      (supply `dist` to show second x-axis in [AU])
-    - Deprojectd Re(V): binned MPoL model and observations (if u, v, V, weights supplied)
-    - Deprojected Im(V): binned MPoL model and observations (if u, v, V, weights supplied)
+    using a user-supplied geometry. 
+    
+    Plots:
+        - MPoL model image
+        - 1D (radial) brightness profile extracted from MPoL image (supply `dist` to show second x-axis in [AU])
+        - Deprojectd Re(V): binned MPoL model and observations (if u, v, V, weights supplied)
+        - Deprojected Im(V): binned MPoL model and observations (if u, v, V, weights supplied)
 
     Parameters
     ----------
     model : `torch.nn.Module` object
         A neural network; instance of the `mpol.precomposed.SimpleNet` class.
     geom : dict
         Dictionary of source geometry. Used to deproject image and visibilities.
-        Keys:
-            "incl" : float, unit=[deg]
-                Inclination 
-            "Omega" : float, unit=[deg]
-                Position angle of the ascending node 
-            "omega" : float, unit=[deg]
-                Argument of periastron
-            "dRA" : float, unit=[arcsec]
-                Phase center offset in right ascension. Positive is west of north.
-            "dDec" : float, unit=[arcsec]
-                Phase center offset in declination.
+            Keys:
+                "incl" : float, unit=[deg]
+                    Inclination 
+                "Omega" : float, unit=[deg]
+                    Position angle of the ascending node 
+                "omega" : float, unit=[deg]
+                    Argument of periastron
+                "dRA" : float, unit=[arcsec]
+                    Phase center offset in right ascension. Positive is west of north.
+                "dDec" : float, unit=[arcsec]
+                    Phase center offset in declination.
     u, v : array, optional, unit=[k\lambda], default=None
         Data u- and v-coordinates
     V : array, optional, unit=[Jy], default=None
@@ -925,7 +926,7 @@ def radial_fig(model, geom, u=None, v=None, V=None, weights=None, dist=None,
         for the difference between the inclined (observed) brightness and the 
         assumed face-on brightness, assuming the emission is optically thick. 
         The source's integrated (2D) flux is assumed to be:
-            :math:`F = \cos(i) \int_r^{r=R}{I(r) 2 \pi r dr}`.
+        :math:`F = \cos(i) \int_r^{r=R}{I(r) 2 \pi r dr}`.
         No rescaling would be appropriate in the optically thin limit.                 
     bin_width : float, default=20e3
         Bin size [klambda] in which to bin observed visibility points