Blame view

src/idl/dustem_stellarpopisrf_example.pro 10.1 KB
85803503   Annie Hughes   corrected proc name
1
PRO dustem_stellarpopisrf_example,model=model $
0dda35a7   Jean-Philippe Bernard   modified to inclu...
2
                                 ,sed_file=sed_file $
233b4f64   Annie Hughes   finalised ISRF ex...
3
                                 ,isrf_file=isrf_file $
0dda35a7   Jean-Philippe Bernard   modified to inclu...
4
                                 ,Nitermax=Nitermax $
e431104b   Annie Hughes   general updates f...
5
6
                                ,postscript=postscript $
                                 ,fits_save=fits_save $
0dda35a7   Jean-Philippe Bernard   modified to inclu...
7
                                 ,wait=wait $
27bec12a   Annie Hughes   tidied up help an...
8
                                 ,noobj=noobj $
0dda35a7   Jean-Philippe Bernard   modified to inclu...
9
10
                                 ,verbose=verbose $
                                 ,help=help
c9abf9b4   Ilyes Choubani   Uploading stellar...
11
12
13
14
15
16
17

;+
; NAME:
;    dustem_fit_stellarpopisrf_example  
;
; PURPOSE:
; This routine is an example of how to fit an observational SED
27bec12a   Annie Hughes   tidied up help an...
18
19
; (StokesI only) with DustEM and DustEMWrap, and an ISRF that is due
; to a user-defined population of nearby main sequence stars.
c9abf9b4   Ilyes Choubani   Uploading stellar...
20
;
27bec12a   Annie Hughes   tidied up help an...
21
22
23
24
25
26
27
28
; DustEMWrap reads information about the stellar spectral types (effective
; temperature, radius) from the EEM_dwarf_UBVIJHK_colors_Teff.txt file
; that is located in the Data/STELLARPOPS/ directory. This data file was
; authored by Prof. Erik Mamajek (see the file for more details).
;  
; For this example, we generate an SED using an input model and then
; launch the fit with a starting guess that has been shifted away from
; the true parameter values.
c9abf9b4   Ilyes Choubani   Uploading stellar...
29
30
31
32
33
;
; CATEGORY:
;    DustEMWrap, Distributed, High-Level, User Example
;
; CALLING SEQUENCE:
e431104b   Annie Hughes   general updates f...
34
;    dustem_fit_stellarpopisrf_example[,model=][sed_file=][isrf_file=][,postscript=][,Nitermax=][,fits_save=][,/help,/wait,/verbose]
c9abf9b4   Ilyes Choubani   Uploading stellar...
35
36
37
38
39
40
41
42
43
44
45
46
47
48
;
; INPUTS:
;    None
;
; OPTIONAL INPUT PARAMETERS:
;    None
;
; OUTPUTS:
;    None
;
; OPTIONAL OUTPUT PARAMETERS:
;    Plots, results structure in binary FITS table format
;
; ACCEPTED KEY-WORDS:
6735604d   Annie Hughes   making FITS read ...
49
50
51
;    model = specifies the interstellar dust mixture used by
;            DustEM. See userguide or dustem_test_model_exists.pro
;            for more details about available models in current release.
c9abf9b4   Ilyes Choubani   Uploading stellar...
52
53
54
;    sed_file = string naming the path to text file in .xcat format that
;          describes the observational SED. If not set, the file
;          'Data/EXAMPLE_OBSDATA/example_SED_2.xcat' is used.  
233b4f64   Annie Hughes   finalised ISRF ex...
55
;    isrf_file = text file describing ISRF
e431104b   Annie Hughes   general updates f...
56
;    postscript = if set, final plot is saved as postscript file
c9abf9b4   Ilyes Choubani   Uploading stellar...
57
;    Nitermax = maximum number of fit iterations. Default is 5.
e431104b   Annie Hughes   general updates f...
58
59
60
;    fits_save = if set, save the fit results in a binary
;               FITS file. 
;    postscript = if set, final plot is saved as postscript file
c9abf9b4   Ilyes Choubani   Uploading stellar...
61
62
63
64
;    help      = if set, print this help
;    wait      = if set, wait this many seconds between each step of
;                the code (for illustration purposes)
;    verbose      = if set, subroutines will run in verbose mode
27bec12a   Annie Hughes   tidied up help an...
65
;    noobj     = if set, runs with no object graphics
c9abf9b4   Ilyes Choubani   Uploading stellar...
66
67
68
69
70
71
72
73
74
75
76
77
78
;
; COMMON BLOCKS:
;    None
;
; SIDE EFFECTS:
;    None
;
; RESTRICTIONS:
;    The DustEM fortran code must be installed
;    The DustEMWrap IDL code must be installed
;
; PROCEDURES AND SUBROUTINES USED:
;    
c9abf9b4   Ilyes Choubani   Uploading stellar...
79
80
; EXAMPLES
;    dustem_fit_stellarpopisrf_example
e431104b   Annie Hughes   general updates f...
81
;    dustem_fit_stellarpopisrf_example,Nitermax=10,fits_save='/tmp/mysavefile.fits'
233b4f64   Annie Hughes   finalised ISRF ex...
82
;    dustem_fit_stellarpopisrf_example,model='DBP90',isrf_file='./myisrf_habing.dat',sed_file='./mysed.xcat'
c9abf9b4   Ilyes Choubani   Uploading stellar...
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
;
; MODIFICATION HISTORY:
;    Evolution details on the DustEMWrap gitlab.
;    See http://dustemwrap.irap.omp.eu/ for FAQ and help.  
;-


IF keyword_set(help) THEN BEGIN
  doc_library,'dustem_stellarpopisrf_example'
  goto,the_end
END

IF keyword_set(model) THEN BEGIN
  use_model=strupcase(model)
ENDIF ELSE BEGIN
233b4f64   Annie Hughes   finalised ISRF ex...
98
  use_model='DBP90'    ;Default is last dustem model
c9abf9b4   Ilyes Choubani   Uploading stellar...
99
100
ENDELSE

6735604d   Annie Hughes   making FITS read ...
101
102
103
exists=dustem_test_model_exists(use_model)
if exists eq 0 then $
   message,'Unknown dust model'
c9abf9b4   Ilyes Choubani   Uploading stellar...
104

27bec12a   Annie Hughes   tidied up help an...
105
use_polarization=0   ; initialize Dustemwrap in no polarization mode 
c9abf9b4   Ilyes Choubani   Uploading stellar...
106
107
108
109
110
111
112
113
114
use_verbose=0
if keyword_set(verbose) then use_verbose=1
use_Nitermax=5        ; maximum number of iterations for the fit
IF keyword_set(Nitermax) THEN use_Nitermax=Nitermax

dustem_define_la_common

;=== Set the (model-dependent) parameters that you want to fit
;=== Refer to the DustEM and DustEMWrap userguides for an explanation
233b4f64   Annie Hughes   finalised ISRF ex...
115
116
117
118
;=== of the different grain properties and types

;;===============================
;; example parameter initialisation 1
e431104b   Annie Hughes   general updates f...
119
120
;; Here we attempt to fit the distance to a single O7V star
;; Other ISRF contributions are fixed to ~zero
233b4f64   Annie Hughes   finalised ISRF ex...
121
122
123
124
125
126
127
128
129

pd = ['dustem_plugin_stellar_population_O7V3'];          ;distance to O7V star
true_vals =   [20]                ; true distance to the star
iv = true_vals+[4.]               ; distance we use as an initial guess

fpd=['dustem_plugin_stellar_population_O7V4' , $ ;number of O7V star (FIXED)
     '(*!dustem_params).G0'] ; Mathis field (FIXED TO ~ZERO)
fiv=[1.,1.e-12]

27bec12a   Annie Hughes   tidied up help an...
130
Npar=n_elements(pd)
233b4f64   Annie Hughes   finalised ISRF ex...
131
132
ulimed=replicate(0,Npar) & ulimed[0]=1 
ulims=replicate(0,Npar) & ulims[0]=25.
27bec12a   Annie Hughes   tidied up help an...
133
llimed=replicate(1,Npar)
233b4f64   Annie Hughes   finalised ISRF ex...
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
llims=replicate(1.e-15,Npar) & llims[0]=15.        

;;=== end example part 1
;;===============================

;; ;;===============================
;; ;;=== example parameter initialisation 2
;; ;;=== Here we aim to fit the distance to a single O7V star
;; ;;=== We also include a diffuse Habing ISRF that we generate below
;; ;;=== dustem_create_rfield

;; pd = [ 'dustem_plugin_stellar_population_O7V3' , $          ;distance to O7V star
;;      'dustem_plugin_modify_isrf_1']                         ; amplitude of user-ISRF
;; true_vals =   [20,1.]                ;  distance to the star and true Habing ISRF amplitude
;; iv = true_vals+[4.,-0.2]               ; distance and ISRF amplitude we use as initial guesses

;; fpd=['dustem_plugin_stellar_population_O7V4' , $ ;number of O7V star (FIXED)
;;      '(*!dustem_params).G0'] ; Mathis field (FIXED TO ~ZERO)
;; fiv=[1.,1.e-12]

;; Npar=n_elements(pd)
;; ulimed=replicate(0,Npar) & ulimed[0]=1 
;; ulims=replicate(0,Npar) & ulims[0]=25.
;; llimed=replicate(1,Npar)
;; llims=replicate(1.e-15,Npar) & llims[0]=15.        

;; mywaves=[]
;; my_isrf_file='./myisrf_habing.dat'
;; myisrf=dustem_create_rfield([0],isrf=2,fname=my_isrf_file,x=mywaves)
;; isrf_file=my_isrf_file

;; 
;;=== end example part 2
;; ;;===============================

;=== INITIALIZE DUSTEMWRAP
27bec12a   Annie Hughes   tidied up help an...
170

27bec12a   Annie Hughes   tidied up help an...
171
dustem_init,model=use_model,polarization=use_polarization
c9abf9b4   Ilyes Choubani   Uploading stellar...
172
173
174

!dustem_nocatch=1
!dustem_verbose=1
233b4f64   Annie Hughes   finalised ISRF ex...
175
IF keyword_set(noobj) THEN !dustem_noobj=1
c9abf9b4   Ilyes Choubani   Uploading stellar...
176

233b4f64   Annie Hughes   finalised ISRF ex...
177
178
179
180
if keyword_set(isrf_file) then begin
   message,'Setting ISRF component from file: '+isrf_file,/info
   !dustem_isrf_file=ptr_new(isrf_file)
endif
c9abf9b4   Ilyes Choubani   Uploading stellar...
181

233b4f64   Annie Hughes   finalised ISRF ex...
182
;=== GENERATE DATA:
27bec12a   Annie Hughes   tidied up help an...
183
;NB: HERE WE ARE READING AN SED FILE JUST TO SET-UP THE SED STRUCTURE
233b4f64   Annie Hughes   finalised ISRF ex...
184
185
;AND FILTERS. WE REPLACE THE STOKES I and STOKES I UNCERTAINTY VALUES
;LATER USING THE MODEL ITSELF
c9abf9b4   Ilyes Choubani   Uploading stellar...
186
dir=!dustem_wrap_soft_dir+'/Data/EXAMPLE_OBSDATA/'
27bec12a   Annie Hughes   tidied up help an...
187
file=dir+'example_SED_1.xcat'
0dda35a7   Jean-Philippe Bernard   modified to inclu...
188
IF keyword_set(sed_file) THEN file=sed_file
c9abf9b4   Ilyes Choubani   Uploading stellar...
189
190
191
192
193
194
195
sed=read_xcat(file,/silent)

if keyword_set(wait) then begin
   message,'Finished reading SED data: '+file,/info
   wait,wait
end

c9abf9b4   Ilyes Choubani   Uploading stellar...
196
;=== initializing IQU and associated errors to avoid problems when checking SED in dustem_set_data.pro
c9abf9b4   Ilyes Choubani   Uploading stellar...
197
198
199
for i=4l,n_tags(sed)-1 do begin
    sed.(i) = sed.sigmaii
endfor
88872c38   Ilyes Choubani   small update. Cha...
200
dustem_set_data,m_fit=sed,m_show=sed
c9abf9b4   Ilyes Choubani   Uploading stellar...
201

233b4f64   Annie Hughes   finalised ISRF ex...
202
203
;;== SET INITIAL VALUES AND LIMITS OF THE PARAMETERS THAT WILL BE
;;== ADJUSTED DURING THE FIT
c9abf9b4   Ilyes Choubani   Uploading stellar...
204
205
dustem_init_params,use_model,pd,iv,fpd=fpd,fiv=fiv,ulimed=ulimed,llimed=llimed,ulims=ulims,llims=llims

233b4f64   Annie Hughes   finalised ISRF ex...
206
207
208
;=== Generate the emission data using the dust model
sed.StokesI = dustem_compute_sed(true_vals,st=st)
sed.SigmaII = sed.StokesI*0.01
c9abf9b4   Ilyes Choubani   Uploading stellar...
209
210

;== SET THE OBSERVATIONAL STRUCTURE
e431104b   Annie Hughes   general updates f...
211
dustem_set_data, m_fit=sed, m_show=sed
c9abf9b4   Ilyes Choubani   Uploading stellar...
212
213
214
215
216
217
218
219


if keyword_set(wait) then begin
   message,'Finished initializing DustEMWrap, including plugins and fixed parameters',/info
   wait,wait
end

;== RUN THE FIT
233b4f64   Annie Hughes   finalised ISRF ex...
220
tol=1.e-16
c9abf9b4   Ilyes Choubani   Uploading stellar...
221
222
223
224
225

xr_m = [1.,5e5]
yr_m = [5e-8,1.00e6]


e431104b   Annie Hughes   general updates f...
226
tit='FIT WITH STELLAR POP ISRF EXAMPLE'
c9abf9b4   Ilyes Choubani   Uploading stellar...
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
ytit=textoidl('I_\nu (MJy/sr) for N_H=10^{20} H/cm^2')
xtit=textoidl('\lambda (\mum)')
;Set show_plot to 0 to hide plot
;Commented or set to 1 is the same since !dustem_show_plot (existing sysvar) is initialized to 1 in dustem_init
;show_plot = 0 
t1=systime(0,/sec)
res=dustem_mpfit_data(tol=tol,Nitermax=use_Nitermax,gtol=gtol $
                      ,/xlog,/ylog,xr_m=xr_m,yr_m=yr_m,xtit=xtit,ytit=ytit,title=tit $
                      ,legend_xpos=legend_xpos,legend_ypos=legend_ypos $
                      ,errors=errors,chi2=chi2,rchi2=rchi2,show_plot=show_plot)
t2=systime(0,/sec)


if keyword_set(wait) then begin
   message,'Finished running DustEMWrap, using Niters: '+strtrim(string(use_Nitermax),2),/info
   message,'Time taken [sec]: '+sigfig(t2-t1,2,/sci),/info
   wait,wait
end


e431104b   Annie Hughes   general updates f...
247
248
249
250
251
252
253
254
255
256
;=== MAKE THE FINAL PLOT
IF keyword_set(postscript) THEN BEGIN
;    dir_ps='./'
    mydevice=!d.name
    set_plot,'PS'
;    ps_file=dir_ps+postscript
    ps_file=postscript
    device,filename=ps_file,/color
ENDIF

c9abf9b4   Ilyes Choubani   Uploading stellar...
257
IF !dustem_noobj THEN BEGIN
e431104b   Annie Hughes   general updates f...
258
  dustemwrap_plot_noobj,*(*!dustem_fit).CURRENT_PARAM_VALUES,st=dummy,xr=xr,/xstyle,yr=yr,/ysty,/ylog,/xlog,title=tit+' (Final fit)'
c9abf9b4   Ilyes Choubani   Uploading stellar...
259
 ENDIF ELSE BEGIN
e431104b   Annie Hughes   general updates f...
260
  dustemwrap_plot,*(*!dustem_fit).CURRENT_PARAM_VALUES,st=dummy,xr=xr,/xstyle,yr=yr,/ysty,/ylog,/xlog,title=tit+' (Final fit)'
c9abf9b4   Ilyes Choubani   Uploading stellar...
261
262
ENDELSE

e431104b   Annie Hughes   general updates f...
263
264
265
266
267
268
269
270
 
IF keyword_set(postscript) THEN BEGIN
  device,/close
  set_plot,mydevice
  message,'Wrote '+ps_file,/info
ENDIF


c9abf9b4   Ilyes Choubani   Uploading stellar...
271
272
273
274
275
if keyword_set(wait) then begin
   message,'Made the plot of the final results',/info
   wait,wait
end

e431104b   Annie Hughes   general updates f...
276
277
278
IF keyword_set(fits_save) THEN BEGIN
   message,'Writing out results structure: '+fits_save,/info
   dustem_write_fits_table,filename=fits_save,help=help
c9abf9b4   Ilyes Choubani   Uploading stellar...
279
280
;=== At this point, you could erase all dustem system variables, or exit idl... all the
;=== information needed to recover the results and remake the plots has been saved in the FITS table
e431104b   Annie Hughes   general updates f...
281
282
283
284
285
286
287
288
289
290

;; moved the following to dustem_fitsio_example.pro
   ;; dustem_read_fits_table,filename=fits_save,dustem_st=dustem_spectra_st
  ;; ;==== plot result taken from the saved fits table
  ;; res=*(*!dustem_fit).CURRENT_PARAM_VALUES
  ;; IF !dustem_noobj THEN BEGIN
  ;;   dustemwrap_plot_noobj,res,dustem_spectra_st,xr=xr,/xstyle,yr=yr,/ysty,/ylog,/xlog,title=tit+' (From Saved FITS file)'
  ;; ENDIF ELSE BEGIN
  ;;   dustemwrap_plot,res,dustem_spectra_st,xr=xr,/xstyle,yr=yr,/ysty,/ylog,/xlog,title=tit+' (From Saved FITS file)'
  ;; ENDELSE
c9abf9b4   Ilyes Choubani   Uploading stellar...
291
  IF keyword_set(wait) THEN BEGIN
e431104b   Annie Hughes   general updates f...
292
     message,'Saved the results as FITS in the file: '+fits_save+', and made a plot using the data in this file',/info
c9abf9b4   Ilyes Choubani   Uploading stellar...
293
294
295
296
     wait,wait
  ENDIF
ENDIF

27bec12a   Annie Hughes   tidied up help an...
297
message,'Finished dustem_stellarpopisrf_example',/info
c9abf9b4   Ilyes Choubani   Uploading stellar...
298
299
300
301
302


the_end:

END