OV-GSO-DC / dustem-wrapper_idl

Commit 0b1568352f4db5e246a58fefd8b56a4b1f4db319

Authored by Annie Hughes
1 parent 2d758fdd
Exists in master

improved inline doc help

Showing 3 changed files with 21 additions and 8 deletions   Show diff stats
Inline Side-by-side
src/idl/dustem_compute_ext.pro
  Diff comments   View file @0b15683
1 1 FUNCTION dustem_compute_ext,p_dim,$
2   - st=st,$
3   - EXT_spec=EXT_spec,$
4   - help=help
  2 + st=st,$
  3 + EXT_spec=EXT_spec,$
  4 + help=help
5 5 ;+
6 6 ; NAME:
7 7 ; dustem_compute_ext
... ... @@ -38,7 +38,6 @@ FUNCTION dustem_compute_ext,p_dim,$
38 38 ; The DustEMWrap IDL code must be installed
39 39 ;
40 40 ; MODIFICATION HISTORY:
41   -; Written ?
42 41 ; Evolution details on the DustEMWrap gitlab
43 42 ; See http://dustemwrap.irap.omp.eu/ for FAQ and help.
44 43 ;-
... ...
src/idl/dustem_compute_sed.pro
  Diff comments   View file @0b15683
1 1 FUNCTION dustem_compute_sed,p_dim,$
2 2 st=st,$
3   - SED_spec=SED_spec, $
  3 + sed_spec=sed_spec, $
4 4 help=help
5 5  
6 6 ;+
... ...
src/idl/dustem_compute_stokext.pro
  Diff comments   View file @0b15683
... ... @@ -10,42 +10,56 @@ FUNCTION dustem_compute_stokext,p_dim,$
10 10 ;+
11 11 ; NAME:
12 12 ; dustem_compute_stokext
  13 +;
13 14 ; PURPOSE:
14 15 ; Computes Stokes Parmeters extinction in units of optical depth for a given Dustem spectrum
  16 +;
15 17 ; CATEGORY:
16 18 ; Dustem
  19 +;
17 20 ; CALLING SEQUENCE:
18 21 ; out=dustem_compute_stokext(p_dim[,st=][,QEXT_spec=QEXT_spec][,UEXT_spec=UEXT_spec][,PSIEXT_spec=PSIEXT_spec][,dustem_psi_ext=dustem_psi_ext][,/help])
  22 +;
19 23 ; INPUTS:
20 24 ; p_dim = parameter values
  25 +;
21 26 ; OPTIONAL INPUT PARAMETERS:
22 27 ; st = Dustem structure
  28 +;
23 29 ; OUTPUTS:
24 30 ; out = List Containing the Stokes parameters extinction for spectrum points in !dustem_data
25 31 ; out[0] = Computed Stokes Q extinction for spectrum points in !dustem_data
26 32 ; out[1] = Computed Stokes U extinction for spectrum points in !dustem_data
  33 +;
27 34 ; OPTIONAL OUTPUT PARAMETERS:
28 35 ; st = Dustem output structure
29 36 ; QEXT_spec = Dustem Stokes Q extinction
30 37 ; UEXT_spec = Dustem Stokes U extinction
31 38 ; PSIEXT_spec = Dustem Polarization angle output in extinction
32 39 ; dustem_psi_ext = Computed Polarization angle ouput for spectrum points in !dustem_data
  40 +;
33 41 ; ACCEPTED KEY-WORDS:
34 42 ; help = If set, print this help
  43 +;
35 44 ; COMMON BLOCKS:
36 45 ; None
  46 +;
37 47 ; SIDE EFFECTS:
38 48 ; None
  49 +;
39 50 ; RESTRICTIONS:
40 51 ; The dustem idl wrapper must be installed
  52 +;
41 53 ; PROCEDURE:
42 54 ; None
  55 +;
43 56 ; EXAMPLES
44 57 ;
45 58 ; MODIFICATION HISTORY:
46 59 ; Written by J.-Ph. Bernard
47   -; see evolution details on the dustem cvs maintained at CESR
48   -; Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
  60 +; Evolution details on the DustEMWrap gitlab.
  61 +; See http://dustemwrap.irap.omp.eu/ for FAQ and help.
  62 +;-
49 63  
50 64  
51 65 IF keyword_set(help) THEN BEGIN
... ... @@ -55,7 +69,7 @@ IF keyword_set(help) THEN BEGIN
55 69 ENDIF
56 70  
57 71 IF not keyword_set(st) THEN BEGIN
58   - dustem_activate_plugins,p_dim/(*(*!dustem_fit).param_init_values),st
  72 + dustem_activate_plugins,p_dim/(*(*!dustem_fit).param_init_values),st=st
59 73 ;st=dustem_run(p_dim)
60 74 ENDIF
61 75  
... ...