dustem_fit_ext_pol_example.pro
9.93 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
PRO dustem_fit_ext_pol_example,model=model $
,ext_file=ext_file $
,Nitermax=Nitermax $
,fits_save_and_restore=fits_save_and_restore $
,wait=wait $
,noobj=noobj $
,help=help $
,verbose=verbose
;+
; NAME:
; dustem_fit_ext_pol_example
;
; PURPOSE:
; This routine is an example of how to fit an observational extinction SED
; (StokesI,Q,U) with DustEM and DustEMWrap.
;
; See the DustEMWrap User Guide for more information.
;
; CATEGORY:
; DustEMWrap, Distributed, High-Level, User Example
;
; CALLING SEQUENCE:
; dustem_fit_ext_pol_example[,model=][ext_file=][,Nitermax=][,fits_save_and_restore=][,/help,/wait,/verbose,/noobj]
;
; INPUTS:
; None
;
; OPTIONAL INPUT PARAMETERS:
; None
;
; OUTPUTS:
; None
;
; OPTIONAL OUTPUT PARAMETERS:
; Plots, results structure in binary FITS table format
;
; ACCEPTED KEY-WORDS:
; model = specifies the interstellar dust mixture used by DustEM
; 'MC10' model from Compiegne et al 2010
; 'DBP90' model from Desert et al 1990
; 'DL01' model from Draine & Li 2001
; 'WD01_RV5P5B' model from Weingartner & Draine 2002 with Rv=5.5
; 'DL07' model from Draine & Li 2007
; 'J13' model from Jones et al 2013, as updated in
; Koehler et al 2014
; 'G17_ModelA' model A from Guillet et al (2018). Includes
; polarisation. See Tables 2 and 3 of that paper for details.
; 'G17_ModelB' model B from Guillet et al (2018)
; 'G17_ModelC' model C from Guillet et al (2018)
; 'G17_ModelD' model A from Guillet et al (2018)
; ext_file = string naming the path to text file in .xcat format that
; describes the observational extinction SED.
; If not set, the file
; 'Data/EXAMPLE_OBSDATA/Mathis90Fitz99_DISM_NH20.xcat' is
; used to define the observational structure, and a synthetic
; observation is generated using the dust model.
; Nitermax = maximum number of fit iterations. Default is 5.
; fits_save_and_restore = if set, save the fit results in a binary
; FITS file. The code then restore this file and plots
; the results using the saved results information.
; 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
; noobj = if set, runs with no object graphics
;
; 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:
;
;
; EXAMPLES
; dustem_fit_ext_pol_example
; dustem_fit_ext_pol_example,Nitermax=1,fits_save_and_restore='/tmp/mysavefile.fits'
; dustem_fit_ext_pol_example,model='DBP90'
;
; MODIFICATION HISTORY:
; Written by JPB Apr-2011
; 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_fit_ext_pol_example'
goto,the_end
END
IF keyword_set(model) THEN BEGIN
use_model=strupcase(model)
ENDIF ELSE BEGIN
use_model='G17_MODELD'
ENDELSE
known_mdls=['MC10','DBP90','DL01','WD01_RV5P5B','DL07','J13','G17_MODELA','G17_MODELB','G17_MODELC','G17_MODELD']
test_model = where(known_mdls eq use_model,ct)
if ct eq 0 then begin
message,'ISM dust model '+use_model+' unknown',/continue
message,'Known models are MC10,DBP90,DL01,WD01_RV5P5B,DL07,J13,G17_MODELA,G17_MODELB,G17_MODELC,G17_MODELD',/continue
stop
end
use_polarization=0. ;default is no polarization in models
use_window=2 ; default graphics window number to use for plotting the results
use_verbose=0
if keyword_set(verbose) then use_verbose=1
use_Nitermax=1 ; 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
; of the different grain types
;=== Set the (model-dependent) parameters that you want to fit (pd),
;=== their initial values (iv)
;=== and whether they are bounded (ulimed,llimed,llims,ulims).
;=== Fixed parameters (fpd) and their values (fiv) are also set here.
;=== Refer to the DustEM and DustEMWrap User guides for an explanation
;=== of the physical meaning of dust model and plug-in parameters, and
;=== how to specify them.
;=== Example is provided for G17_MODELD
;=== If you choose a different dust model, you will need to adjust the
;=== parameter information accordingly.
pd = [ $
'(*!dustem_params).grains(0).mdust_o_mh',$ ;PAH0 mass fraction
'(*!dustem_params).grains(1).mdust_o_mh',$ ;amCBE mass fraction
'(*!dustem_params).grains(2).mdust_o_mh',$ ;aSil
'dustem_plugin_modify_dust_polx_2' ]
true_vals = [7.1e-4, 1.3e-3,5.6e-3,35.] ; these are the true values that will be used to generate the data if no ext_file is specified
iv = true_vals+[5.00E-4,-7.00E-4,8.00E-4,5] ; this is the vector of starting guesses for the fit
Npar=n_elements(pd)
ulimed=replicate(0,Npar)
llimed=replicate(1,Npar) & llimed[3]=0
llims=replicate(1.e-15,Npar)
use_polarization=1
;=== Fixed parameters
fpd=[]
;==initial parameter values for fixed parameters
fiv=[]
if keyword_set(wait) then begin
message,'Finished setting dust model and plug-in parameters: '+use_model,/info
wait,wait
end
;== INITIALISE DUSTEM
dustem_init,model=use_model,polarization=use_polarization
!dustem_nocatch=1
!dustem_verbose=use_verbose
IF keyword_set(noobj) THEN !dustem_noobj=1
!EXCEPT=2 ; for debugging
;=== READ OBSERVATIONAL EXTINCTION DATA
;=== IF THE USER DOES NOT PROVIDE AN EXTINCTION CURVE FILE , WE READ MATHIS TO INITIALISE THE OBSERVATIONAL STRUCTURE.
dir=!dustem_wrap_soft_dir+'/Data/EXAMPLE_OBSDATA/'
use_ext_file=dir+'Mathis90Fitz99_DISM_NH20.xcat'
IF keyword_set(ext_file) THEN use_ext_file=ext_file
ext=read_xcat(use_ext_file,/silent)
IF not keyword_set(ext_file) THEN BEGIN
message, 'You have not provided an extinction curve. I will generate one from the '+use_model+' model',/info
;;=== CREATE ENTRIES FOR ALL STOKES (OTHERWISE NEXT CALL TO DUSTEM_SET_DATA WILL COMPLAIN)
;;=== WE ASSUME THAT A USER-PROVIDED EXT CURVE WILL SATISFY ALL REQUIREMENTS
ext.EXT_I=1.
for i=4l,n_tags(ext)-1 do begin
ext.(i) = ext.EXT_I/1.E10
endfor
ENDIF
;=== HERE WE SET THE DATA SO THAT THE COMPUTE_ FUNCTIONS BELOW HAVE
;=== THE NECESSARY FIELDS AND INFORMATION
;== note that m_fit and m_show do not exist -- this is deliberate
;== since we are not treating emission data
dustem_set_data, m_fit=m_fit,m_show=m_show,x_fit=ext,x_show=ext
;== SET INITIAL VALUES AND LIMITS OF THE PARAMETERS FOR THE FIT
;== AND ACTIVATE ANY PLUGINS (HENCE WE NEED TO DO THIS BEFORE THE COMPUTE_ CALLS)
dustem_init_params,use_model,pd,iv,fpd=fpd,fiv=fiv,ulimed=ulimed,llimed=llimed,ulims=ulims,llims=llims,polarization=use_polarization
IF keyword_set(wait) THEN BEGIN
message,'Finished initializing dustemwrap with parameters and plugins',/info
wait,wait
ENDIF
if not keyword_set(ext_file) then begin
;== GENERATE THE DATA USING THE MODEL AND TRUE VALUES
ext.EXT_I = dustem_compute_ext(true_vals,st=st)
toto = dustem_compute_stokext(true_vals,st=st)
ext.EXT_Q = toto[0]
ext.EXT_U = toto[1]
;== RESET THE OBSERVATIONAL STRUCTURE
;== note that m_fit and m_show do not exist -- this is deliberate
;== since we are not treating emission data
dustem_set_data, m_fit,m_show,ext,ext
IF keyword_set(wait) THEN BEGIN
message,'Finished generating a synthetic EXT from the model '+use_model,/info
wait,wait
ENDIF
end
;== INFORMATION TO RUN THE FIT
tol=1.e-10
;=== INFORMATION TO MAKE THE PLOTS
;=== _x/_extinction means extinction plots, _m/_emissions means emission plots
xr_x=[0.01,30]
yr_fpolext=[1.00E-10,50]
;yr_fpolext=[1e-4,30]
tit='Dust Optical Depth'
;=== RUN THE FIT
t1=systime(0,/sec)
res=dustem_mpfit_data(tol=tol,Nitermax=use_Nitermax,gtol=gtol $
,/xlog,/ylog,xr_x=xr_x,yr_fpolext=yr_fpolext,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
stop
IF keyword_set(fits_save_and_restore) THEN BEGIN
message,'Writing out results structure: '+fits_save_and_restore,/info
dustem_write_fits_table,filename=fits_save_and_restore,help=help
;=== 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
;stop
dustem_read_fits_table,filename=fits_save_and_restore,dustem_st=dustem_st
;==== plot result taken from the saved fits table
res=*(*!dustem_fit).CURRENT_PARAM_VALUES
!dustem_end=-1; subsequent calls to the fit. 0 is intialization an 1 is for the last iteration. It's initialized to 0 after the creation of the fits file.
IF !dustem_noobj THEN BEGIN
dustemwrap_plot_noobj,res,st=dustem_st,xr=xr,/xstyle,yr=yr,/ysty,/ylog,/xlog,title=tit+' (From Saved FITS file)'
ENDIF ELSE BEGIN
dustemwrap_plot,res,st=dustem_st,xr=xr,/xstyle,yr=yr,/ysty,/ylog,/xlog,title=tit+' (From Saved FITS file)'
ENDELSE
IF keyword_set(wait) THEN BEGIN
message,'Saved the results as FITS in the file: '+fits_save_and_restore+', and made a plot using the data in this file',/info
wait,wait
ENDIF
ENDIF
message,'Finished dustem_fit_ext_pol_example',/info
the_end:
END