Blame view

src/idl/dustem_compute_stokext.pro 6.38 KB
283845da   Ilyes Choubani   Small corrections...
1
FUNCTION dustem_compute_stokext,p_dim,$
cee5beec   Jean-Philippe Bernard   just changed form...
2
3
4
5
6
                                st=st,$
                                QEXT_spec=QEXT_spec,$
                                UEXT_spec=UEXT_spec,$
                                PSIEXT_spec=PSIEXT_spec,$
                                dustem_psi_ext=dustem_psi_ext,$
2926480f   Ilyes Choubani   Modified header c...
7
8
                                help=help
                               
b74c4452   Ilyes Choubani   Treating extincti...
9
10
11
12

;+
; NAME:
;    dustem_compute_stokext
0b156835   Annie Hughes   improved inline d...
13
;
b74c4452   Ilyes Choubani   Treating extincti...
14
; PURPOSE:
78d57d5a   Annie Hughes   unknown changes
15
;    Computes Stokes Parameters for extinction in units of optical depth for a given Dustem spectrum
0b156835   Annie Hughes   improved inline d...
16
;
b74c4452   Ilyes Choubani   Treating extincti...
17
18
; CATEGORY:
;    Dustem
0b156835   Annie Hughes   improved inline d...
19
;
b74c4452   Ilyes Choubani   Treating extincti...
20
; CALLING SEQUENCE:
2926480f   Ilyes Choubani   Modified header c...
21
;    out=dustem_compute_stokext(p_dim[,st=][,QEXT_spec=QEXT_spec][,UEXT_spec=UEXT_spec][,PSIEXT_spec=PSIEXT_spec][,dustem_psi_ext=dustem_psi_ext][,/help])
0b156835   Annie Hughes   improved inline d...
22
;
b74c4452   Ilyes Choubani   Treating extincti...
23
24
; INPUTS:
;    p_dim      = parameter values
0b156835   Annie Hughes   improved inline d...
25
;
b74c4452   Ilyes Choubani   Treating extincti...
26
; OPTIONAL INPUT PARAMETERS:
07a51917   Ilyes Choubani   updating help sec...
27
;    st        = Dustem structure
0b156835   Annie Hughes   improved inline d...
28
;
b74c4452   Ilyes Choubani   Treating extincti...
29
; OUTPUTS:
07a51917   Ilyes Choubani   updating help sec...
30
31
32
;    out        = List Containing the Stokes parameters extinction for spectrum points in !dustem_data 
;    out[0]     = Computed Stokes Q extinction for spectrum points in !dustem_data
;    out[1]     = Computed Stokes U extinction for spectrum points in !dustem_data 
0b156835   Annie Hughes   improved inline d...
33
;
b74c4452   Ilyes Choubani   Treating extincti...
34
; OPTIONAL OUTPUT PARAMETERS:
2926480f   Ilyes Choubani   Modified header c...
35
;    st        = Dustem output structure
07a51917   Ilyes Choubani   updating help sec...
36
37
38
39
;    QEXT_spec        = Dustem Stokes Q extinction 
;    UEXT_spec        = Dustem Stokes U extinction
;    PSIEXT_spec      = Dustem Polarization angle output in extinction
;    dustem_psi_ext   = Computed Polarization angle ouput for spectrum points in !dustem_data
0b156835   Annie Hughes   improved inline d...
40
;
b74c4452   Ilyes Choubani   Treating extincti...
41
42
; ACCEPTED KEY-WORDS:
;    help      = If set, print this help
0b156835   Annie Hughes   improved inline d...
43
;
b74c4452   Ilyes Choubani   Treating extincti...
44
45
; COMMON BLOCKS:
;    None
0b156835   Annie Hughes   improved inline d...
46
;
b74c4452   Ilyes Choubani   Treating extincti...
47
48
; SIDE EFFECTS:
;    None
0b156835   Annie Hughes   improved inline d...
49
;
b74c4452   Ilyes Choubani   Treating extincti...
50
; RESTRICTIONS:
78d57d5a   Annie Hughes   unknown changes
51
52
;    The DustEM fortran code must be installed
;    The DustEMWrap IDL code must be installed
0b156835   Annie Hughes   improved inline d...
53
;
b74c4452   Ilyes Choubani   Treating extincti...
54
55
; PROCEDURE:
;    None
0b156835   Annie Hughes   improved inline d...
56
;
b74c4452   Ilyes Choubani   Treating extincti...
57
58
59
; EXAMPLES
;    
; MODIFICATION HISTORY:
78d57d5a   Annie Hughes   unknown changes
60
;    Written by J.-Ph. Bernard 2022
0b156835   Annie Hughes   improved inline d...
61
62
63
;    Evolution details on the DustEMWrap gitlab.
;    See http://dustemwrap.irap.omp.eu/ for FAQ and help.  
;-
b74c4452   Ilyes Choubani   Treating extincti...
64

07a51917   Ilyes Choubani   updating help sec...
65

b74c4452   Ilyes Choubani   Treating extincti...
66
67
68
69
70
71
72
IF keyword_set(help) THEN BEGIN
    doc_library,'dustem_compute_stokext'
    out=0.
    goto,the_end
ENDIF

IF not keyword_set(st) THEN BEGIN
0b156835   Annie Hughes   improved inline d...
73
    dustem_activate_plugins,p_dim/(*(*!dustem_fit).param_init_values),st=st
07372e26   Ilyes Choubani   Corrected huge pl...
74
    ;st=dustem_run(p_dim)
b74c4452   Ilyes Choubani   Treating extincti...
75
76
77
78
79
80
81
82
ENDIF

out=0. ; no specific output is required.

If keyword_set(result) THEN result=st

degtorad = !pi/180

f2caf3f1   Ilyes Choubani   Debugging some er...
83

07372e26   Ilyes Choubani   Corrected huge pl...
84
EXT_spec = st.ext.ext_tot * (*!dustem_HCD)/1.e21     ;This is Total extinction (for a default value of 10^20 NH/cm^2)
07372e26   Ilyes Choubani   Corrected huge pl...
85
POLEXT_spec = st.polext.ext_tot * (*!dustem_HCD)/1.e21   ;This is Polarized extinction
b74c4452   Ilyes Choubani   Treating extincti...
86

f2caf3f1   Ilyes Choubani   Debugging some er...
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
;Hard-coded test to set to zero potential negative values in the polarized extinction arrays:
;so far this has been seen in absorption arrays  
;This test needs to include all grain species that polarize

IF !run_pol THEN BEGIN
    
    ;THIS FALSE CORRECT  IT USING POLEXT_spec
    ;POLEXT_spec.abs_grain[2,*]
    ind_ngtv_plxt = where (POLEXT_spec LT 0, ct_ngtv_plxt)
    
    IF ct_ngtv_plxt NE 0 THEN (POLEXT_spec)[ind_ngtv_plxt] = 0.
        
        
ENDIF

b74c4452   Ilyes Choubani   Treating extincti...
102
103
104
105
106
107
Nwaves=(size(EXT_SPEC))[1]

frac=POLEXT_spec/EXT_spec
tes=where(finite(frac) eq 0)
frac(tes)=0.

887b421b   Ilyes Choubani   correcting some c...
108
109
scopes=tag_names((*!dustem_plugin))
IF scopes[0] NE 'NONE' THEN BEGIN
b74c4452   Ilyes Choubani   Treating extincti...
110

887b421b   Ilyes Choubani   correcting some c...
111
112
113
114
115
116
    FOR i=0L,n_tags(*!dustem_plugin)-1 DO BEGIN   
        
        IF total(strsplit((*(*!dustem_plugin).(i).scope),'+',/extract) EQ 'REPLACE_POLEXT') THEN BEGIN
            
            QEXT_spec = (*(*!dustem_plugin).(i).spec)[*,1]
            UEXT_spec = (*(*!dustem_plugin).(i).spec)[*,2]
887b421b   Ilyes Choubani   correcting some c...
117
118
119
120
121
            
        ENDIF 
    
    ENDFOR
ENDIF    
b74c4452   Ilyes Choubani   Treating extincti...
122
123
    
IF ~isa(QEXT_spec) && ~isa(UEXT_spec) THEN BEGIN
afde94a3   Ilyes Choubani   general update
124
    polar_ippsi2iqu,EXT_spec,QEXT_spec,UEXT_spec,frac,replicate(!dustem_psi_ext,Nwaves);PSI_spec 
b74c4452   Ilyes Choubani   Treating extincti...
125
126
ENDIF    
        
887b421b   Ilyes Choubani   correcting some c...
127
128
129
130
131
132
133
134

IF scopes[0] NE 'NONE' THEN BEGIN        
    FOR i=0L,n_tags(*!dustem_plugin)-1 DO BEGIN
        
        IF total(strsplit((*(*!dustem_plugin).(i).scope),'+',/extract) EQ 'ADD_POLEXT') THEN BEGIN
            
            QEXT_spec+=(*(*!dustem_plugin).(i).spec)[*,1]
            UEXT_spec+=(*(*!dustem_plugin).(i).spec)[*,2]
b74c4452   Ilyes Choubani   Treating extincti...
135
        
887b421b   Ilyes Choubani   correcting some c...
136
        ENDIF
b74c4452   Ilyes Choubani   Treating extincti...
137
    
887b421b   Ilyes Choubani   correcting some c...
138
139
    ENDFOR
ENDIF
b74c4452   Ilyes Choubani   Treating extincti...
140
141
;-----------------------------------------

f2caf3f1   Ilyes Choubani   Debugging some er...
142
143
144
145
146
147

;Hard-coded block to avoid cases where Q=-0.0 and U=0.
testnzero = where(QEXT_spec EQ -0., ct_nzero)
if ct_nzero ne 0 then QEXT_spec[testnzero] = 0


afde94a3   Ilyes Choubani   general update
148
149
150
PSIEXT_spec = 0.5*atan(UEXT_spec,QEXT_spec)/degtorad


b74c4452   Ilyes Choubani   Treating extincti...
151
;INITIALIZING THE STOKES SEDS
0068116a   Ilyes Choubani   General update + ...
152
153
dustem_qext = (*(*!dustem_data).qext).values * 0.
dustem_uext = (*(*!dustem_data).uext).values * 0.
3f93c873   Ilyes Choubani   correcting "compu...
154
155
;Using a list because dustem_qext and dustem_uext can have different dimensions
out=list(fltarr(n_elements(dustem_qext)),fltarr(n_elements(dustem_uext)))
b74c4452   Ilyes Choubani   Treating extincti...
156
157
158
159
160
161
162
163
164
165
166
167
168
if not isarray(EXT_spec) THEN stop 


;COLOR CORRECTION NOT PERFORMED YET. ONLY SPECTRUM DATA POINTS ARE CONSIDERED FOR NOW
; 
; ;Performing color corrections on the dustem spectra and generating the SEDs at the given filters 
; 
; IF !dustem_do_cc NE 0 AND !dustem_never_do_cc EQ 0 THEN BEGIN
;     message,'DOING color correction calculations',/info
; ENDIF ELSE BEGIN
;           message,'SKIPPING color correction calculations',/info
;       ENDELSE
; 
0068116a   Ilyes Choubani   General update + ...
169
170
; ind_qsed=where((*(*!dustem_data).qsed).filt_names NE 'SPECTRUM',count_qsed)
; ind_used=where((*(*!dustem_data).used).filt_names NE 'SPECTRUM',count_used)
b74c4452   Ilyes Choubani   Treating extincti...
171
172
173
;   
;   
; IF count_qsed NE 0 THEN BEGIN 
0068116a   Ilyes Choubani   General update + ...
174
;   filter_names=((*(*!dustem_data).qsed).filt_names)(ind_qsed)    
b74c4452   Ilyes Choubani   Treating extincti...
175
176
177
178
179
180
181
;   if isa(dustem_qsed) then begin 
;     sqsed=dustem_cc(st.polsed.wav,Q_spec,filter_names,cc=cc)
;     dustem_qsed(ind_qsed)=sqsed
;   endif
; ENDIF
; 
; IF count_used NE 0 THEN BEGIN
0068116a   Ilyes Choubani   General update + ...
182
; filter_names=((*(*!dustem_data).used).filt_names)(ind_used)
b74c4452   Ilyes Choubani   Treating extincti...
183
184
185
186
187
188
189
190
191
192
193
; if isa(dustem_used) then begin
;   sused=dustem_cc(st.polsed.wav,U_spec,filter_names,cc=cc)
;   dustem_used(ind_used)=sused
; endif
; ENDIF


;For spectrum data points, interpolate in log-log
;Linear interpolation leads to wrong values, in particular where few
;wavelengths points exist in the model (long wavelengths).

0068116a   Ilyes Choubani   General update + ...
194
195
ind_qspec=where((*(*!dustem_data).qext).filt_names EQ 'SPECTRUM',count_qspec)
ind_uspec=where((*(*!dustem_data).uext).filt_names EQ 'SPECTRUM',count_uspec)
b74c4452   Ilyes Choubani   Treating extincti...
196
197

IF count_qspec NE 0 THEN BEGIN
0068116a   Ilyes Choubani   General update + ...
198
  if isa(dustem_qext) then dustem_qext(ind_qspec)=interpol(QEXT_spec,st.polext.wav,(((*(*!dustem_data).qext).wav)(ind_qspec)))  
b74c4452   Ilyes Choubani   Treating extincti...
199
200
201
ENDIF

IF count_uspec NE 0 THEN BEGIN
0068116a   Ilyes Choubani   General update + ...
202
  if isa(dustem_uext) then dustem_uext(ind_uspec)=interpol(UEXT_spec,st.polext.wav,(((*(*!dustem_data).uext).wav)(ind_uspec)))
b74c4452   Ilyes Choubani   Treating extincti...
203
204
205
206
207
208
209
ENDIF

out_st=st

;generating interpolates for Psi_ext
dustem_psi_ext = 0.5*atan(dustem_uext,dustem_qext)/degtorad

3f93c873   Ilyes Choubani   correcting "compu...
210
211
212
213

out[0] = dustem_qext
out[1] = dustem_uext

b74c4452   Ilyes Choubani   Treating extincti...
214
215
216
217
218
219
220
221
;clean pointers
heap_gc

the_end:

RETURN,out

END