Документ взят из кэша поисковой машины. Адрес оригинального документа : http://xmm.vilspa.esa.es/sas/5.4.1/doc/obssumm.ps.gz Дата изменения: Fri Jan 10 22:41:43 2003 Дата индексирования: Tue Oct 2 03:13:25 2012 Кодировка: Поисковые слова: annular solar eclipse

XMM-Newton Science Analysis System Page: 1
obssumm
January 10, 2003
Abstract
Create HTML summary page from Observation Data File (ODF) Summary File.
1 Instruments/Modes
Instrument Mode
EPIC ALL non-slew
RGS ALL non-slew
OM ALL non-slew
2 Use
pipeline processing yes
interactive analysis no
3 Description
obssumm will read input from the Observation Data File (ODF) ASCII le from each non-slew observation
and compile an HTML summary page of some information from this le. The summary page will contain
at least the following: PI name, target name, target position, pointing position, start and end dates and
times, exposure times and important modal parameter values from each instrument.
obssumm will read the desired information from each observation's ASCII summary le and produce
several tables; A Proposal Target Information table, an Observation table, a GO table, an Instrument
Information table and a Data Quality table on a single, coherent HTML page. This page represents the
\home page" for the distributed Observation Data set.
You must have the environment variable SAS ODF set in order for the OAL to return the correct summary
le name. obssumm currently uses odfexpand to return this le name, but in the future there should be
perl (pedal) OAL bindings to return this lename.
xmmsas 20030110 1802-5.4.1

XMM-Newton Science Analysis System Page: 2
4 Parameters
This section documents the parameters recognized by this task (if any).
Parameter Mand Type Default Constraints
useinle no boolean false truejfalse
Boolean switch to determine whether to input a lename for the ODF Summary Ascii le. False defaults
to retrieving the lename using odfexpand
inle no boolean None truejfalse
Filename of input ODF Summary le
inle no string None valid le name
Filename of input ODF Summary le
outle yes string None valid le name
Filename of output HTML le
logole no string None valid logo image le
name
Filename of XMM logo to be used as HTML page banner
usedataquality no boolean false truejfalse
Boolean switch to determine whether to print the DATA QUALITY records from the ODF Summary
Ascii le
makeemptyindices no boolean false truejfalse
Boolean switch causes empty indices to be generated.
indexkeys no string None PPSjEPICjRGSjOMjACDS
List of keys for the empty indices to be created.
indexnames no string None
List of lenames for empty indices. Names should have the same order as the indexkeys list.
5 Errors
This section documents warnings and errors generated by this task (if any). Note that warnings and
errors can also be generated in the SAS infrastructure libraries, in which case they would not be docu-
mented here. Refer to the index of all errors and warnings available in the HTML version of the SAS
documentation.
NoHTML (error)
No HTML written, could not parse enough from inle.
ODFFileNotExist (error)
ODF le does not exist.
xmmsas 20030110 1802-5.4.1

XMM-Newton Science Analysis System Page: 3
NoReadODF (error)
ODF le cannot be read.
ODFNotText (error)
ODF le is not a Text le.
RdOnlyOpenFailure (error)
Unable to open ODF le for reading.
WrtOnlyOpenFailure (error)
Unable to open HTML le for writing.
NoclobberOpenFailure (error)
Cannot open WRITE with noclobber set.
FileHandleFailure (error)
Unable to get new FileHandle
WriteHTMLFailure (error)
Failure to printf to output HTML le.
NoSLEWODFyet (error)
SLEW Observations not supported yet.
IndexUMMYUnmatchedParameter (error)
Parameters `indexnames' and `indexkeys' do not match.
IndexEmptyParameter (error)
`makeemptyindices' is true but no indexnames or indexkeys are provided.
IndexInvalidIndexKey (error)
A supplied indexkey is invalid
NoLogoBanner (warning)
No LOGO written to HTML.
corrective action:
NoPropTargetTbl (warning)
No Proposal Target Information table written to HTML.
corrective action:
NoObsRecTbl (warning)
No Observation Record table written to HTML.
corrective action:
NoGOInfoTbl (warning)
No Guest Observer Information table written to HTML.
corrective action:
NoInstInfoTbl (warning)
No Instrument Information table written to HTML.
corrective action:
NoCongTbl (warning)
No conguration table written to HTML.
corrective action:
NoDataQTbl (warning)
No Data Quality table written to HTML.
corrective action:
xmmsas 20030110 1802-5.4.1

XMM-Newton Science Analysis System Page: 4
ClobberingFile (warning)
File exists but noclobber NOT set: Overwriting le.
corrective action:
LogoFileNotExist (warning)
File logole does not exist.
corrective action:
NoReadLogoFile (warning)
File logole not readable.
corrective action:
LogoFileNotImage (warning)
File logole possibly not binary image le.
corrective action:
OBSKeysMissingInODF (warning)
File possibly NOT ODF Summ: OBSERVATION keyword missing
corrective action:
NlesSetToZero (warning)
Failed to parse number of FILES records
corrective action:
FILESKeysMissingInODF (warning)
File possibly NOT ODF Summ: Unable to parse FILES keyword.
corrective action:
INSTKeysMissingInODF (warning)
File possibly NOT ODF Summ: Unable to parse INSTRUMENT keyword.
corrective action:
PROPKeysMissingInODF (warning)
File possibly NOT ODF Summ: Unable to parse PROPOSAL keyword.
corrective action:
DataQKeysMissingInODF (warning)
File possibly NOT ODF Summ: Unable to parse DATA QUALITY keywords.
corrective action:
CannotParseOBS (warning)
Cannot parse OBSERVATION section.
corrective action:
BadFilenameFormat (warning)
File format for: value not correct
corrective action:
CannotParseFILES (warning)
Unable to parse FILES section.
corrective action:
CannotParseINSTRUMENT (warning)
Unable to parse INSTRUMENT section.
corrective action:
BadDataQualityRecord (warning)
Data Quality EXPID not correct format.
corrective action:
xmmsas 20030110 1802-5.4.1

XMM-Newton Science Analysis System Page: 5
CannotParseDATAQUALITY (warning)
Unable to parse DATA QUALITY section.
corrective action:
CannotParseGOinfo (warning)
Unable to parse Guest Observer section.
corrective action:
NoActiveFlag (warning)
No Active Flag found for inst - Determining from Quality Records.
corrective action:
NoNexp (warning)
No Nexposures found for inst - Determining from Quality Records.
corrective action:
NoPriority (warning)
No Priority value found for inst - Set to ?
corrective action:
6 Input Files
1. XMM Observation Data File Summary File
7 Output Files
1. HTML le, PxxxxxxxxxxOBxxxSUMMARxxxxx.HTZ
8 Algorithm
perl script obssumm
Parse command line
Open ODF ASCII Summary file
Read ODF ASCII Summary file into hashes
Close ODF ASCII Summary file
if (parsed at least one subsection successfully)
Open HTML file
Write standard HTML header
For each SECTION (OBS,GO,PROPOSAL,INSTRUMENT,FILES)
begin_table
write_table
end_table
EndFor
Write standard HTML footer
Close HTML file
end if
end perl script obssumm
xmmsas 20030110 1802-5.4.1

XMM-Newton Science Analysis System Page: 6
9 Comments
None.
10 Future developments
HTML le will be cosmetically improved. Links to other summary pages may be provided, although
this is heavily dependent on when each le (as well as the PPS Summary Index File) is produced in the
pipeline.
References
[1] Interface Control Document: Observation and Slew Data Files,XMM-SOC-ICD-0004-SSD Issue 2.4,
K. Galloway, December 15, 1999 Section 7.12, pgs 99-106.
References
xmmsas 20030110 1802-5.4.1