LEDAS  
Leicester Database and Archive Service
 
Mission
    Description
Products
    Databases
Raw Data
    Archive
Analysis Software
    Archive
Ginga Information
Ginga Gallery
Related Sites
Databases
GINGALAC
GINGABGD
GINGAFRF
GINGALOG
GINGAMODE
GINGARAW
View Ginga DBs
Line
Footer
e-mail

Ginga Specific Software: Program SORTAC



Purpose

Program sortac sorts Ginga First Reduction Files (FRFs) and creates sorted data files which are compatible with the Leicester Data Analysis System (LDAS).


Input Files

Sortac requires a catalogue file and a variable number of FRFs. The catalogue is an text file with fixed length (132 byte) records, containing a list of FRF names. It is thus possible to edit the catalogue using any available text editor.


Output Files

The output file, created by sortac, can be of three types: a time series (TIME), a spectrum (PHAD), or a file which preserves both the time and pulse height information (CUBE).


Running the Program

Sortac requires a large number of input parameters. The QX parameter system is used to read these parameters. The following shows a typical set of parameters, together with a brief explanation. The next section describes the parameters in more detail.

GNG_DIR=./ Directory containing the FRFs.
GNG_CAT_FILE=3c273.cat The name of the input catalogue file.
GNG_TARGET=3C273 The name of the source.
GNG_RA_DEC_CHK=Yes
GNG_RA=186.64
GNG_DEC=-0.27
GNG_TARGET_DIFF=1.0
Data restricted to within GNG_TARGET_DIFF degrees from GNG_RA and GNG_DEC. Normally used.
GNG_RAW_TYPE=MPC1 Mode required (MPC1, MPC2, MPC3, PC).
GNG_SQUISH=Yes Reduces number of idents in output file. Normally used when GNG_RAW_TYPE=MPC1.
GNG_RAW_COMPAT=Yes Allows sorting of data modes compatible with GNG_RAW_TYPE. Normally used.
GNG_SORT_TYPE=CUBE TIME or PHAD options only occasionally used.
GNG_FLD=No Folds data at given period. Only occasionaly used.
GNG_TIME_BIN=64.0 Time bin in seconds.
GNG_AUX_INFO=Yes Makes extra HK information available. Normally used.
GNG_DEAD_CORRECT=Yes Deadtime correction. Normally used.
GNG_OS_DEF=Yes Ensures LAC status doesn't change during an observation. Frequently used.
GNG_NUM_PER=1 Number of periods sorted.
GNG_ST_PER001=G88 6 7 9 Start of an observation.
GNG_END_PER001=G88 6 8 End of an observation.
GNG_SYNC=Yes Adjust GNG_ST_PER(1) so that the sorted time bins match the integration periods.
GNG_SOL_CHK=Yes
GNG_SOL_MAX=15.0
SOL cut recommended to avoid high background.
GNG_PI_CHK=No Rarely required for routine analysis.
GNG_COR_CHK=Yes
GNG_COR_MIN=7.0
GNG_COR_MAX=20.0
COR cut recommended to avoid high background.
GNG_SUD_CHK=Yes
GNG_SUD_MIN=0.0
GNG_SUD_MAX=14.0
SUD cut recommended to avoid high background.
GNG_LONG_CHK=No Occasionaly used to remove "Hawaiian Anomaly".
GNG_HV_DEF=Yes High voltage must be checked to avoid "spikes".
GNG_POINT_CHK=No Rarely required for routine data analysis.
GNG_YELEV_CHK=Yes
GNG_YELEV_MIN=6.0
GNG_YELEV_MAX=120.0
Y elevation must be checked to avoid earth occulation.


Description of Parameters

GNG_DIR The name of the directory containing the FRFs.
GNG_CAT_FILE The name of the input catalogue file. If a directory is not specified as part of the filename sortac looks for the catalogue on the current default directory, not on GNG_DIR.
GNG_TARGET Target name included in the output file. FRFs do not contain reliable target names; one must be supplied by the user.
GNG_RA_DEC_CHK
GNG_RA
GNG_DEC
GNG_TARGET_DIFF
If GNG_RA_DEC_CHK=Yes then data is only accepted when the satellite is pointing within GNG_TARGET_DIFF degrees of GNG_RA and GNG_DEC. Values of GNG_TARGET_DIFF less than 0.5 degrees are advisable to avoid problems due to collimator reflection.
GNG_RAW_TYPE
GNG_SQUISH
GNG_RAW_COMPAT
GNG_RAW_TYPE specifies the mode to be sorted. Valid responses are PC, MPC1, MPC2 and MPC3. If GNG_RAW_COMPAT=Yes then data modes which can be squished down onto GNG_RAW_TYPE are also sorted (See Table 4 for a list of which modes are compatible).
GNG_RAW_TYPE partly determines the shape of the sort file (see Tables 1, 2 and 3). When GNG_SQUISH=Yes the number of detector idents in the output file is reduced (see Tables 1, 2 and 3). Setting GNG_SQUISH=Yes when GNG_RAW_TYPE=MPC1 is highly recommended. If GNG_SQUISH=Yes the number of detector idents in the output file are reduced in order to save space (see Tables 1, 2 and 3).
GNG_SORT_TYPE
GNG_TIME_BIN
GNG_PHA_START
GNG_PHA_LAST
GNG_SORT_TYPE selects the type of output file created. Valid responses are CUBE, TIME, or PHAD.
GNG_TIME_BIN defines the size of the time bins (in seconds) in CUBE and TIME files. Please note that if a time bin is smaller than the time resolution of a given data mode, then data from this mode will be excluded from the sort file. GNG_PHA_FIRST and GNG_PHA_LAST specify the range of PHA channels included in a TIME file. If the values of either are incompatible with GNG_RAW_TYPE the program can change them to the nearest allowed value.
GNG_FLD
GNG_FLD_EPOCH
GNG_FLD_PERIOD
GNG_FLD_BINS
If GNG_FLD=Yes then the cube or time series is folded at GNG_FLD_PERIOD seconds into GNG_FLD_BINS phase bins. The epoch of the fold is GNG_FLD_EPOCH, and is specified in the same format as GNG_ST_PER and GNG_END_PER.
GNG_AUX_INFO Controls the amount of auxiliary data in the sorted file. Valid responses are:
  1. FULL: writes all auxiliary Housekeeping (HK) parameters to output file.
  2. REDUCED: writes a subset of auxiliary HK parameters to the output file. Useful when trying to reduced size of files.
  3. NONE: does not write any of the the auxiliary HK parameters to the output file.
  4. YES: kept for back compatability. Equivalent to GNG_AUX_INFO=FULL
  5. NO: kept for back compatability. Equivalent to GNG_AUX_INFO=REDUCED
GNG_DEAD_CORRECT If GNG_DEAD_CORRECT=Yes then MPC1, MPC2, and MPC3 data is dead time corrected.
GNG_OS_DEF
GNG_OS_CHK
GNG_OS_CHA(8)
When sortac first encounters acceptable data the current operational status (OS) is recorded. If the default OS checking, GNG_OS_DEF=Yes, is enabled then data will only subsequently be sorted at the same OS. If GNG_OS_DEF=No the OS checking can either be completly disabled, GNG_OS_CHK=No, or confined to selected channels, GNG_OS_CHK=Yes. GNG_OS_CHA controls which channels are checked.
GNG_NUM_PER
GNG_ST_PER(GNG_NUM_PER)
GNG_END_PER(GNG_NUM_PER)
GNG_SYNC
GNG_NUM_PER defines the number of time periods.
GNG_ST_PER and GNG_END_PER specify the start and stop times of the selected periods. There are three ways of specifying a time:
  1. START: The earliest time in a catalogue. Can optionally be specified with a positive offset in seconds, e.g. START+128.5 specfies a time 128.5 seconds after START
  2. END: The last time in a catalogue. Can optionally be specified with a negative offset in seconds, e.g. END-128.5 specfies a time 128.5 before END
  3. Universal time. Prefix date with the letter U (or G). The date should be in the form Uyy mm dd hh mm ss mmm. Any ommitted fields will be set to zero, so U87 4 23 3 10 would be interpreted as 87/4/23 3:10:00.000
  4. Modified Julian Date. Prefix with the letter M, e.g. M46948.749
  5. Offset Time. Prefix with O. Functionally identical with START+ and only included for back compatability.

GNG_SYNC controls whether GNG_ST_PER(1) is adjusted by sortac, so that the boundaries of the sorted time bins match the integration period of Ginga. If GNG_SYNC is set to No sortac will assigned data to a particular sorted time bin if the mid point of the integration period lies within that of the sorted time bin without worrying whether a integration period stradles the boundaries of the sorted time bin. This will cause an error in the time axis of up to half the Ginga integration time. Early versions of sortac always sorted data in this way.
Setting GNG_SYNC to Yes results in the specified start time being modified so that (providing the time bin is set to some integer multiple of the integration time) binning is matched to the integration times. Occasionally there are gaps in the Ginga data which will prevent this working, and the software is not yet intelligent enough to warn the user. If timing accuracy of the same order as the Ginga resolution is important to you, consult das@star.le.ac.uk
GNG_SOL_CHK
GNG_SOL_MAX
If GNG_SOL_CHK=Yes then data is accepted only when the rate in the Solid State Detector in the Gamma Burst Monitor is less than GNG_SOL_MAX. GNG_SOL_MAX should normally be in the range 10-20 counts sec-1.
GNG_PI_CHK
GNG_PI_MAX
Controls whether data is accepted only when the PI_MONI rate is below a certain value specified by GNG_PI_MAX. PI_MONI cuts should not normaly be used.
GNG_COR_CHK
GNG_COR_MIN
GNG_COR_MAX
When GNG_COR_CHK=Yes data is accepted only when the Cut Off Rigidity is greater than GNG_COR_MIN and less than GNG_COR_MAX. GNG_COR_MIN should normaly be in the range 5-7 GeV/c.
GNG_SUD_CHK
GNG_SUD_MIN
GNG_SUD_MAX
When GNG_SUD_CHK=Yes data is accepted only when the SUD rate is greater than GNG_SUD_MIN and less than GNG_SUD_MAX. GNG_SUD_MAX should normally be in the range 8-14 c/s.
GNG_LONG_CHK
GNG_LONG_MIN
GNG_LONG_MAX
When GNG_LONG_CHK=Yes data is accepted only when the longitude is greater than GNG_LONG_MIN and less than GNG_LONG_MAX.
GNG_HV_DEF
GNG_HV_CHK
GNG_HV_MIN(8)
GNG_HV_MAX(8)
When GNG_HV_CHK=Yes high voltages are checked to eliminate data where the HVs are out of range or changing. The valid HV range is specified by the parameters GNG_HV_MIN(8) and GNG_HV_MAX(8).
GNG_HV_DEF=Yes enables the default HV checking. This should be adequate for most puposes.
GNG_POINT_CHK
GNG_POINT_NUM
Controls whether the pointing direction of the satellite is checked. When GNG_POINT_CHK=Yes then data is only accepted from:
  • the sky (GNG_POINT_NUM=0),
  • dark earth (GNG_POINT_NUM=1),
  • or bright earth (GNG_POINT_NUM=2).
GNG_YELEV_CHK
GNG_YELEV_MIN
GNG_YELEV_MAX
When GNG_YELEV_CHK=Yes data is accepted only when the angle between the satellite point direction and the Earth's horizon is greater than GNG_YELEV_MIN and less than GNG_YELEV_MAX. GNG_YELEV_MIN should normally be greater that 6°.


Table 1. Shape of the output file produced by sortac when GNG_SORT_TYPE=CUBE for various values of GNG_RAW_TYPE

GNG_RAW_TYPE
Number of channels in output
IdentEnergyTime
PC 2/1 2 Variable
MPC1 16/2 48 Variable
MPC2 2/1 48 Variable
MPC3 1 12 Variable


Table 2. Shape of the output file produced by sortac when GNG_SORT_TYPE=PHAD for various values of GNG_RAW_TYPE

GNG_RAW_TYPE
Number of channels in output
IdentEnergyTime
PC 2/1 2 1
MPC1 16/2 48 1
MPC2 2/1 48 1
MPC3 1 12 1


Table 3. Shape of the output file produced by sortac when GNG_SORT_TYPE=TIME for various values of GNG_RAW_TYPE

GNG_RAW_TYPE
Number of channels in output
IdentEnergyTime
PC 2/1 1 Variable
MPC1 16/2 1 Variable
MPC2 2/1 1 Variable
MPC3 1 1 Variable


Table 4. Data modes accepted by sortac for various values of the parameters GNG_RAW_TYPE and GNG_RAW_COMPAT

GNG_RAW_TYPE
Data modes accepted
GNG_RAW_COMPAT=YGNG_RAW_COMPAT=N
PC PC PC
MPC1 MPC1 MPC1
MPC2 MPC1, MPC2 MPC2
MPC3 MPC1, MPC2, MPC3 MPC3



[Back to Contents]
 
HOME
SEARCH
SERVICES INFO SOFTWARE ViZieR BLASTA DSS
ARCHIVES ASCA CHANDRA GINGA ROSAT ARNIE