WikiStart: diamdocs.txt

File diamdocs.txt, 11.6 KB (added by pcr, 12 years ago)

documentation for diameter estimation procedures

Line 
1
2----- Documentation for Diam\average_diameter.pro -----
3 NAME:
4      AVERAGE_DIAMETER
5
6 AUTHOR:
7      pierre.cruzalebes@oca.eu
8
9 PURPOSE:
10      average diameter estimations using the weighted mean
11
12 CATEGORY:
13      angular diameter estimation
14
15 INPUTS:
16      need text input file (in OBS_PATH/INP/ directory) with:
17        - input file number
18        - input files name(s)
19
20 REQUIREMENTS:
21      data read in input file(s) (in OBS_PATH/OUT/ directory)
22      must be in ASCII format and contain (in this order) :
23        - model flag, flux flag, synthetic exitance+radiance file names,
24        data format flag, starting parameters, free parameter flags,
25        goodness-of-fit parameter, input parameters, inferior errors,
26        superior errors, confidence level
27
28 OUTPUTS:
29      data written in output file (in OBS_PATH/OUT/ directory)
30      must be in ASCII format and contain (in this order) :
31        - model flag, flux flag, synthetic exitance+radiance file name,
32        data format flag, starting parameters, free parameter flags,
33        goodness-of-fit parameter, output parameters, inferior errors,
34        superior errors, nber of degrees of freedom
35
36 LOCAL PROCEDURE CALLED:
37        RESET_PLOT
38
39 LOCAL FUNCTION USED:
40        EXTRACT_PROHEADER
41        WSTDEV
42
43 LOCAL SYSTEM VARIABLE USED:
44        FORMAT_OUT
45        NB_MAX_PARAM
46        OBS_PATH
47        PLOT_DEV
48        SPIDAST_PATH
49
50 REVISION HISTORY:
51       Written by pcr 2008/04/09
52       last modification by pcr 2010/02/11
53
54----- Documentation for Diam\get_broadband_diameter.pro -----
55 NAME:
56      GET_BROADBAND_DIAMETER
57
58 AUTHOR:
59      pierre.cruzalebes@oca.eu
60
61 PURPOSE:
62      measure broadband photometric diameter (IRFM)
63      by scaling synthetic spectral radiant exitance
64      with broadband-photometry flux measurement
65
66 CATEGORY:
67     angular diameter estimation
68
69 INPUTS:
70      need text input file (in OBS_PATH/INP/ directory) with :
71        - input broadband photometric flux measurement file name
72        - number of filter file(s)
73       - input broadband filter transmission file name(s) (in same row)
74        - synthetic spectral radiant exitance file name ('none' if not available)
75        - if needed : effective temperature (for Planck and Engelke)
76
77 REQUIREMENTS:
78      data read in broadband-photometry flux measurement file (in subdirectory
79      of OBS_PATH/) must be in ASCII format and contain (in this order) :
80        - mean wavelength and equivalent width [mum], flux and absolute
81        error on flux [W/m^2/mum]
82
83      data read in filter file (in ALL_DATA_PATH/ directory) must be in ASCII format
84      and contain (in this order) :
85        - wavelength [mum] and transmission
86
87      data read in input synthetic exitance file (in SYNTHE_PATH/ directory)
88      must be in ASCII format and contain :
89        - wavelength [AA = 10^-4 mum] and exitance [erg/cm^2/s/AA =
90        10 W/m^2/mum]
91
92 OUTPUTS:
93      data written in output file (of name input_file_stem.out in OBS_PATH/OUT/
94      directory) must be in ASCII format and contain (in this order,
95      in same row) :
96        - model flag , flux flag, initial synthetic exitance+radiance file
97        names, data format flag, starting parameters, free flags,
98        goodness-of-fit parameter, output parameters,
99        inferior errors, superior errors, nber of degrees of freedom
100
101      data written in covariance file (of name input_file_stem.cova in
102      OBS_PATH/OUT/ directory) must be in ASCII format and contain the
103      covariance matrix (of size NB_MAX_PARAM*NB_MAX_PARAM)
104
105 LOCAL PROCEDURE CALLED:
106       ENGELKE
107       PLANCK
108        RESET_PLOT
109
110 LOCAL FUNCTION USED:
111        EXTRACT_PROHEADER
112        TRAP
113        TRI_STDEV
114
115 LOCAL SYSTEM VARIABLE USED:
116       ALL_DATA_PATH
117        FORMAT_OUT
118        MAS2RADIAN
119        MAX_REL_ERR
120       NB_LAMBDA_MAX
121        NB_MAX_PARAM
122        OBS_PATH
123        SPIDAST_PATH
124        SYNTHE_PATH
125        PLOT_DEV
126
127 REVISION HISTORY:
128       Written by pcr 2006/11/27
129       last modification by pcr 2010/06/27
130
131----- Documentation for Diam\get_color_diameter.pro -----
132 NAME:
133      GET_COLOR_DIAMETER
134 
135 AUTHOR:
136      pierre.cruzalebes@oca.eu
137
138 PURPOSE:
139      calculate angular diameters from interstellar corrected Johnson
140       color indexes (surface brightness method) according to :
141       - Bonneau et al., A&A 456, 789 (2006), with (V,B-V), (V,V-R), and (V,V-K)
142       - Groenewegen, MNRAS 353, 903 (2004), with (V,V-K), (V,V-R), and (K,J-K)
143       - van Belle et al., AJ 117, 521 (1999), with (PLX,V-K),
144         where PLX is the parallax
145       - di Benedetto, A&A 339, 858 (1998), with (V,V-K)
146       - van Belle, PASP 111, 1515 (1999), with (V,V-K) and (B,V-K), for so-called
147         "evolved" (giants and supergiants) and "variable" (Miras, carbon...) stars
148
149 CATEGORY:
150       angular diameter estimation
151
152 INPUTS:
153       need text input file with:
154        - magnitude file name
155        - basic data file name
156
157 REQUIREMENTS:
158      data read in magnitude file (in subdirectory of OBS_PATH/)
159      must be in ASCII format and contain (in this order) :
160        - effective wavelengths and widths [mum], magnitudes and errors
161
162      basic data file (in subdirectory of OBS_PATH/) must be in
163      standard FITS format and contain the following ASCII lines :
164      PARALLAX  =         ppp.pp   / Parallax (deg)
165      PARA_ERR  =           e.ee   / Error in parallax (deg)
166      TEFF      =        tttt.     / Effective temperature (K)
167      TEFF_ERR  =         ttt.     / Error in effective temperature (K)
168
169 OUTPUTS:
170      data written in output file(s) (of name(s) input_file_stem_BV.out,
171      input_file_stem_VR.out, input_file_stem_VK.out, input_file_stem_BK.out
172      in OBS_PATH/OUT/ directory) must be in ASCII format and contain
173      (in this order, in same row) :
174        - model flag, flux flag, initial synthetic exitance+radiance file
175        names, data format flag, starting parameters,
176        free flags, chi-square, output parameters, inferior errors,
177        superior errors, number of degrees of freedom
178
179      data written in covariance file(s) (of name(s) input_file_stem_BV.cova,
180      input_file_stem_VR.cova, and/or input_file_stem_VK.cova, in
181      OBS_PATH/OUT/ directory) must be in ASCII format and contain the
182      covariance matrix(ces) (of size NB_MAX_PARAM*NB_MAX_PARAM)
183
184 LOCAL PROCEDURE CALLED:
185      RESET_PLOT
186
187 LOCAL FUNCTION USED:
188      EXTRACT_PROHEADER
189      SYM
190      TRI_STDEV
191
192 LOCAL SYSTEM VARIABLE USED:
193      FORMAT_OUT
194      MAX_HEADER
195      MAX_REL_ERR
196      NB_MAX_PARAM
197      OBS_PATH
198      PHISUN_1PC
199      PLOT_DEV
200      SPIDAST_PATH
201
202 REVISION HISTORY:
203       Written by pcr 2009/03/25
204       modified by pcr 2010/07/16
205
206----- Documentation for Diam\get_MK_diameter.pro -----
207 NAME:
208      GET_MK_DIAMETER
209
210 AUTHOR:
211      pierre.cruzalebes@oca.eu
212
213 PURPOSE:
214      calculate linear diameter from absolute luminosity and effective temperative
215      derived from Morgan-Keenan spectral type according to
216       - de Jager & Nieuwenhuijzen A&A 177, 217 (1987)
217       - Straizys & Kuriliene ApSS 80, 353 (1981)
218       - Allen's Astrophysical Quantities (4th ed.)
219      with revised solar constants in Table 2.1 of
220       - Amsler et al. Phys. Lett B, 667 (2008)
221      deduce angular diameter from parallax
222      if diameter file given, recalculate stellar parameters
223
224 CATEGORY:
225      angular diameter estimation.
226
227 INPUTS:
228      need text input file with:
229       - basic data file name
230       - log(Teff), log(L/L_sun), and log(g) file names (in same row)
231       - diameter file name ('none' if not needed)
232
233 REQUIREMENTS:
234      basic data file (in subdirectory of OBS_PATH/) must be in
235      standard FITS format and contain the following ASCII lines with:
236       PARALLAX   =        ppp.ppp  / Parallax (deg)
237       PARA_ERR   =          e.eee  / Error in parallax (deg)
238       SPECTYP    = 'sssss'         / Morgan-Keenan spectral type
239
240      data read in temperature/luminosity/gravity files (in ALL_DATA_PATH/
241      directory) must be in ASCII format and contain
242      (tempe from de Jager, lumin from de Jager or Allen, gravity from Straizys or Allen) :
243       - first row : values of luminosity continuous analytical b-variable
244       - first column : values of spectral class continuous analytical
245         s-variable
246       - tabulated values of log(Teff)(s,b) or log(L/L_sun)(s,b) or log(g)(s,b)
247
248      data read in diameter file (in subdirectory of OBS_PATH/ )
249      must be in ASCII format and contain (in this order) :
250       - model flag, flux flag, synthetic exitance+radiance file names, data
251         format flag, starting parameters, free parameter flags, goodness-of-fit
252         parameter, input parameters, inferior errors, superior errors,
253         confidence level
254
255 OUTPUTS:
256      data written in temperature file (of name input_file_stem.tempe
257      in the same subdirectory of OBS_PATH/) must be in ASCII format
258      and contain (in this order) :
259       - effective temperature and error [K]
260
261      data written in output file
262     (of name input_file_stem.out in OBS_PATH/OUT/ directory)
263      must be in ASCII format and contain (in this order, in same row) :
264       - model flag, flux flag, initial synthetic exitance+radiance file
265         names, data format flag, starting parameters, free flags, chi-square,
266         output parameters, inferior errors, superior errors, number of degrees
267         of freedom
268
269      data written in covariance file (of name input_file_stem.cova in
270      OBS_PATH/OUT/ directory) must be in ASCII format and contain the covariance
271      matrix (of size NB_MAX_PARAM*NB_MAX_PARAM)
272
273 LOCAL PROCEDURE CALLED:
274      RESET_PLOT
275
276 LOCAL FUNCTION USED:
277      EXTRACT_PROHEADER
278      TRI_STDEV
279
280 LOCAL SYSTEM VARIABLE USED:
281      ALL_DATA_PATH
282      FORMAT_OUT
283      MAS2RADIAN
284      MAX_HEADER
285      MAX_REL_ERR
286      NB_MAX_PARAM
287      OBS_PATH
288      PHISUN_1PC
289      PLOT_DEV
290      SPIDAST_PATH
291
292 REVISION HISTORY:
293      Written by pcr 2009/04/17
294      last modification by pcr 2010/12/07
295
296----- Documentation for Diam\get_VK_diameter.pro -----
297 NAME:
298      GET_VK_DIAMETER
299
300 AUTHOR:
301      pierre.cruzalebes@oca.eu
302
303 PURPOSE:
304      calculate angular diameter and effective temperature
305      thanks to V-K color index
306      according to Van Belle et al., AJ 117, 521 (1999)
307
308 CATEGORY:
309      angular diameter estimation
310
311 INPUTS:
312      need text input file with:
313        - magnitude file name
314       - basic data file name
315
316 REQUIREMENTS:
317      data read in magnitude file (in subdirectory of OBS_PATH/)
318      must be in ASCII format and contain (in this order) :
319        - effective wavelengths and widths [mum], magnitudes and errors
320
321      basic data file (in subdirectory of OBS_PATH/) must be in
322      standard FITS format and contain the following ASCII lines with:
323       PARALLAX     =        ppp.pp   / Parallax (deg)
324       PARA_ERR =          e.ee   / Error in parallax (deg)
325
326 OUTPUTS:
327      data written in output file
328      (of name input_file_stem.out in OBS_PATH/OUT/ directory)
329      must be in ASCII format and contain (in this order, in same row) :
330        - model flag, flux flag, initial synthetic exitance+radiance file
331          names, data format flag, starting parameters, free flags, chi-square,
332          output parameters, inferior errors, superior errors, number of
333          degrees of freedom
334
335      data written in covariance file (of name input_file_stem.cova in
336      OBS_PATH/OUT/ directory) must be in ASCII format and contain the
337      covariance matrix (of size NB_MAX_PARAM*NB_MAX_PARAM)
338
339 LOCAL PROCEDURE CALLED:
340      RESET_PLOT
341
342 LOCAL FUNCTION USED:
343      EXTRACT_PROHEADER
344      TRI_STDEV
345
346 LOCAL SYSTEM VARIABLE USED:
347      FORMAT_OUT
348      MAS2RADIAN
349      MAX_REL_ERR
350      NB_MAX_PARAM
351      OBS_PATH
352      PHISUN_1PC
353      PLOT_DEV
354      SPIDAST_PATH
355
356 REVISION HISTORY:
357      Written by pcr 2008/03/09
358      last modification by pcr 2010/06/20
359