Blame view

src/idl/dustem_stellarpopisrf_example.pro 9.42 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

;+
; NAME:
041ca6b6   Annie Hughes   updated help
14
;    dustem_stellarpopisrf_example  
c9abf9b4   Ilyes Choubani   Uploading stellar...
15
16
17
;
; 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
;
; MODIFICATION HISTORY:
;    Evolution details on the DustEMWrap gitlab.
;    See http://dustemwrap.irap.omp.eu/ for FAQ and help.  
;-

c9abf9b4   Ilyes Choubani   Uploading stellar...
89
90
91
92
93
94
95
96
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...
97
  use_model='DBP90'    ;Default is last dustem model
c9abf9b4   Ilyes Choubani   Uploading stellar...
98
99
ENDELSE

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

27bec12a   Annie Hughes   tidied up help an...
104
use_polarization=0   ; initialize Dustemwrap in no polarization mode 
c9abf9b4   Ilyes Choubani   Uploading stellar...
105
106
107
108
109
110
111
112
113
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...
114
115
116
117
;=== of the different grain properties and types

;;===============================
;; example parameter initialisation 1
e431104b   Annie Hughes   general updates f...
118
119
;; Here we attempt to fit the distance to a single O7V star
;; Other ISRF contributions are fixed to ~zero
a90f313b   Jean-Philippe Bernard   fixed with the ri...
120
121
122
;toto=dustem_plugin_stellar_population(/initialize)
scope=1
toto=dustem_plugin_stellar_population(scope=scope)
ed5da8c6   Jean-Philippe Bernard   now uses paramtag...
123
;=== get the parameter tagnames
a90f313b   Jean-Philippe Bernard   fixed with the ri...
124
paramtag=1
ed5da8c6   Jean-Philippe Bernard   now uses paramtag...
125
toto=dustem_plugin_stellar_population(paramtag=paramtag)
301168d0   Jean-Philippe Bernard   modified to new p...
126

ed5da8c6   Jean-Philippe Bernard   now uses paramtag...
127
;stop
301168d0   Jean-Philippe Bernard   modified to new p...
128
spt='O7V'
2449233a   Jean-Philippe Bernard   now uses paramtag...
129
ind1=where(paramtag EQ 'dist to '+spt,count1)
ed5da8c6   Jean-Philippe Bernard   now uses paramtag...
130
131
132
ind2=where(paramtag EQ 'N of '+spt,count2)

pd = ['dustem_plugin_stellar_population_'+strtrim(ind1+1,2)];          ;distance to O7V star
301168d0   Jean-Philippe Bernard   modified to new p...
133
134
135
true_vals =   [2.]                ; true distance to the star
iv = true_vals+[1.]               ; distance we use as an initial guess

ed5da8c6   Jean-Philippe Bernard   now uses paramtag...
136
fpd=['dustem_plugin_stellar_population_'+strtrim(ind2+1,2) , $ ;number of O7V star (FIXED)
233b4f64   Annie Hughes   finalised ISRF ex...
137
     '(*!dustem_params).G0'] ; Mathis field (FIXED TO ~ZERO)
a90f313b   Jean-Philippe Bernard   fixed with the ri...
138
139
;fiv=[1.,1.e-12]
fiv=[1.,1.]
233b4f64   Annie Hughes   finalised ISRF ex...
140

27bec12a   Annie Hughes   tidied up help an...
141
Npar=n_elements(pd)
301168d0   Jean-Philippe Bernard   modified to new p...
142
ulimed=replicate(0,Npar) & ulimed[0]=0
233b4f64   Annie Hughes   finalised ISRF ex...
143
ulims=replicate(0,Npar) & ulims[0]=25.
301168d0   Jean-Philippe Bernard   modified to new p...
144
llimed=replicate(0,Npar)
233b4f64   Annie Hughes   finalised ISRF ex...
145
146
llims=replicate(1.e-15,Npar) & llims[0]=15.        

233b4f64   Annie Hughes   finalised ISRF ex...
147
;=== INITIALIZE DUSTEMWRAP
27bec12a   Annie Hughes   tidied up help an...
148

a90f313b   Jean-Philippe Bernard   fixed with the ri...
149
dustem_init,model=use_model,polarization=use_polarization,/show_plots
301168d0   Jean-Philippe Bernard   modified to new p...
150
151
;help,(*!dustem_plugin).(0),/str
;stop
c9abf9b4   Ilyes Choubani   Uploading stellar...
152

301168d0   Jean-Philippe Bernard   modified to new p...
153
!dustem_nocatch=0
c9abf9b4   Ilyes Choubani   Uploading stellar...
154
!dustem_verbose=1
301168d0   Jean-Philippe Bernard   modified to new p...
155
156
!EXCEPT=2 ; for debugging

233b4f64   Annie Hughes   finalised ISRF ex...
157
IF keyword_set(noobj) THEN !dustem_noobj=1
c9abf9b4   Ilyes Choubani   Uploading stellar...
158

233b4f64   Annie Hughes   finalised ISRF ex...
159
160
161
162
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...
163

233b4f64   Annie Hughes   finalised ISRF ex...
164
;=== GENERATE DATA:
27bec12a   Annie Hughes   tidied up help an...
165
;NB: HERE WE ARE READING AN SED FILE JUST TO SET-UP THE SED STRUCTURE
233b4f64   Annie Hughes   finalised ISRF ex...
166
167
;AND FILTERS. WE REPLACE THE STOKES I and STOKES I UNCERTAINTY VALUES
;LATER USING THE MODEL ITSELF
c9abf9b4   Ilyes Choubani   Uploading stellar...
168
dir=!dustem_wrap_soft_dir+'/Data/EXAMPLE_OBSDATA/'
27bec12a   Annie Hughes   tidied up help an...
169
file=dir+'example_SED_1.xcat'
0dda35a7   Jean-Philippe Bernard   modified to inclu...
170
IF keyword_set(sed_file) THEN file=sed_file
c9abf9b4   Ilyes Choubani   Uploading stellar...
171
172
173
174
175
176
177
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...
178
;=== initializing IQU and associated errors to avoid problems when checking SED in dustem_set_data.pro
c9abf9b4   Ilyes Choubani   Uploading stellar...
179
180
181
for i=4l,n_tags(sed)-1 do begin
    sed.(i) = sed.sigmaii
endfor
88872c38   Ilyes Choubani   small update. Cha...
182
dustem_set_data,m_fit=sed,m_show=sed
301168d0   Jean-Philippe Bernard   modified to new p...
183
184
;help,(*!dustem_plugin).(0),/str
;stop
c9abf9b4   Ilyes Choubani   Uploading stellar...
185

233b4f64   Annie Hughes   finalised ISRF ex...
186
187
;;== SET INITIAL VALUES AND LIMITS OF THE PARAMETERS THAT WILL BE
;;== ADJUSTED DURING THE FIT
c9abf9b4   Ilyes Choubani   Uploading stellar...
188
dustem_init_params,use_model,pd,iv,fpd=fpd,fiv=fiv,ulimed=ulimed,llimed=llimed,ulims=ulims,llims=llims
301168d0   Jean-Philippe Bernard   modified to new p...
189
190
;help,(*!dustem_plugin).(0),/str
;stop
c9abf9b4   Ilyes Choubani   Uploading stellar...
191

233b4f64   Annie Hughes   finalised ISRF ex...
192
193
194
;=== 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...
195
196

;== SET THE OBSERVATIONAL STRUCTURE
e431104b   Annie Hughes   general updates f...
197
dustem_set_data, m_fit=sed, m_show=sed
301168d0   Jean-Philippe Bernard   modified to new p...
198
199
;help,(*!dustem_plugin).(0),/str
;stop
c9abf9b4   Ilyes Choubani   Uploading stellar...
200
201
202
203
204
205
206
207


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...
208
tol=1.e-16
c9abf9b4   Ilyes Choubani   Uploading stellar...
209
210
211
212
213

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


e431104b   Annie Hughes   general updates f...
214
tit='FIT WITH STELLAR POP ISRF EXAMPLE'
c9abf9b4   Ilyes Choubani   Uploading stellar...
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
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

301168d0   Jean-Philippe Bernard   modified to new p...
234
stop
c9abf9b4   Ilyes Choubani   Uploading stellar...
235

e431104b   Annie Hughes   general updates f...
236
237
238
239
240
241
242
243
244
245
;=== 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...
246
IF !dustem_noobj THEN BEGIN
e431104b   Annie Hughes   general updates f...
247
  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...
248
 ENDIF ELSE BEGIN
e431104b   Annie Hughes   general updates f...
249
  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...
250
251
ENDELSE

e431104b   Annie Hughes   general updates f...
252
253
254
255
256
257
258
259
 
IF keyword_set(postscript) THEN BEGIN
  device,/close
  set_plot,mydevice
  message,'Wrote '+ps_file,/info
ENDIF


c9abf9b4   Ilyes Choubani   Uploading stellar...
260
261
262
263
264
if keyword_set(wait) then begin
   message,'Made the plot of the final results',/info
   wait,wait
end

e431104b   Annie Hughes   general updates f...
265
266
267
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...
268
269
;=== 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...
270
271
272
273
274
275
276
277
278
279

;; 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...
280
  IF keyword_set(wait) THEN BEGIN
e431104b   Annie Hughes   general updates f...
281
     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...
282
283
284
285
     wait,wait
  ENDIF
ENDIF

27bec12a   Annie Hughes   tidied up help an...
286
message,'Finished dustem_stellarpopisrf_example',/info
c9abf9b4   Ilyes Choubani   Uploading stellar...
287
288
289
290
291


the_end:

END