spi psd calclib User Manual
Contents
1. PSD library DOL for PSD library DOL for PSD library DOL for PSD library DOL for inlibDOL1 s ql inlibDOL2 s ql inlibDOL3 s ql inlibDOL4 s ql The output library Library arithmetics s ql 0 s ql 0 s ql 0 s ql 0 s ql 0 s ql 0 s ql 0 s ql 0 s ql 0 detid9 s ql 0 detidi0 s ql 0 detidil s ql 0 detidi2 s ql 0 outlibDOL s ql psd_library fits Detector Detector Detector Detector Detector Detector Detector Detector Detector COON OD rwpN ro Detector Detector 10 Detector 11 Detector 12 PSD result arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics PSD filename filename filename filename library DOL for filename 0 1 2 3 4 library DOL or filename spi_psd_calelib User Manual 3 detidi13 s ql 0 0 Detector 13 arithmetics detidi4 s ql 0 0 Detector 14 arithmetics detidi5 s ql 0 0 Detector 15 arithmetics detidi6 s ql 0 0 Detector 16 arithmetics detid17 s ql 0 0 Detector 17 arithmetics detidi18 s ql 0 0 Detector 18 arithmetics Standard parameters clobber b h yes Overwrite existing data structures Instead of specifying complete DOLs Data Object Locations which are composed of a filename plus the data struct2. Detector 12 Detector 13 Detector 14 Detector Detector 16 Detector 17 Detector Detector 3 2 Detector averaging LIB PSD PSD library DOL for filename 0 DOL for filename DOL for filename DOL for filename DOL for filename PSD PSD arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics OODONODOAFWNR OC arithmetics BPR e O arithmetics RK N arithmetics RK w arithmetics arithmetics HS arithmetics BR on arithmetics H a arithmetics arithmetics RK 1 2 3 4 result library DOL or filename There is one source file source file 0 from which the templates for all detectors are added This results in an average template for all 19 detectors which is stored in the result file inlibDOLO s ql libFM20 fits SPI inlibDOL1 s ql PSD library inlibDOL2 s ql PSD library inlibDOL3 s ql PSD library inlibDOL4 s ql PSD library LIB PSD PSD library DOL for filename 0 DOL for filename DOL for filename DOL for filename DOL for filename 1 2 3 4 spi_psd_calelib User Manual outlibDOL s ql libFM fits SPI LIB PSD PSD result library DOL or filename detidO s ql 0 detidi s ql 0 detid2 s ql 0 detid3 s ql 0 detid4 s ql 0 detid5 s ql 0 detid6 s ql 0 detid7 s
3. 0 or higher and spi_toolslib version 1 8 0 or higher After downloading the spi psd calclib tar gz file step into a directory that should hold the distribution move the spi psd calclib tar gz file into this directory and type don t type the prompt gunzip spi_psd_calclib tar gz tar xvf spi_psd_calclib 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 this type make distclean 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 To perform a unit test type make test spi_psd_calelib User Manual 3 Parameter file HAHHMARHAAAMA RAMA RMA RAMA ARAMA HRA RHEE RAMA RMA AMMA RARER RE Centre d Etude Spatiale des Rayonnements in collaboration with ISDC SPI PSD ANALYSIS BR 777 File spi_psd_calclib par Version 1 1 0 Component PA Author Juergen Knoedlseder knodlseder cesr fr CESR Purpose Parameter file of the SPI PSD library calculation executable History 1 1 0 1 Sep 2002 First ISDC delivery HAHHMARHAAAMA RAMA RMA RAMA ARAMA HRA RHEE RAMA RMA AMMA RARER RE The input library DOLs inlibDOLO s gl lib psd analysis std fits
4. symbol For example detid0 s q1 0 0 1 8 adds the templates for detector 0 from source file 0 and the templates for detector 8 from source file 8 to the result library for detector 0 If the arithmetic field is left empty nothing is done for the corresponding detector thus one could use also spi_psd_calclib to extract templates for a given detector from a library Blanks may be added deliberately to the arithmetic field The following examples illustrate the usage of the detector arithmetic fields 3 1 Copy a library There is one source file source file 0 which is copied into the result file No template adding is performed inlibDOLO s ql libFM20 fits SPI inlibDOL1 s ql PSD library inlibDOL2 s ql PSD library inlibDOL3 s ql PSD library inlibDOL4 s ql PSD library outlibDOL s ql libFM fits SPI LIB detid0 detidi detid2 detid3 detid4 detid5 detid6 detid7 detids detid9 detid10 s ql 0 s ql 0 s ql 0 s ql 0 s ql 0 detid15 s q1 0 detid18 s q1 0 0 s ql 0 s ql 0 s ql 0 4 6 s ql 0 s ql 0 8 s ql 0 10 detidil s ql 0 detidi2 s ql 0 detidi3 s ql 0 detidi4 s ql 0 15 detidi6 s ql 0 detidi7 s ql 0 18 Detector 1 2 3 Detector Detector Detector Detector Detector 6 Th oss Detector Detector Detector 9 Detector Detector 11
5. with the general syntax n a b c m d e f g h Here n and m are DOL source numbers hence they run from 0 to 4 For example 0 corresponds to the DOL specified by the parameter inlibDOLO 1 corresponds to the DOL specified by the parameter inlibDOL1 and so on a to h are placeholders and stand for PSD detector channels or detector identifiers in the range 0 to 18 For example detidO s ql 0 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 adds the templates for all PSD channels from the source DOL inlibDOLO to the result library for PSD channel 0 The same is achieved using detid0 s ql1 0 0 18 hence the operator allows the specification of detector ranges The start and or the end detector identifier may also be omitted The four fields 0 0 18 0 18 0 0 0 are identical and specify all 19 detectors from the source DOL inlibDOLO Comma separated detector identifiers have the special functionality of toggling between detectors For example 0 3 3 means that no detector is selected The first 3 signals to use detector 3 while the second 3 deletes detector 3 from the list of detectors that should be used The above example is of course not very meaningful However 0 3 makes much more sense since now all detectors except of detector 3 will be used the selects all detectors while the 3 deletes detector 3 from the list spi_psd_calelib User Manual Templates from different source files may be added using the
6. ber sn and run number rn These keywords are character strings of 19 digits in length where 0 and 1 signifies that a detector was not selected or selected respectively for building the library template for detector id from source sn Each of the 19 digits stands for an individual source detector with detector identifier 0 as the left most digit These keywords are built by interpreting the arithmetic fields detidid of the spi_psd_calclib par parameter file NCRVidrn summarises the total number of pulse shapes that are finally at the end of the run in all templates of each detector id These keywords are identical to the keywords that are set by the task spi_psd_buildlib and allow a global tracking of the library template content 5 Error codes The executable spi_psd_calclib may stop with the following error codes SPI_PSD_CALCLIB_ERROR_MEM_ALLOC 230500 SPI_PSD_CALCLIB_ERROR_NO_INDOL 230501 SPI_PSD_CALCLIB_ERROR_NO_DELETE 230502 They have the following meaning e SPI_PSD_CALCLIB_ERROR_MEM_ALLOC the allocation of dynamical memory has failed Probable your system resources are too limited to run this task e SPI_PSD_CALCLIB_ERROR_NO_INDOL no input DOL has been specified spi_psd_calclib needs at least one input DOL to work properly e SPI_PSD_CALCLIB_ERROR_NO_DELETE although clobber yes has been specified spi psd calclib was unable to delete an existing library DOL using DAL routines Probably the library DOL is a child of an
7. or usage for detector O DU010001 1111111111111111111 Source 0 detector usage for detector 1 DU180001 1111111111111111111 Source 0 detector usage for detector 18 723 Number of curves in library for detector 723 Number of curves in library for detector NCRVO001 NCRVO101 NCRV1801 723 Number of curves in library for detector Program that created this FITS file Software configuration Number of runs in library Run 1 creating task Run 1 task configuration PSD Source 0 18 The keyword NRUNS indicates how many runs have contributed to build the library templates that are in this file If the output library file already existed templates are added to the exisiting templates hence the run history keeps track of the various sources of the templates Following NRUNS there are keywords which are added for each run the run number rn is given by the last two digits of the keywords spi_psd_calelib User Manual 6 CREATOrn and CONFIG rn specify the creating application and version number If you used spi_psd_calclib to create the template you ll find spi_psd_calclib and the actual version number after these keywords SRCEsnrn specifies the source DOL for source number sn and run number rn These keywords reflect the DOLs you specified by the parameters inlibDOLrn of the spi psd calclib par parameter file DU idsnrn reflects the detector selection that has been made for detector identifier id source num
8. other group Therefore delete the output library DOL by hand before executing spi_psd_calclib In addition all errors that may occur in calls to ISDC support functions such as for example DAL RIL PIL spi_psdlib or spi_toolslib are forwarded Please consult the ISDC web pages and the corresponding User Manuals for getting information about these error codes
9. ql 0 detid8 s ql 0 detid9 s ql 0 detid10 s ql 0 detidil s ql 0 detidi2 s ql 0 detidi13 s ql 0 detidi4 s ql 0 detidi5 s ql 0 detidi6 s ql 0 detid17 s ql 0 detidi18 s ql 0 Detector Detector Detector Detector Detector Detector Detector Detector Detector Detector s Detector s Detector s Detector s Detector s Detector s Detector s Detector s Detector s Detector 4 Interface definition COON OD rwpN ro RR RF RHR REF ON O GE WNP CO arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics arithmetics On input spi_psd_calclib reads a list of library templates of HDU type SPI LIB PSD No specific keyword is required in these data structures On output spi_psd_calclib produces library templates for all 19 detectors based on the input templates and combined following the arithmetic parameters The 19 libraries are stored in a single file of HDU type SPI LIB PSD to which the following keywords are added CREATOR spi_psd_calclib CONFIGUR 1 1 0 NRUNS 1 CREATOO1 spi_psd_calclib CONFIGO1 1 1 0 O SRCEOOO1 1libFM20 fits SPI LIB DU0000041 1111111111111111111 Source 0 detect
10. spi_psd_calclib User Manual Version 1 1 0 1 September 2002 Jurgen Knodlseder Centre d Etude Spatiale des Rayonnements knodlseder cesr fr http www cesr fr jurgen index html spi_psd_calelib 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_psd_calelib User Manual Contents 1 Introduction 2 Getting started 3 Parameter file 3 1 Copy a library 3 2 Detector averaging 4 Interface definition 5 Error codes il spi_psd_calelib User Manual 1 1 Introduction The executable spi_psd_calclib allows to perform ar thmetics on PSD template libraries such as template addition and averaging It may also be used to copy library templates from one detector to another spi psd calclib is written in the ANSI C language It has been developped under ISDC support platform 4 1 and requires the libraries spi_psdlib version 1 6 0 or higher and spi_toolslib version 1 8 0 or higher 2 Getting started Before installing spi_psd_calclib make sure that the ISDC support platform 4 1 or higher is installed on your system and that you have installed the libraries spi_psdlib version 1 6
11. ure extension HDU spi_psd_calclib accepts also simple filenames and adds the appropriate data structure extensions This means that specified data structure extensions are ignored The parameters have the following meaning e inlibDOLn specifies the input library DOLs or filenames where n runs from Oto 4 A blank parameter name means that no DOL has been specified At least one DOL or filename is needed for task execution e outlibDOL specifies the library DOL or filename to which the results will be written The performed action sensitively depends on the clobber parameter If clobber yes an existing template library that resides in the output file will be overwritten If clobber no the selected templates will be added to those that reside already in the template library e detidn specifies the arithmetics that should be done to produce the result library templates for detector n see below for more details about the arithmetics fields e clobber specifies if existing output data structures should be overwritten or not If yes is specified the executable will notify the user about the deletion of any file see also out1ibDOL The detector arithmetic fields specify the library templates that should be added from the source template files into the result library template file There is one such field per detector channel and each field specifies the templates that should be added for this detector The arithmetic field is a character field
Download Pdf Manuals
Related Search