6. the include files

File alphabetic list

File subject list

VOS, user interface and general

XAS file support

accumulation support

attitude

graphics

SAX instrument support

• accumcommon

  include file		Fortran code
  Usage	define ACCUMCOMMON block used by accumulation program and relevant PARAMETER constants
  Content	COMMON	ACCUMCOMMON
  	COMMON	ACCUMCOMMONC
  	INTEGER PARAMETER	ACCUMCOMMON_MAXDIM

  According to usual practice there are two separate common blocks, one for numeric and one for character variables. Both sets of variables have names prefixed with ACCUMCOMMON_. The meaning and full list of variables is documented in the code header. These variables are filled dynamically by the various programs, and contain information about the current accumulation packet (typically a direct mode one), the quantities chosen, the time limits, the decoded values of quantities for the current event.
  Some of these quantities are arrays dimensioned to ACCUMCOMMON_MAXDIM, the maximum number of fields present for an event (currently fixed to 16, which is the maximum for HPGSPC packets).

  ---

• accumindir

  include file		Fortran code
  Usage	define ACCUMINDIR block used by accumulation program and relevant PARAMETER constants
  Content	COMMON	ACCUMINDIR
  	INTEGER PARAMETER	ACCUMINDIR_MAXDIM

  This is an additional common block used to hold the data structures necessary for accumulation involving indirect mode data which do not fit into ACCUMCOMMON. Of these the most important is a buffer array ACCUMINDIR_HISTOGRAM, used to hold a raw spectrum read from a packet, and dimensioned to the maximum size ACCUMINDIR_MAXDIM (currently fixed to 4096 channels as required by HPGSPC).

  ---

• auxrecord

  include file		Fortran code
  Usage	buffer space for "ASCII HK" accumulations
  Content	COMMON	AUXRECORD

  Contains two arrays of integer and real values decoded from an ASCII HK telemetry record (actually pseudo-telemetry, i/.e. ground-generated orbit or attitude data).

  ---

• b1s1local

  include file		Fortran code
  Usage	cyclic buffer shared between time binning and exposure processing routines and relevant PARAMETER constants
  Content	COMMON	B1S1LOCAL
  	INTEGER PARAMETER	ICIRC

  This common block is used to communicate between the exposure_b1s1 and exposure_b1s3 routines on one side and timebin_b1s1 on the other side. It mantains a circular buffer of start and end times of the last ICIRC packets, with also an array of flags indicating whether the packets follow without jumps or not, and a pointer to the current packet.
  The size ICIRC has been empirically tuned to 3000 packets.

  ---

• bigbuf

  include file		Fortran code
  Usage	shared buffer for image file i/o
  Content	COMMON	BIGBUF

  This common is used by create_image and read_image to share space for a silly data buffer.

  ---

• bincommon

  include file		Fortran code
  Usage	define BINCOMMON common block used by all programs dealing with binary table XAS files and relevant PARAMETER constants
  Content	COMMON	BINCOMMON
  	INTEGER PARAMETER	BINCOMMON_MAXTABLES, BINCOMMON_MAXFIELDS

  The BINCOMMON common block holds the binary table descriptors managed by many routines like copy_table_desc get_table_desc set_table_desc etc.

  There are as many elements in the descriptor arrays as the maximum number of tables BINCOMMON_MAXTABLES (which is currently equated to the maximum number of XAS files defined in HCOMMON, i.e. up to all XAS files can be tabular), and as the maximum number of columns in a table BINCOMMON_MAXFIELDS (currently fixed to 16 for consistency with the maximum number of event fields for a photon defined in ACCUMCOMMON.
  For this reason 'hcommon.inc' must be explicitly included before referencing this include file.

  The descriptor arrays are the type or bit width (BITPIX in FITS parliance) of a column, its dimensionality or depth, and a number associating a logical column with its physical position or order.

  ---

• clientside

  include file		Fortran code
  Usage	define data buffer for communication between graphics clients and server
  Content	COMMON	CLIENTSIDE

  All the low level graphics routines in graphserv library share this buffer to save space. The buffer holds space for the data sent by a client on the communication channels, which according to the specification of XAS graphics are represented by an opcode followed by a number of operands. These operands may be integer, real or character and all share the same space in the buffer after the opcode.
  The dimension of the buffer is set by PARAMETER constants defined in 'graphlimit.inc' which is automatically referenced by clientside.inc.

  ---

• context

  include file		Fortran code
  Usage	define the "context" CTXCOMMON common block
  Content	COMMON	CTXCOMMON

  A trivial COMMON used by many routines in xaslib to hold the current instrument name and the current context (the context is the type of data requested for output, e.g. spectra, images, matrices etc.) once they have been retrieved from XAS environment variables.

  ---

• debcommon

  include file		Fortran code
  Usage	dedicated to planned deblurring correction
  Content	COMMON	DEBCOMMON
  	COMMON	DEBCCOMMON

  Reserved for future accumulation programs capable of deblurring image positions according to attitude.

  ---

• errors

  include file		Fortran code
  Usage	definition of VOS error codes
  Content	INTEGER PARAMETER	VE_NAME

  All symbolic constants defining VOS error codes are associated a numeric value in this file. For better legibility programs shall use the named mnemonics (i.e. VE_NOFILE for a "file not found" error is better than "code 102")
  See the error listings for details.

  ---

• graphlimit

  include file		Fortran code
  Usage	define PARAMETER constant to size data buffer for communication between graphics clients and server
  Content	INTEGER PARAMETER	FULLBUFSIZE and derived

  The buffer used to exchange data over communication channels between graphics servers (which must include this file together with 'psserver,inc' or 'xserver.inc') and clients (which include 'clientside.inc') is sized here to 1026 bytes of full length (additional constants are derived internally to define the same length or parth thereof for other datatypes).
  Note that the f2x C routine defines the same common blocks used by xserver, as a C struct which is sized by separate #defines which must be edited manually consistently with eventual changes in FULLBUFSIZE.

  ---

• hcommon

  include file		Fortran code
  Usage	define HCOMMON common block used by all programs dealing with XAS file headers, and relevant PARAMETER constants.
  Content	COMMON	HCOMMON
  	COMMON	HCCOMMON
  	COMMON	MINIH
  	INTEGER PARAMETER	HCOMMON_TOP
  	INTEGER PARAMETER	HCOMMON_MAXFILES

  This file defines separately two logical areas, the HCOMMON buffer array (with space for the headers of all open XAS files) and the MINIH buffer holding the mini-header of the "current" file.

  According to usual practice, in HCOMMON there are two separate common blocks, one for numeric and one for character variables. Both sets of variables have names prefixed with HCOMMON_. The meaning and full list of variables is documented in the code header.
  The variables which must be arrays with one element per open XAS file (and not just refer to the current file or to global properties) are size to HCOMMON_MAXFILES (the current maximum is 8 XAS files).
  The character part includes an array of header buffers (each one originally sized to HCOMMON_TOP bytes (currently 2048) and an array of mini-header buffers (the "current" of which is copied to MINIH described below). Header buffers contain a full binary image of a file hader read from disk, and if a space larger than HCOMMON_TOP is necessary, routines like h_load_header take care of dynamic re-allocation.

  The MINIH mini-header is a trivial 28-byte object whose pieces are defined here by EQUIVALENCE.

  ---

• hkcommon

  include file		Fortran code
  Usage	define common block for HouseKeeping data handling
  Content	COMMON	HKCOMMON

  The HKCOMMON block contains variables (whose meaning and full list of variables is documented in the code header) used to handle HK (HouseKeeping) parameters, and to decode them according to the specification of the PCFs.

  ---

• hsizes

  include file		Fortran code
  Usage	define PARAMETER constant for maximum header keyword size
  Content	INTEGER PARAMETER	MAXKEYBUF and derived values

  Routines dealing with header keywords (and programs doing special dealings with keywords) require to know the maximum size of the keyword data area. Since a complete keyword requires the binary space for 8 bytes for the name, 1 byte for the type and 1 byte for the length, and cannot exceed 256 bytes (because the length itself is coded in a byte), the maximum data area could potentially be 256-10 byte long. However the choice is to define MAXKEYBUF to 78 bytes, which gives a a data area of 68 bytes which is consistent with the longest FITS character keyword value. The restrictions on the number of elements in numeric array keywords descend from such choice.

  ---

• instkeys

  include file		Fortran code
  Usage	support to PDS instrument-specific header keywords

  unsupported by the author of the present document

  ---

• labc1

  include file		Fortran code
  Usage	used by lb_ routines
  Content	COMMON	AXES (no detail given)

• labco

  include file		Fortran code
  Usage	used by lb_ routines
  Content	COMMON	GENERAL (no detail given)

  A couple of vestigial common blocks as used by the original "Labeller" program from which these routines were derived.

  ---

• lecommon

  include file		Fortran code
  Usage	define common block for LECS event corrections and relevant PARAMETER constants
  Content	COMMON	LECOMMON

  ---

  This common block contains all coefficients necessary for the various LECS event corrections. LECS event correction is not officially supported and is freely mimicked on the MECS event correction.
  The meaning and full list of variables is documented in the code header.

• mecommon

  include file		Fortran code
  Usage	define common block for MECS event corrections
  Content	COMMON	MECOMMON
  	COMMON	MECCOMMON

  This common block contains all coefficients necessary for the various MECS event corrections. The meaning and full list of variables is documented in the code header. According to usual practice there are two separate common blocks, one for numeric and one for character variables.

  ---

• megaincommon

  include file		Fortran code
  Usage	common block for the MECS gain relation
  Content	COMMON	GAINCOMMON

  Contains coefficients for the gain (energy-PHA channel) relation used during MECS matrix computation by routines like coda, spread and eout. The meaning and full list of variables is documented in the code header.

  ---

• opcommon

  include file		Fortran code
  Usage	common block for observing period times
  Content	COMMON	OPCOMMON

  A simple common block used by accumulation program to keep the start and end time of the current observation chain in a variety of formats. The meaning and full list of variables is documented in the code header.

  ---

• pdscoef

  The following include files, used for PDS matrix computation, are unsupported by the author of the present document

  include file		Fortran code
  Usage
  Content

• pdsmat

  include file		Fortran code
  Usage
  Content

• pdsnaipsa

  include file		Fortran code
  Usage
  Content

  ---

• pencommon

  include file		Fortran code
  Usage	define PENCOMMON common block for graphics clients
  Content	COMMON	PENCOMMON

  Keeps basic information like pen colours and plotting window corners. The meaning and full list of variables is documented in the code header.

  ---

• pixcommon

  include file		Fortran code
  Usage	common block for pixel to celestial coordinate transformation
  Content	COMMON	PIXCOMMON
  	COMMON	PIXCCOMMON

  This area contains coefficients used by unofficial programs used to handle celestial coordinates According to usual practice, there are two separate common blocks, one for numeric and one for character variables. The meaning and full list of variables is documented in the code header.

  ---

• psserver

  include file		Fortran code
  Usage	define F2C common block and PARAMETER constants relevant to Postscript graphics server
  Content	COMMON	F2C
  	COMMON	F2CC
  	REAL PARAMETER	PTS_PER_INCH, CM_PER_INCH and derived

  The logical F2C common block is used by a graphics server to keep its internal status. The PostScript server uses for convenience the same names for the F2C common defined for 'xwserver.inc' although the data types of some elements may be different. According to usual practice, in F2C there are two separate common blocks, one for numeric and one for character variables. The meaning and full list of variables is documented in the code header.
  The 'graphlimit.inc' file must be referenced before this one, since some PARAMETERs defined there are used for dimensioning.

  In addition some trivial parameters useful in writing PostScript code are defined here.

  ---

• radiant

  include file		Fortran code
  Usage	defines PI and degree-to-radians constants
  Content	PARAMETER DOUBLE PRECISION	PI,DTOR

  Defines two trivial constants. Use the idiom RADIANT = DEGREE*DTOR to convert degrees to radians.

  ---

• runstring

  include file		Fortran code
  Usage	define XRCOMMON common block used by user interface routines and relevant PARAMETER constants
  Content	COMMON	XRCOMMON
  	COMMON	XRCCOMMON
  	INTEGER PARAMETER	MAXRUN

  This common block is used by the x_read routine and related to hold variables related to the user interface (initialized in system dependent way by blkxrcommon).
  According to usual practice, in XRCOMMON there are two separate common blocks, one for numeric and one for character variables. Both sets of variables have names prefixed with XRCOMMON_. The meaning and full list of variables is documented in the code header.

  In addition parameter MAXRUN defines the maximum size of a run string. This is used also by some other routines and programs.

  ---

• saxfot

  include file		Fortran code
  Usage	common block for fotfile program
  Content	COMMON	SAXFOT

  This common block is used by tape command generation routines to store internal information. The meaning and full list of variables is documented in the code header.

  ---

• servers

  include file		Fortran code
  Usage	define PIPECOMMON common block with graphics server communication channel status
  Content	COMMON	PIPECOMMON
  	COMMON	PIPECCOMMON
  	INTEGER PARAMETER	MAXSERVER

  This common block is used by the programs which control graphics servers and by the communication channel handling routines to keep track of the status of registered graphics servers.
  According to usual practice, in PIPECOMMON there are two separate common blocks, one for numeric and one for character variables. Both sets of variables have names prefixed with PIPECOMMON_. The meaning and full list of variables is documented in the code header.
  Some of the variables are arrays sized to MAXSERVER (currently 9), the maximum number of servers active at any time.

  ---

• syscommon

  include file		Fortran code
  Usage	define SYSCOMMON common block used for data conversion
  Content	COMMON	SYSCOMMON
  	COMMON	SYSCCOMMON
  	INTEGER PARAMETER	SYSCOMMON_NSYS

  This common block is used by type conversion routines and programs to know whether a (and which type of) conversion is required between an origin operating system and the current target system.
  According to usual practice, in SYSCOMMON there are two separate common blocks, one for numeric and one for character variables. Both sets of variables have names prefixed with SYSCOMMON_. The meaning and full list of variables is documented in the code header.
  The parameter SYSCOMMON_NSYS is the number of currently supported operating systems and must be edited in cases of porting to a OS. In addition one shall change the blksyscommon routine used to initialize the different OS characteristics.

  ---

• timecommon

  include file		Fortran code
  Usage	define TIMECOMMON common block used for time unit conversion
  Content	COMMON	TIMECOMMON
  	COMMON	TIMECCOMMON

  This common block is used to store constants used for conversion of times between spacecraft times and user defined units (seconds or submultiples) and is initialized by time_constants_setup
  According to usual practice, in TIMECOMMON there are two separate common blocks, one for numeric and one for character variables. Both sets of variables have names prefixed with TIMECOMMON_. The meaning and full list of variables is documented in the code header.

  ---

• vcommon

  include file		Fortran code
  Usage	define VCOMMON common block used to support to saxvartaccum program
  Content	COMMON	VCOMMON

  saxvartaccum is an unofficial XAS extension which allows to accumulate time profiles with bins of variable width defined in an external file. The VCOMMON blocks keeps track of such bin characteristics similar to (but separately from) what is done for time windows in wcommon. The meaning and full list of variables is documented in the code header.
  

  ---

• voscommon

  include file		Fortran code
  Usage	common containing current VOS errors
  Content	COMMON	VOSCOMMON

  This simple common block contains two variables VOSCOMMON_ERROR and VOSCOMMON_SYSTEMERROR which are set by VOS and other routines. The first variable is set to the standard VOS codes defined in the 'errors.inc' file, while the second contains the original system dependent code. Users do not normally access this common explicitly, but via a call to voserror

  ---

• wcommon

  include file		Fortran code
  Usage	define WCOMMON common block used to store time windows
  Content	COMMON	WCOMMON

  The WCOMMON block stores information about the time windows used to select intervals from data accumulation as read from a file via appropriate routines.
  Variables names are prefixed with WCOMMON_. The meaning and full list of variables is documented in the code header.

  ---

• xwserver

  include file		Fortran code
  Usage	define F2C common block as used by X window graphics server
  Content	COMMON	F2C
  	COMMON	F2CC

  The logical F2C common block is used by a graphics server to keep its internal status. The X window server uses for convenience the same names for the F2C common defined for 'psserver.inc' although the data types of some elements may be different. More important, it has to be noted that the f2x C routine defines F2C and F2CC as C structs sized by separate #defines which must be edited manually consistently with eventual changes in FULLBUFSIZE in 'graphlimit.inc'
  For such reason the 'graphlimit.inc' file must be referenced before this one,.

  According to usual practice, in F2C there are two separate common blocks, one for numeric and one for character variables. The meaning and full list of variables is documented in the code header.
  

[Previous][Next] [Up][Down]