OV-GSO-DC / dustem-wrapper_idl

Commit 133b703334621faf6f3a06589043d162d1616160

Authored by Annie Hughes
1 parent 00dedb80
Exists in master

cosmetic changes to inline help

Showing 1 changed file with 23 additions and 7 deletions   Show diff stats
Inline Side-by-side
src/idl/dustemwrap_plot.pro
  Diff comments   View file @133b703
... ... @@ -15,14 +15,24 @@ PRO dustemwrap_plot,p_dim,st, $
15 15  
16 16 ;+
17 17 ; NAME:
  18 +; dustemwrap_plot
  19 +;
18 20 ; PURPOSE:
19   -; plots dustemwrap observed sed, predicted sed, predicted spectra for total Intensity, polarization in emission and extinction
  21 +; plots dustemwrap observed sed, predicted sed, predicted spectra for total intensity, polarization in emission and extinction
  22 +;
20 23 ; CATEGORY:
21   -; DustEMWrap
  24 +; DustEMWrap, Distributed, Plotting, Mid-Level
  25 +;
22 26 ; CALLING SEQUENCE:
23   -; dustemwrap_plot,p_dim,st,dustem_sed,SED_spec,dustem_qsed,Q_spec,dustem_used,U_spec,dustem_polsed,P_spec,dustem_polfrac,SP_spec,dustem_psi_em,PSI_spec,dustem_ext,EXT_spec,dustem_qext,QEXT_spec,dustem_uext,UEXT_spec,dustem_polext,POLEXT_spec,dustem_fpolext,SPEXT_spec,dustem_psi_ext,PSIEXT_spec,_extra=_extra
  27 +; dustemwrap_plot,p_dim,st,dustem_sed,SED_spec,dustem_qsed,Q_spec,dustem_used,U_spec $
  28 +; ,dustem_polsed,P_spec,dustem_polfrac,SP_spec,dustem_psi_em,PSI_spec $
  29 +; ,dustem_ext,EXT_spec,dustem_qext,QEXT_spec,dustem_uext,UEXT_spec $
  30 +; ,dustem_polext,POLEXT_spec,dustem_fpolext,SPEXT_spec,dustem_psi_ext,PSIEXT_spec $
  31 +; ,_extra=_extra
  32 +;
24 33 ; INPUTS:
25 34 ; p_dim
  35 +;
26 36 ; OPTIONAL INPUT PARAMETERS:
27 37 ; st
28 38 ; dustem_sed
... ... @@ -37,6 +47,7 @@ PRO dustemwrap_plot,p_dim,st, $
37 47 ; dustem_polext
38 48 ; dustem_fpolext
39 49 ; dustem_psi_ext
  50 +;
40 51 ; OUTPUTS:
41 52 ; dustem_sed
42 53 ; dustem_qsed
... ... @@ -62,24 +73,30 @@ PRO dustemwrap_plot,p_dim,st, $
62 73 ; POLEXT_spec
63 74 ; SPEXT_spec
64 75 ; PSIEXT_spec
  76 +;
65 77 ; OPTIONAL OUTPUT PARAMETERS:
66 78 ;
67 79 ; ACCEPTED KEY-WORDS:
68 80 ; help
  81 +;
69 82 ; COMMON BLOCKS:
70 83 ; None
  84 +;
71 85 ; SIDE EFFECTS:
72   -; Does a plot
  86 +; Generates plots!
  87 +;
73 88 ; RESTRICTIONS:
74 89 ; The DustEM fortran code must be installed
75 90 ; The DustEMWrap IDL code must be installed
  91 +;
76 92 ; PROCEDURES AND SUBROUTINES USED:
77 93 ;
78   -; EXAMPLES
  94 +; EXAMPLES:
79 95 ;
80 96 ; MODIFICATION HISTORY:
81   -; Written by Ilyes Choubani
  97 +; Written by Ilyes Choubani 2022
82 98 ; Evolution details on the DustEMWrap gitlab.
  99 +; See http://dustemwrap.irap.omp.eu/ for FAQ and help.
83 100 ;-
84 101  
85 102 IF keyword_set(help) THEN BEGIN
... ... @@ -104,7 +121,6 @@ IF not keyword_set(st) THEN BEGIN
104 121 toto = dustem_compute_stokes(p_dim,st=st,Q_spec=Q_spec,U_spec=U_spec,PSI_spec=PSI_spec,dustem_psi_em=dustem_psi_em)
105 122 dustem_qsed = toto[0]
106 123 dustem_used = toto[1]
107   - ;stop
108 124  
109 125 endif
110 126 endif
... ...