Description in the docstrings and tutorial about the inclination conv…

…ention
tomasstolker · Apr 9, 2021 · 98ef71d · 98ef71d
1 parent 73f4019
commit 98ef71d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 5 deletions.
diff --git a/diskmap/diskmap.py b/diskmap/diskmap.py
@@ -33,15 +33,20 @@ def __init__(self,
         fitsfile : str
             FITS file with the scattered light image.
         pixscale : float
-            Pixel scale (arcsec per pixel).
+            Pixel scale of the image (arcsec per pixel).
         inclination : float
-            Inclination of the disk (deg). Include a minus sign to exchange the near and far side
-            with the mapping of the disk.
+            Inclination of the disk (deg). The convention is such that the near side of the
+            disk is on the right side of the image when using an inclination between 0 and 90 deg
+            and using a `pos_angle` of 0 deg. The near and far side of the disk mapping can be
+            exchanged by using a minus sign for the inclination. To be certain about using the
+            correct near and far side, it is best to check the `_radius.fits` file with a somewhat
+            large inclination. The near side will show more strongly compressed radii compared to
+            the far side of the disk.
         pos_angle : float
             Position angle of the disk (deg). Defined in counterclockwise direction with respect
             to the vertical axis (i.e. east of north).
         distance : float
-            Distance (pc).
+            Distance between observer and star (pc).
         image_type : str
             Image type ('polarized' or 'total'). This parameter affects the output that will be
             stored. For example, the conversion from polarized to total intensity phase function

diff --git a/docs/tutorial.ipynb b/docs/tutorial.ipynb
@@ -136,7 +136,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "We will now create an instance of `DiskMap` by providing the FITS filename, the pixel scale of the IRDIS detector (12.25 mas), the inclination (50 deg) and position angle (90 deg) of the disk, the distance (160 pc), and the image type (polarized flux)."
+    "We will now create an instance of `DiskMap` by providing the FITS filename, the pixel scale of the IRDIS detector (12.25 mas), the inclination (50 deg) and position angle (90 deg) of the disk, the distance (160 pc), and the image type (polarized flux)..\n",
+    "\n",
+    "The inclination convention is such that the near side is located on the right side of the image when using an inclination between 0 and 90 deg and a position angle of 0 deg. Therefore, with an position angle of 90 deg, the near side will be in upward direction of the image, as we will also see later in the `_radius.fits` file."
    ]
   },
   {