spi tmscan User Manual
Contents
1. the pointing identifier PPPP is extracted from the CDMU packet if the CDMU packet PID is larger than the actual PPPP see ISDC TECH018 6 Error codes The following error codes may be returned by spi_tmscan SPI_TM2FITS_ERROR_BASE SPI_TM2FITS_ERROR_MEM_ALLOC SPI_TM2FITS_ERROR_EOF SPI_TM2FITS_ERROR_FILE_ERROR SPI_TM2FITS_ERROR_INVALID_BUFFER 10000 Error base 10000 Memory allocation error 10001 End of file reached 10002 TM file error 10003 Invalid buffer2. this type make distclean spi_tmscan User Manual 2 Then configure the distribution It is assumed here that you have previously installed the ISDC support platform thus you should type bin ac_stuff configure Finally build the distribution by typing make global_install spi_tmscan User Manual 3 Parameter file RRRRHRRRRERIRRRRRRRRIRRRRRIRRRRIRRRRRIRRRIRRHRRRIRRERIRRHRRRHHREISHHHIHHEIRHHHET EEE Centre d Etude Spatiale des Rayonnements in collaboration with ISDC PRE PROCESSING File spi_tmscan par Version 1 3 0 Component pp Authors Juergen Knoedlseder knodlseder cesr fr CESR Purpose Parameter file of the SPI TM scanner Revision History Version 1 3 0 18 Jul 2002 JK First ISDC version rev 3 H HHH HH HHH HHHHHH HHH HHH HH FH H HHH HH HHH HHHHHH HHH HHH HH FH HHFHHHHHHAHHHHRHHAAHHA RHR HHA RHEE RHR RHHH RRR RHEE RRR RREA RRR ER RRR Path name definition 2 2 2 2 2 2 2 2 2 2 2 222 tmpath s h x02 tm TM Base Path base s h villa 1 jurgen arc tst_tm Repository Base Path cfgbase s h users jurgen isdc templates Template Base Path TM input definition 2 2 2 2 2 2 2 2 2 2 22 2 2 nfirst i ql 419 First TM file number nlast i ql 419 Last TM file number pktmin i ql 26048 1 10000000 First packet to scan in first TM file pktmax i ql 61927 1 10000000 Last packet to scan in last TM file header i h 0 Head
3. _cobt swg_create swg_clean spi_evts_obt_calc dp_hkc dp_spi_psd dp_status_gen dp_aux_attr spi_psd_adcgain spi_psd_efficiency spi_psd_performance spi_psd_si Pr OO sys sw sys sw sys sw sys sw sys sw sys sw sys sw sys sw u et N zu re ee u u N u RP KB EB Wr WWOOANWAFrRFEN HPN OPN r oo OC OC FRO Since the upwards compatibility of the software should be assured higher software version numbers should also be possible Software models flagged by sys sw are part of the ISDC system software and can be obtained at the ISDC web site http isdce unige ch The above mentioned versions are also available as bundle at the author s web site http www cesr fr jurgen isdc where also all other software can be found 2 Getting started Before installing spi_tmscan make sure that the ISDC support platform 4 1 or higher is installed on your system and that the libraries spi_psdlib and spi_toolslib are also available please consult the WWW site http www cesr fr jurgen isdc if these libraries are not available on your system After downloading the spi_tmscan tar gz file step into a directory that should hold the distribution move the spi_tmscan tar gz file into this directory and type gunzip spi_tmscan tar gz tar xvf spi_tmscan tar The first command uncompresses the distribution file the second unpacks the files Before configuration the distribution needs to be reset to a clean state To do
4. ag OTF makes a verifiable change A verifiable change means that the OTF must be stable for at least notf consecutive readouts of the OTF value from the CDMU packet Note that cutOTF is only considered if cutPoint is yes e cutPerigee specifies if a new science window should be created if the revolution number changes e cutTime specifies if a new science window should be created if the time period specified by timescw has been exceeded This allows to cut fixed pointing observations into smaller pieces spi_tmscan User Manual 6 4 timescw specifies the time interval for science window cutting using the timeout mechanism cutTime yes notf specifies the required number of stable OTF flag readings for a science window cut to occur If the minimum value of 0 is specified a single OTF change will lead to a science window cut autolauch specifies f spi_tmscan should automatically launch the processing of the telemetry using the processing script specified by the parameter script shell specifies the UNIX shell that should be used for the processing script The user has to make sure that the shell initialisation script sets the ISDC environment variables correctly script specifies the ISDCROOT script that should be used for telemetry processing A standard script comes with the software distribution clobber ISDC standard parameter see Common User Manual mode ISDC standard parameter see Common User Manual Interface definit
5. ber 1 A packet is defined as a 440 Bytes block in the telemetry binary file If pktmax is larger than the number of available packets the telemetry file is analysed until the end of the file is reached e header specifies the number of Bytes in the telemetry binary file header Earlier versions of the PktAll files had a header attached The actual version do not have a header anymore hence as default 0 should be specified spi_tmscan User Manual 5 e timechk specifies the TM scanning cycle in seconds If the end of the telemetry file has been reached spi_tmscan is put into sleep for the specified period in order to liberate processor capacities After the period spi_tmscan wakes up and checks if new TM has been received If yes the new TM is scanned Otherwise spi_tmscan is put into sleep for another cycle e timeout specifies the TM scanning timeout in seconds after which spi_tmscan stops execution if no new TM has been received e previd specifies the science window identifier of the last science window that has been processed before starting spi_tmscan The information is used to establish a continuous link of telemetry If no previous science window exists this parameter may be set to 000000000000 e revno specifies the revolution number of the first science window that will be created by spi_tmscan e pointid specifies the pointing identifier of the first science window that will be created by spi_tmscan The minimum pointing id
6. entifier is 0000 e subid specifies the subdivision identifier of the first science window that will be created by spi_tmscan The minimum subdivision identifier is 001 e scwtype specifies the type of the first science window that will be created by spi_tmscan The following types are allowed 0 is a pointing 1 is a slew and 2 is any other science window type e version specifies the science window version number The version number will not be changed by spi_tmscan e bcpid specifies the Broadcast packet identifier for the telemetry to be stored in the headers of the RAW data structures e cutOPER specifies if a new science window should be created if a transition from or to the OPER mode occurs e cutCALB specifies if a new science window should be created if a transition from or to the CALIB mode occurs e cutDIAG specifies if a new science window should be created if a transition from or to the DIAG mode occurs e cutEMER specifies if a new science window should be created if a transition from or to the EMER mode occurs e cutSTB1 specifies if a new science window should be created if a transition from or to the STANDBY1 mode occurs e cutSTB2 specifies if a new science window should be created if a transition from or to the STANDBY2 mode occurs e cutPoint specifies if a new science window should be created if the pointing identifier changes e cutOTF specifies if a new science window should be created if the On Target Fl
7. er size in Bytes timechk i ql 60 TM scanning cycle sec timeout i ql 300 TM scanning timeout sec First SCW definition 2 2 2 2 2 2 2 2 2 2 2 222 previd s hl 000000000000 Previous SCW ID revno i hl 9001 Revolution Number pointid i hl 0000 Pointing ID minimum is 0000 subid i hl 001 Subdivision ID minimum is 001 scwtype i hl 2 0l1 2 Science Window Type O pointing 1 slew 2 other version i hl 1 Version number bepid s hl 00000000 Broadcast packet ID spi_tmscan User Manual 4 SCW cut definition cutOPER b hl yes New SCW if OPER mode change cutCALB b hl yes New SCW if CALIB mode change cutDIAG b hl yes New SCW if DIAG mode change cutEMER b hl yes New SCW if EMER mode change cutSTB1i b hl no New SCW if STANDBY1 mode change cutSTB2 b hl no New SCW if STANDBY2 mode change cutPoint b hl yes New SCW if pointing change cutOTF b hl no Consider OTF for pointing change cutPerigee b hl yes New SCW at perigee passage cutTime b hl yes New SCW if time exceeded timescw i hl 3600 0 1000000 Maximum SCW length sec maxgap i hl 1800 0 32000 Maximum time gap sec notf i hl 3 0 10000 Requested number of stable OTF flags Automatic processing parameters autolaunch b hl no Automatically lau
8. ion The task spi_tmscan does not produce any data structures The telemetry file in the CESR GSE format PktAll are scanned and some relevant information such as On Event Messages and telemetry gaps are recorded into a LOG file If requested spi_tmscan starts a processing pipeline that converts the raw telemetry data into ISDC compliant FITS data structures 5 Algorithm The science window ID has always the following form RRRRPPPPSSSF where RRRR is the revolution number of the spacecraft as defined from the perigee to perigee passage PPPP is the pointing number within the revolution and is always reset to 0000 when the revolution number increments SSS is the subdivision number for a science window with a given RRRR and PPPP value The minimum value of SSS is 001 and always resets with a change of value of PPPP F is the type identifier with the allowed values of 0 for a pointing 1 for a slew and 2 for other science window types The following table summarises the science window ID changes that occurs after a given boundary has been reached Science window boundaries that are implemented in spi_tmscan are SPI mode transitions SPI reset timeout slew spi_tmscan User Manual e pointing e perigee passage Boundary Mode transition SPI reset Timeout Slew Pointing Perigee RRRR PPPP F Comments may occur if data loss if the current revolution number in the CDMU packet corresponds to RRRR
9. nch processing shell s hl bin csh Processing shell script s hl spi_tmscan_process C Processing script Standard parameters clobber b h no Clobber Flag mode S h gi The parameters have the following meanings e tmpath specified the directory which holds the PktAll telemetry files in the CESR GSE format in this format telemetry frames are stored as successive blocks of 440 Bytes in a single binary file e scwbase specifies the Science window base path into which the science window data structures should be written e cfgbase specifies the absolute directory in which the science window group configuration files will be found Normally the directory where the data structure templates are found should be specified e nfirst specifies the file number of the first PktAll telemetry file that should be processed e nlast specifies the file number of the last PktAll telemetry file that should be processed e pktmin specifies the first packet in the first telemetry binary file specified by the parameter nfirst that should be processed the first packet has the packet number 1 A packet is defined as a 440 Bytes block in the telemetry binary file If pktmin 1 pre processing starts from the beginning of the telemetry file e pktmax specifies the last packet in the last telemetry binary file specified by the parameter nlast that should be processed packets start from num
10. spi_tmscan User Manual Version 1 3 1 7 August 2002 J rgen Kn dlseder Centre d Etude Spatiale des Rayonnements knodlseder cesr fr http www cesr fr jurgen index html spi_tmscan User Manual Note to the user This software has been written to analyse data of the SPI telescope onboard INTEGRAL Particular care has been taken in making the software user friendly and well documented If you appreciated this effort and if this software and User Manual were useful for your scientific work the author would appreciate a corresponding acknowledgment in your published work il spi_tmscan User Manual Contents 1 Introduction 2 Getting started 3 Parameter file 4 Interface definition 5 Algorithm 6 Error codes il spi_tmscan User Manual 1 1 Introduction The executable spi_tmscan scans the INTEGRAL SPI telemetry in the format of the CESR GSE aquisition system PktAll and launches the data processing queue that converts the data into ISDC compliant FITS files In particular spi_tmscan implements the cut of the data stream in so called science windows The algorithm that has been implemented follows closely the ISDC tech note ISDC TECO18 Version 2 1 8 March 2002 with some small deviations that are explained below spi_tmscan has been written in the ANSI C language and requires the following software to be installed on the system support sw spi_toolslib spi_psdlib spi_tm2fits tools_lib spi_merge_schk dp_spi
Download Pdf Manuals
Related Search