Skip to content

Commit

Permalink
Updated parameter description about the inclination convention
Browse files Browse the repository at this point in the history
  • Loading branch information
tomasstolker committed Apr 9, 2021
1 parent 73f4019 commit d2b9432
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions diskmap/diskmap.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit d2b9432

Please sign in to comment.