OV-GSO-DC / dustem-wrapper_idl

Commit 57cdd9918b8685d76db047bc9fa99ce4b2867424

Authored by Ilyes Choubani
1 parent 07a51917
Exists in master

updating sections for activate_plugins and run_plugins procedures

Showing 2 changed files with 52 additions and 18 deletions   Show diff stats
Inline Side-by-side
src/idl/dustem_activate_plugins.pro
  Diff comments   View file @57cdd99
1   -PRO dustem_activate_plugins,p_min,help=help,st
  1 +PRO dustem_activate_plugins,p_min,st=st,help=help
2 2  
3 3 ;+
4 4 ; NAME:
... ... @@ -8,16 +8,14 @@ PRO dustem_activate_plugins,p_min,help=help,st
8 8 ; CATEGORY:
9 9 ; DUSTEM Wrapper, Distributed, Mid-Level, Plugins
10 10 ; CALLING SEQUENCE:
11   -; dustem_activate_plugins,p_min (p_min is the dustem_mpfitfun output)
  11 +; dustem_activate_plugins,p_dim[,st][,/help]
12 12 ; INPUTS:
13   -; parameter desription vector
  13 +; p_min = (parameter values)/(initial parameter values)
14 14 ; OPTIONAL INPUT PARAMETERS:
15   -; key = input parameter number
16   -; val = input parameter value
17 15 ; OUTPUTS:
18 16 ; None
19 17 ; OPTIONAL OUTPUT PARAMETERS:
20   -; None
  18 +; st = Dustem output structure
21 19 ; ACCEPTED KEY-WORDS:
22 20 ; help = if set, print this help
23 21 ; COMMON BLOCKS:
... ... @@ -28,13 +26,11 @@ PRO dustem_activate_plugins,p_min,help=help,st
28 26 ; The DustEM fortran code must be installed
29 27 ; The DustEMWrap idl code must be installed
30 28 ; PROCEDURES AND SUBROUTINES USED:
31   -; *** COMMENT AH --> is this really NONE? ****
32   -;
33 29 ; EXAMPLES
34   -; dustem_activate_plugins, p_min (p_min is the output of dustem_mpfitfun)
  30 +; dustem_activate_plugins, p_dim ,st=st
35 31 ;
36 32 ; MODIFICATION HISTORY:
37   -; Written by IC Apr-2022
  33 +; Written by IC
38 34 ; Evolution details on the DustEMWrap gitlab.
39 35 ; See http://dustemwrap.irap.omp.eu/ for FAQ and help.
40 36 ;-
... ... @@ -48,9 +44,6 @@ ENDIF
48 44  
49 45 p_dim = p_min * (*(*!dustem_fit).param_init_values)
50 46  
51   -;JPB: Not sure if calls to dustem_set_func_ind below are still needed.
52   -;IC: They are needed to accound for the freezing of plugin parameters because I am concatenating the parameter description vector and the fixed one.
53   -;This means that I need dustem_set_func_ind for this composite vector to know which plugins are activated (whether they have frozen parameters or not).
54 47 if isa((*!dustem_fit).fixed_param_descs) then begin
55 48 ;THIS IS USED TO ACCOUNT FOR THE FREEZING OF PLUGIN PARAMETERS
56 49  
... ... @@ -74,7 +67,7 @@ endelse
74 67  
75 68 ;PART WHERE THE PLUGINS RUN ACCORDING TO THEIR SCOPES.
76 69  
77   -;help section on the way
  70 +
78 71  
79 72 ;normal (additive) plugins come first as they can be used by other plugins
80 73 ;The ISRF plugin is next - we can always change its scope however we please to. DustEm runs here. This is with the /dustem_run keyword.
... ...
src/idl/dustem_run_plugins.pro
  Diff comments   View file @57cdd99
1   -PRO dustem_run_plugins, p_dim ,param_descs, param_values, param_func, scopes, st, avoid=avoid, dustem_run=dustem_run
2   -
3   -;HELP ON THE WAY/
4   -;
  1 +PRO dustem_run_plugins, p_dim ,$
  2 +param_descs,$
  3 +param_values,$
  4 +param_func,$
  5 +scopes,$
  6 +st=st,$
  7 +avoid=avoid,$
  8 +dustem_run=dustem_run,$
  9 +help=help
  10 +
  11 +;+
  12 +; NAME:
  13 +; dustem_run_plugins
  14 +; PURPOSE:
  15 +; runs the plugins present in the parameter description vector (pd) and the fixed parameter description vector (fpd)
  16 +; CATEGORY:
  17 +; DUSTEM Wrapper, Distributed, Mid-Level, Plugins
  18 +; CALLING SEQUENCE:
  19 +; dustem_run_plugins,p_dim,param_descs,param_values,scopes,[,st][,avoid][,dustem_run][,/help]
  20 +; INPUTS:
  21 +; p_dim = parameter values
  22 +; OPTIONAL INPUT PARAMETERS:
  23 +; avoid = scopes should be avoided
  24 +; dustem_run = Dustem should be run
  25 +; OUTPUTS:
  26 +; None
  27 +; OPTIONAL OUTPUT PARAMETERS:
  28 +; st = Dustem output structure
  29 +; ACCEPTED KEY-WORDS:
  30 +; help = if set, print this help
  31 +; COMMON BLOCKS:
  32 +; None
  33 +; SIDE EFFECTS:
  34 +; None
  35 +; RESTRICTIONS:
  36 +; The DustEM fortran code must be installed
  37 +; The DustEMWrap idl code must be installed
  38 +; PROCEDURES AND SUBROUTINES USED:
  39 +; EXAMPLES
  40 +; dustem_activate_plugins, p_min, pram_descs, param_values, param_func, scopes, st=st, avoid=avoid, dustem_run=dustem_run
  41 +; MODIFICATION HISTORY:
  42 +; Written by IC
  43 +; Evolution details on the DustEMWrap gitlab.
  44 +; See http://dustemwrap.irap.omp.eu/ for FAQ and help.
  45 +;-
5 46  
6 47  
7 48  
... ...