![[attach.png]](idldoc-resources/xattach.png.pagespeed.ic.tvtntcUO-o.png)
./
pp_cmfr__define.pro
Object to read and interpret OBSFLUX-type files created by cmfgen:
Uses pp_cmfread to do the low level reading and parsing, and returns a structure with the names and values read (see that function for details). pp_cmfread is more general, works with any file with a format like OBSFLUX or obs_fin (see the function for details).
The object pp_cmfr uses pp_cmfread, then tries to interpret the variable names to match with them with the physical quantities expected to be in the file.
The interesting methods are getall, and getvariable (see below).
Author information
- Author
Paulo Penteado (pp.penteado@gmail.com), Aug/2009
Other file information
- Uses:
Class description for pp_cmfr
Fields
Fields in pp_cmfr
- CONT ptr_new()
- DESC ptr_new()
- DIELIMP ptr_new()
- DIND { PP_CMFR_DIND, S_LINE: 0L, S_DIELIMP: 0L, S_MECH: 0L, S_SHOCK: 0L, S_XRAYH: 0L, S_XRAYL: 0L, FREQ: 0L, INTENS: 0L, LUM: 0L, DIELIMP: 0L, LINE: 0L, MECH: 0L, RAD: 0L, SHOCK: 0L, RADMECH: 0L }
- FREQ ptr_new()
- INTENS ptr_new()
- LINE ptr_new()
- LUM ptr_new()
- MECH ptr_new()
- RAD ptr_new()
- RADMECH ptr_new()
- SHOCK ptr_new()
- S_DIELIMP 0.0000000D
- S_LINE 0.0000000D
- S_MECH 0.0000000D
- S_SHOCK 0.0000000D
- S_XRAYH 0.0000000D
- S_XRAYL 0.0000000D
Routines
Routines from pp_cmfr__define.pro
result = pp_cmfr::getall( [desc=desc])Returns a structure containing all the 6 scalars and 9 vectors read from the object (NaN for those not found).
pp_cmfr::getvariable [, desc=desc] [, s_line=s_line] [, s_dielimp=s_dielimp] [, s_mech=s_mech] [, s_shock=s_shock] [, s_xrayh=s_xrayh] [, s_xrayl=s_xrayl] [, freq=freq] [, intens=intens] [, lum=lum] [, dielimp=dielimp] [, line=line] [, mech=mech] [, rad=rad] [, shock=shock] [, radmech=radmech]Returns the variables selected from the corresponding keywords (see description below)
result = pp_cmfr::init(file)pp_cmfr::cleanuppp_cmfr__defineObject to read and interpret OBSFLUX-type files created by cmfgen:
Routine details
top source pp_cmfr::getall
result = pp_cmfr::getall( [desc=desc])
Returns a structure containing all the 6 scalars and 9 vectors read from the object (NaN for those not found).
Keywords
- desc out optional
A string array with the pairs of tag names and their descriptors in the result.
Examples
To read everything from the file 'OBSFLUX':
oobs=obj_new('pp_cmfr','OBSFLUX') ;reads 'OBSFLUX', though the file name is the same as the default
all=oobs->getall(desc=desc)
print,desc,format='(A10," ",A)'
; S_LINE Total Line luminosity
; S_DIELIMP Total Dielectronic and Implicit Recombination Luminosity
; S_MECH Total Mechanical Luminosity
; S_SHOCK Total Shock Luminosity
; S_XRAYH X-ray Luminosity (> 1 keV)
; S_XRAYL X-ray Luminosity (> 0.1 keV)
; FREQ Continuum Frequencies
; INTENS Observed intensity (Janskys)
; LUM Luminosity
; DIELIMP Dielectronic and Implicit Recombination Line Emission
; LINE Line Emission
; MECH Mechanical Luminosity
; RAD Total Radiative Luminosity
; SHOCK Total Schock Luminosity
; RADMECH Total (Rad. + Mech.) Luminosity
iplot,all.freq,all.intens ;plot the intensities
Author information
- Author:
Paulo Penteado (pp.penteado@gmail.com), Aug/2009
Statistics
| Lines: | 9 lines |
| Cyclomatic complexity: | 18 |
| Modified cyclomatic complexity: | 18 |
top source pp_cmfr::getvariable
pp_cmfr::getvariable [, desc=desc] [, s_line=s_line] [, s_dielimp=s_dielimp] [, s_mech=s_mech] [, s_shock=s_shock] [, s_xrayh=s_xrayh] [, s_xrayl=s_xrayl] [, freq=freq] [, intens=intens] [, lum=lum] [, dielimp=dielimp] [, line=line] [, mech=mech] [, rad=rad] [, shock=shock] [, radmech=radmech]
Returns the variables selected from the corresponding keywords (see description below)
Keywords
- desc out optional
An array string with the pairs of tag names and their descriptors in the result.
- s_line out optional
Total Line luminosity.
- s_dielimp out optional
Total Dielectronic and Implicit Recombination Luminosity.
- s_mech out optional
Total Mechanical Luminosity.
- s_shock out optional
Total Shock Luminosity.
- s_xrayh out optional
X-ray Luminosity (> 1 keV).
- s_xrayl out optional
X-ray Luminosity (> 0.1 keV).
- freq out optional
Continuum Frequencies.
- intens out optional
Observed intensity (Janskys).
- lum out optional
Luminosity.
- dielimp out optional
Dielectronic and Implicit Recombination Line Emission.
- line out optional
Line Emission.
- mech out optional
Mechanical Luminosity.
- rad out optional
Total Radiative Luminosity.
- shock out optional
Total Schock Luminosity.
- radmech out optional
Total (Rad. + Mech.) Luminosity.
Examples
To obtain the frequencies and intensities from a file 'OBSFLUX' and plot them:
oobs=obj_new('pp_cmfr') ;the default file name is 'OBSFLUX', so it is not necessary to provide it
oobs->getvariable,intens=intens,freq=freq
iplot,freq,intens
Author information
- Author:
Paulo Penteado (pp.penteado@gmail.com), Aug/2009
Statistics
| Lines: | 20 lines |
| Cyclomatic complexity: | 17 |
| Modified cyclomatic complexity: | 17 |
top source pp_cmfr::init
result = pp_cmfr::init(file)
Parameters
- file
Statistics
| Lines: | 65 lines |
| Cyclomatic complexity: | 34 |
| Modified cyclomatic complexity: | 34 |
top source pp_cmfr::cleanup
pp_cmfr::cleanup
Statistics
| Lines: | 5 lines |
| Cyclomatic complexity: | 3 |
| Modified cyclomatic complexity: | 3 |
top source pp_cmfr__define
pp_cmfr__define
Object to read and interpret OBSFLUX-type files created by cmfgen:
Uses pp_cmfread to do the low level reading and parsing, and returns a structure with the names and values read (see that function for details). pp_cmfread is more general, works with any file with a format like OBSFLUX or obs_fin (see the function for details).
The object pp_cmfr uses pp_cmfread, then tries to interpret the variable names to match with them with the physical quantities expected to be in the file.
The interesting methods are getall, and getvariable (see below).
Author information
- Author:
Paulo Penteado (pp.penteado@gmail.com), Aug/2009
Other attributes
- Uses:
Statistics
| Lines: | 22 lines |
| Cyclomatic complexity: | 33 |
| Modified cyclomatic complexity: | 33 |
File attributes
| Modification date: | Wed Jun 29 22:15:28 2016 |
| Lines: | 121 |
| Docformat: | rst rst |