OV-GSO-DC / dustem-wrapper_idl

Commit ebbb68b18fd801e5d1b1ec3a69acef340d44decf

Authored by Jean-Philippe Bernard
1 parent e08591fe
Exists in master

improved the help

Showing 1 changed file with 9 additions and 25 deletions   Show diff stats
Inline Side-by-side
src/idl/dustem_set_data.pro
  Diff comments   View file @ebbb68b
1   -PRO dustem_set_data,m_fit,m_show,x_fit,x_show,rchi2_weight=rchi2_weight,f_HI=f_HI,help=help;,nocheck_data=nocheck_data
  1 +PRO dustem_set_data,m_fit,m_show,x_fit,x_show,rchi2_weight=rchi2_weight,f_HI=f_HI,help=help
2 2  
3 3 ;+
4 4 ; NAME:
5 5 ; dustem_set_data
6   -;
7 6 ; PURPOSE:
8   -; ## adapting the data structures to the format used by the fitting algorithm
9 7 ; Initializes the dustem data structure (*!dustem_data) used in the fitting
10 8 ; Initializes the !dustem_show structure which is either a copy or a more detailed version of !dustem_data
11   -;
12 9 ; CATEGORY:
13 10 ; DustEMWrap, Mid-Level, Distributed, Initialization
14   -;
15 11 ; CALLING SEQUENCE:
16   -; dustem_set_data(m_fit,x_fit,m_show,x_show,[/help])
17   -;
  12 +; dustem_set_data[,m_fit,x_fit][,m_show,x_show][,rchi2_weight=][,f_HI=][,/help]
18 13 ; INPUTS:
19   -; ## used in initializing !dustem_data
  14 +; None
  15 +; OPTIONAL INPUT PARAMETERS:
20 16 ; m_fit : dustemwrap structure contaning emission data to be fitted
21 17 ; x_fit : dustemwrap structure containing extinction data to be fitted
22   -; ## used in initializing !dustem_show
23 18 ; m_show : dustemwrap structure containing emission data to be displayed
24 19 ; x_show : dustemwrap structure containing extinctiond data to be displayed
25   -;
26   -; OPTIONAL INPUT PARAMETERS:
27   -; None
28   -;
  20 +; rchi2_weight : dustemwrap structure containing the wieghts for chi2 calculation
  21 +; f_HI : multiplicative factor for the SED values (extinction and emission)
29 22 ; OUTPUTS:
30 23 ; None
31   -;
32 24 ; OPTIONAL OUTPUT PARAMETERS:
33 25 ; None
34   -;
35 26 ; ACCEPTED KEY-WORDS:
36 27 ; help = If set print this help
37   -;
38 28 ; COMMON BLOCKS:
39 29 ; None
40   -;
41 30 ; SIDE EFFECTS:
42   -; initializes !dustem_data/!dustem_show
43   -; wavelengths are forced to be the central filter wavelength for
44   -; photometric data
45   -;
  31 +; initializes !dustem_data and !dustem_show
  32 +; wavelengths are forced to be the central filter wavelength for photometric data
46 33 ; RESTRICTIONS:
47 34 ; The dustem idl wrapper must be installed
48   -;
49 35 ; PROCEDURE:
50 36 ; None
51   -;
52 37 ; EXAMPLES
53 38 ; dustem_init
54 39 ; dir=!dustem_wrap_soft_dir+'/Data/EXAMPLE_OBSDATA/'
55 40 ; file=dir+'example_SED_1.xcat'
56 41 ; spec=read_xcat(file,/silent)
57   -; var = dustem_set_data(spec,x_fit,spec,x_show)
  42 +; dustem_set_data,spec,x_fit,spec,x_show)
58 43 ; #in this example !dustem_data and !dustem_show are identical
59   -;
60 44 ; MODIFICATION HISTORY:
61 45 ; Written by J.-Ph. Bernard 2007
62 46 ; V. Guillet (2012) : dustem_set_data is turned into a function which can be used
... ...