OV-GSO-DC / dustem-wrapper_idl

Commit 67dbbf5c2f4369b904ef1292cfbe25c3fae194fe

Authored by Annie Hughes
1 parent 4002e6fa
Exists in master

updated help

Showing 1 changed file with 19 additions and 3 deletions   Show diff stats
Inline Side-by-side
src/idl/dustem_compute_polext.pro
  Diff comments   View file @67dbbf5
... ... @@ -9,32 +9,48 @@ FUNCTION dustem_compute_polext,p_dim,$
9 9 ;+
10 10 ; NAME:
11 11 ; dustem_compute_polext
  12 +;
12 13 ; PURPOSE:
13 14 ; Computes Polarized Extinction in units of optical depth for a given Dustem spectrum
  15 +;
14 16 ; CATEGORY:
15   -; Dustem
  17 +; Dustem, Distributed,
  18 +;
16 19 ; CALLING SEQUENCE:
17 20 ; polext=dustem_compute_polext(p_dim[,st=][,polext_spec=][,spext_spec=][,dustem_fpolext=][,dustem_ext=][,/help])
  21 +;
18 22 ; INPUTS:
19 23 ; p_dim = parameter values
  24 +;
20 25 ; OPTIONAL INPUT PARAMETERS:
21 26 ; st = Dustem output structure
22 27 ; dustem_ext = Computed polarized extinction for spectrum points in !dustem_data
  28 +;
23 29 ; OUTPUTS:
24 30 ; polext = computed Polarized Extinction for spectrum points in !dustem_data
  31 +;
25 32 ; OPTIONAL OUTPUT PARAMETERS:
26 33 ; st = Dustem output structure
27 34 ; polext_spec = Dustem polarized extiction output
28 35 ; spext_spec = Dustem polarized exinction fraction
29 36 ; dustem_fpolext = Computed polarized extinction fraction for spectrum points in !dustem_data
  37 +;
30 38 ; ACCEPTED KEY-WORDS:
31 39 ; help = If set, print this help
  40 +;
32 41 ; COMMON BLOCKS:
33 42 ; None
  43 +;
34 44 ; SIDE EFFECTS:
35 45 ; None
  46 +;
36 47 ; RESTRICTIONS:
37   -; The dustem idl wrapper must be installed
  48 +; The DustEMWrap IDL code must be installed
  49 +;
  50 +; MODIFICATION HISTORY:
  51 +; Written by JPB,NF,DP Jan-2007
  52 +; Evolution details on the DustEMWrap gitlab.
  53 +; See http://dustemwrap.irap.omp.eu/ for FAQ and help.
38 54 ;-
39 55  
40 56  
... ... @@ -205,4 +221,4 @@ the_end:
205 221  
206 222 return, dustem_polext
207 223  
208   -END
209 224 \ No newline at end of file
  225 +END
... ...