Документ взят из кэша поисковой машины. Адрес оригинального документа : http://xmm.vilspa.esa.es/sas/6.1.0/doc/hkstrip.ps.gz Дата изменения: Mon Nov 22 22:48:36 2004 Дата индексирования: Tue Oct 2 03:18:16 2012 Кодировка: Поисковые слова: meteor shower

XMM-Newton Science Analysis System Page: 1
hkstrip
November 22, 2004
Abstract
Remove unneeded columns from housekeeping data.
1 Instruments/Modes
Instrument Mode
EPIC ALL
RGS ALL
OM ALL
2 Use
pipeline processing yes
interactive analysis yes
3 Description
This task takes as input a housekeeping le from any of the instruments, and removes from it any
`columns' whose data is determined to not be useful for subsequent data processing. It is assumed that
which HK parameters are useful could change over the life of the mission. Thus the list of parameters
to be retained is taken as an input to the task. The output of the task should be an OGIP compliant
FITSle, suitable for producing GTI les.
The TIME column of ODF compliant house keeping les will be a string in the format yyyy-mm-ddThh:mm:ss.
In order for the HK data to be in a useful format for plotting, producing GTI les, etc., hkstrip will
convert the TIME column of ODF les to seconds since the XMM reference time. Note that this con-
version is done only for ODF les, ie. when the parameter useodf = true. If the input to the task is
an ODF le (useodf = true), then the ODF directory (designated by an enviormental variable or on the
command line) is searched for the le. In this case the set parameter can be either an ODF compliant
le name, or an OAL style ODF le specication.
It would also be useful if this task could check all HK columns to see if they are constant throughout the
HK data. If they are, the column could be deleted and replaced with a keyword value in the binary table
extension, resulting in a potentially large space savings. This check could be fairly cpu intensive, and is
xmmsas 20041122 1834-6.1.0

XMM-Newton Science Analysis System Page: 2
not viewed as crucial to the task. Thus it is possible this feature may be deferred to a later version of
the task.
4 Parameters
This section documents the parameters recognized by this task (if any).
Parameter Mand Type Default Constraints
set yes set None valid data set name
Filename of the full house keeping le.
outset yes set hkfile.fits valid data set name
Filename of the stripped house keeping le.
paramnames yes string
TIME
None
Space separated list of HK parameter columns to retain.
table yes string
PERIODIC HK
None
Name of extension containing the HK table.
useodf no boolean true true|false
Take the input le to be an ODF le specication
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.
BadODFname (error)
The le name in set is not a valid ODF le specication.
xmmsas 20041122 1834-6.1.0

XMM-Newton Science Analysis System Page: 3
6 Input Files
1. EPIC MOS HK data (from EPIC MOS Periodic Housekeeping File).
2. EPIC p-n HK data (from EPIC p-n Periodic Housekeeping File).
3. RGS p-n HK data (from RGS p-n Periodic Housekeeping File).
4. OM HK data (from OM Periodic Housekeeping File).
5. OM non-Periodic HK data (from OM non-Periodic Housekeeping File).
6. ERM data (from ERM Count Rate File).
7. Spacecraft Attitude data (from Spacecraft Attitude History File).
8. Spacecraft HK data (from Spacecraft Periodic Housekeeping Files).
7 Output Files
1. Stripped version of input HK le (for input to HKSELECT and HKPLOT).
8 Algorithm
subroutine hkstrip
Read_Parameters
Make_Column_List
Open_Input_File
Open_Output_File
Initialize(Output_File)
Copy_Keywords(Input_File, Output_File)
do
Move_to_next_column
Get_Column_Name
if (Column_Name == "TIME" && input_is_odf_file && column_type == string)
convert_column_to_seconds
for each Column_List entry
if (Column_Name == Column_List(entry))
Copy_Column(Column_Name, Input_File, Output_File)
end if
next
next
Close_Files
end subroutine hkstrip
xmmsas 20041122 1834-6.1.0

XMM-Newton Science Analysis System Page: 4
9 Comments
None.
10 Future developments
It would also be useful if this task could check all HK columns to see of they are constant throughout
the HK data. If they are, the column could be deleted and replaced with a keyword value in the binary
table extension, resulting in a potentially large space savings.
References
xmmsas 20041122 1834-6.1.0