NAME
sxipipeline - Hitomi SXI reprocessing tool
USAGE
sxipipeline indir outdir steminputs stemoutputs entry_stage attitude orbit obsgti housekeeping
DESCRIPTION
The sxipipeline task duplicates most of the Hitomi pipeline for SXI data (in particular, it does not produce the trend data). It allows the user to run all or part of the pipeline processing, and to vary the calibration files and filtering (screening) criteria used. A number of other pipeline processing parameters can also be changed.
SXI Pipeline Stages
The sxipipeline task is divided into 2 stages:
- Calibration
- Data screening
Each stage may be run singly or in combination with the preceding stages. This is controlled by the 'entry_stage' and 'exit_stage' parameters.
SXI Stage 1 runs the following steps for each event file:
- (optional) Run coordevt on hot pixel file
- Run coordevt
- Run sxiphas
- Run sxiflagpix
- Run sxipi with ctigrade='no'
- Run sxipi with ctigrade specified in this task
- Create flickering pixel file
- Filter SXI events STATUS[1]==b0
- Run searchflickpix
- Run coordevt on flickering pixel events
- Run sxiflagpix with flickering pixels
The data screening (Stage 2) is identical to that in the production pipeline when the default parameters are used. For details on the default screening applied to the SXI events, see:
- ahfilter - Create the EHK from attitude and orbital data, and create the MKF from housekeeping data based on the CALDB 'mkfconf' file
- ahgtigen - Create the GTI from the EHK and MKF parameters based on CALDB selection file
- ahscreen - Screen the data based on GTI and the CALDB selection file
Default GTI used for screening data are:
- GTIPOINT
- GTITEL
- GTI_<DATACLASS>
- GTIEHK
- GTIMKF
Optionally, sximodegti can be run to create new GTI specific to the DATACLASSes of the input SXI event file.
INPUT
The input to sxipipeline is specified using (at minimum) the 'indir' parameter. This should be specified as the sxi/event_uf level sequence directory, e.g.:
sxipipeline indir=/path/to/100039010/sxi/event_uf
Paths to specific SXI housekeeping and satellite data files can be specified using the 'attitude', 'housekeeping', 'extended_housekeeping', 'makefilter', 'orbit', and 'obsgti' parameters. The attitude, orbit, and SXI housekeeping files are required for Stage 1 calibration.
OUTPUT
File names, etc.
The number of output files depends on both the pipeline processing stage(s) and the options selected. All output files are written to the directory specified by the 'outdir' parameter. The archive directory structure is NOT reproduced (i.e. all output files are in a single directory).
The names of files produced are the same as those found in the HEASARC archive. However, the usual ahXXXXXXXXX prefix, where "XXXXXXXXX" is the sequence number, can be replaced by a character string set by the 'stemoutputs' parameter. This defaults to the value set by the 'steminputs' parameter.
PARAMETERS
- indir = indir/ [string]
- Directory containing the input data. This should be the path to 'event_uf'
/path/to/805062010/sxi/event_uf
- outdir = outdir/ [string]
- Output directory used for all output data, as well as the report file.
CAUTION: If 'clobber' is set to yes, and this directory already exists, then this task overwrites files as necessary in this directory.
- steminputs = ah1001 [string]
- Base (stem) for FITS input files (e.g., ah100039010). This string is used as the base file name for
finding input files. For example, if 'steminputs=ah100039010', then to find the event file, sxipipeline matches the regular expression
/ah100039010sxi_[ps][\d][0-9a-f]{8}_uf\.evt(\..+)?$/
against all files found in the 'indir' directory.
- (stemoutputs = ah1001) [string]
- Base (stem) output name used for creating output files. If set to DEFAULT, then 'steminputs' is used.
- entry_stage = 1 [integer 1|2]
- Entry stage, 1 or 2.
Stage 1: Re-calibrate unfiltered event files.
Stage 2: Start from existing unfiltered event files.
- exit_stage = 2 [integer 1|2]
- Exit stage, 1 or 2.
Stage 1: Produces calibrated unfiltered event files.
Stage 2: Produces screened event files.
- attitude = ah1001.att [string]
- Attitude file.
- (extended_housekeeping = ah1001.ehk) [string]
- Extended housekeeping file.
- (makefilter = ah1001.mkf) [string]
- Makefilter file.
- orbit = ah1001.orb [string]
- Orbit file.
- gtifile = ah1001_gen.gti [string]
- Input GTI file.
- housekeeping = ah1001sxi_a0.hk [string]
- SXI Housekeeping file.
- (regionfile = NONE) [string NONE|file name]
- Input region file.
- (sxi_mkflabel = SXI#SCI) [string]
- Label to use for SXI MKF GTI creation. The hash is replaced by one of the following strings corresponding to the appropriate mode: CCDW1, CCD12WA, or CCD34WF.
- (sxi_ehklabel = SXI#SCI) [string]
- Label to use for SXI EHK GTI creation. The hash is replaced by one of the following strings corresponding to the appropriate mode: CCDW1, CCD12WA, or CCD34WF.
- (sxi_evtlabel = SXI#SCI) [string]
- Label to use for SXI event screening. The hash is replaced by one of the following strings corresponding to the appropriate mode: CCDW1, CCD12WA, or CCD34WF.
- (sxi_start = 0.0) [real]
- Earliest validity time for SXI calibration files.
- (ra = -999.99999) [real]
- Right ascension [degrees] of the point to appear in
the center of SKY coordinate images. If 'ra' is within the range 0
<= 'ra' <= 360, the value of the parameter is used
and is written to the keyword RA_NOM in output files.
'ra' is outside this range, the 'ra' value is read from the
event header of the input file, by searching first for the RA_NOM
keyword and if found using its value, or if not found,
by searching for the RA_PNT keyword and using its value. If neither
keyword is found, the called task coordevt exits with an error.
- (dec = -999.99999) [real]
- Declination [degrees] of the point to appear in
the center of SKY coordinate images. If 'dec' is within the range -90
<= 'dec' <= +90, the value of the parameter is used
and is written to the keyword DEC_NOM in output files.
If 'dec' is outside this range, the 'dec' value is read from the
event header of the input file, by searching first for the DEC_NOM
keyword and if found using its value, or if not found,
by searching for the DEC_PNT keyword and using its value. If neither
keyword is found, the called task coordevt exits with an error.
- (roll = 0.0) [real]
- The roll angle [degrees] about the center of
the SKY coordinate system. The roll angle is the angle measured
counterclockwise from Celestial North to the positive SKY Y
axis.
- (optdetx = -999.99999) [double]
- SXI optical axis DETX coordinate. If this parameter is
set to a value other than the default, the value is used only to
set the OPTDETX header keyword.
- (optdety = -999.99999) [double]
- SXI optical axis DETY coordinate. If this parameter is
set to a value other than the default, the value is used only to
set the OPTDETY header keyword.
- (optfocx = -999.99999) [double]
- SXI optical axis FOCX coordinate. If this parameter is
set to a value other than the default, the value is used only to
set the OPTFOCX header keyword.
- (optfocy = -999.99999) [double]
- SXI optical axis FOCY coordinate. If this parameter is
set to a value other than the default, the value is used only to
set the OPTFOCY header keyword.
- (optskyx = -999.99999) [double]
- SXI optical axis SKYX coordinate. If this parameter is
set to a value other than the default, the value is used only to
set the OPTSKYX header keyword.
- (optskyy = -999.99999) [double]
- SXI optical axis SKYY coordinate. If this parameter is
set to a value other than the default, the value is used only to
set the OPTSKYY header keyword.
- (ra_pnt = -999.99999) [double]
- RA of SXI pointing [deg]. If this parameter is
set to a value other than the default, the value is used only to
set the RA_PNT header keyword.
- (dec_pnt = -999.99999) [double]
- DEC of SXI pointing [deg]. If this parameter is
set to a value other than the default, the value is used only to
set the DEC_PNT header keyword.
- (calc_hotpix = no) [boolean yes|no]
- Run coordevt on hot pixel file.
- (calc_modegti = yes) [boolean yes|no]
- Calculate SXI data mode GTI.
- (teldeffile = CALDB) [string CALDB|file name]
- Input teldef file.
- (leapsecfile = REFDATA) [filename CALDB|REFDATA|file name]
- Name of the leap second file. If set to CALDB or REFDATA, the file in the calibration
database or in the REFDATA area, respectively, is used.
- (selectfile = CALDB) [filename]
- The file containing selection expressions. If 'selectfile' is set to CALDB, the file is
read from the calibration database.
- (badpixfile = CALDB) [filename CALDB|file name]
- Parameter for sxiflagpix: Bad pixel file for SXI.
- (maskfile = CALDB) [filename CALDB|file name]
- Parameter for sxiflagpix: Mask file for SXI.
- (vtevnoddfile = CALDB) [filename CALDB|file name]
- Parameter for sxipi: SXI 'evenodd' file.
- (ctifile = CALDB) [filename CALDB|file name]
- Parameter for sxipi: SXI CTI file.
- (chtrailfile = CALDB) [filename CALDB|file name]
- Parameter for sxipi: SXI charge trail ('chtrail') file.
- (spthfile = CALDB) [filename CALDB|file name]
- Parameter for sxipi: SXI split threshld ('splitth') file.
- (gainfile = CALDB) [filename CALDB|file name]
- Parameter for sxipi: SXI gain file.
- (patternfile = CALDB) [filename CALDB|file name]
- Parameter for sxipi: SXI grade pattern file.
- (coordevt_startsys = LOWEST) [string]
- Parameter for coordevt: Sets starting coordinate
system specifically for coordevt.
The name of the coordinate system from which the coordinate
conversions begin. If 'coordevt_startsys=LOWEST', the coordinate
transformation begins with the lowest level system in the teldef
file (COORD0; usually RAW). The 'coordevt_startsys' and 'stopsys' parameters
work together to specify the origin ('coordevt_startsys') and final
('stopsys') systems. Setting 'coordevt_startsys=LOWEST' and 'stopsys=HIGHEST'
converts the bottom-level coordinates into all the other
coordinate systems. It is allowed for 'coordevt_startsys' to be a higher
level coordinate system than 'stopsys'. For example, setting
'coordevt_startsys=HIGHEST' and 'stopsys=LOWEST' converts the top-level
coordinates into all the other coordinate systems.
-->
- (coordevt_startsys = LOWEST) [string LOWEST|RAW|ACT|DET|FOC|SKY|HIGHEST]
- Parameter for coordevt: Name of the intitial coordinate system for coordinate conversions.
- (stopsys = HIGHEST) [string LOWEST|RAW|ACT|DET|FOC|SKY|HIGHEST]
- Parameter for coordevt: Name of the final coordinate system for coordinate conversions.
- (annaber = no) [string yes|no|invert]
- Parameter for coordevt: Apply annual aberration correction.
- (followsun = yes) [boolean yes|no]
- Parameter for coordevt: Recalculate the Sun position for each event.
- (orbaber = no) [string yes|no|invert]
- Parameter for coordevt: Apply satellite orbital aberration correction.
- (attinterp = LINEAR) [string LINEAR|CONSTANT]
- Parameter for coordevt: Spacecraft attitude interpolation method.
- (attdt = 32.) [real]
- Parameter for coordevt:
Allowed time [s] to extrapolate the spacecraft attitude
before the first or after the last row in the attitude file.
Events beyond this time margin have their coordinates set
to a null value.
- (chkattgap = no) [boolean yes|no]
- Parameter for coordevt: Limit attitude interpolation if gaps are present.
- (attext = ATTITUDE) [string]
- Parameter for coordevt:
Name of the FITS attitude file extension containing
satellite attitude data.
- (attcol = QPARAM) [string]
- Parameter for coordevt:
Name of the FITS column containing attitude values as a
vector in the 'attext' extension of the attitude table.
- (attform = QUAT) [string QUAT|EULER]
- Parameter for coordevt: Attitude format.
- (orbext = ORBIT) [string]
- Parameter for coordevt:
Name of the FITS orbit file extension containing satellite
orbit data.
- (orbcol = VELOCITY) [string]
- Parameter for coordevt: Orbital velocity column name.
- (orbform = VECTOR) [string VECTOR|COMPONENTS|KEPLERIAN]
- Parameter for coordevt: Orbital velocity format.
- (coordevt_randomize = TELDEF) [string yes|no|teldef]
- Parameter for coordevt: Randomize coordinates when rebinning.
- (randsys = TELDEF) [string]
- Parameter for coordevt: Starting from coordinate system specified by 'randsys'
(default specified in RANCOORD keyword in teldef file), coordinate conversions are
randomized, up to the highest coordinate system.
- (randscalesys = TELDEF) [string]
- Parameter for coordevt: Name of the coordinate system to determine the scaling factor for the randomization interval,
+/- 0.5 of a pixel in that coordinate system. The default is to get the name from the RAN_SCL keyword in the teldef file.
- (infileext = EVENTS) [string]
- Parameter for coordevt: Event extension name.
- (timecol = TIME) [string]
- Parameter for coordevt: Name of time column.
- (inclfloatcol = no) [boolean yes|no]
- Parameter for coordevt: Write non-rounded coordinate columns.
- (inclfloatskycol = no) [boolean yes|no]
- Parameter for coordevt: Write non-rounded SKY coordinate columns.
- (floatcolsuffix = _FLOAT) [string]
- Parameter for coordevt: Suffix for non-rounded coordinate columns.
- (startwithfloat = no) [boolean yes|no]
- Parameter for coordevt: Start with non-rounded 'startsys' coordinates.
- (blankcol = yes) [boolean yes|no]
- Parameter for coordevt: Assign null values to columns not calculated.
- (btnull = 255) [integer]
- Parameter for coordevt: TNULL for byte (B) columns.
- (itnull = -999) [integer]
- Parameter for coordevt: TNULL for short (I) columns.
- (jtnull = -999) [integer]
- Parameter for coordevt: TNULL for long (J) columns.
- (ktnull = -999) [integer]
- Parameter for coordevt: TNULL for long (K) columns.
- (sbtnull = 255) [integer]
- Parameter for coordevt: TNULL for signed byte columns.
- (uitnull = -999) [integer]
- Parameter for coordevt: TNULL for unsigned short columns.
- (ujtnull = -999) [integer]
- Parameter for coordevt: TNULL for unsigned long columns.
- (colbound = -32768,-32767,32767) [string]
- Parameter for sxiphas: TNULL, TLMIN, and TLMAX for PHAS.
- (chipcol = CCD_ID) [string]
- Parameter for searchflickpix: Chip ID, or column (or NONE).
If set to NONE, then all events are searched together for flickering pixels.
Otherwise, events are searched separately by 'chipcol' grouping.
- (xcol = ACTX) [string]
- Parameter for searchflickpix: X-coordinate column.
- (ycol = ACTY) [string]
- Parameter for searchflickpix: Y-coordinate column.
- (chancol = PI) [string NONE|PI|PIE]
- Parameter for searchflickpix: Name of output pulse height column.
The column, in the PIXELS extension, contains average pulse
height values of the flickering events for each detected pixel.
Feature disabled if set to NONE.
- (gradecol = GRADE) [string NONE|GRADE]
- Parameter for searchflickpix: Name of output event grade column. Only events
with specific grades given in the 'grade' parameter for searchflickpix are used in
accumulating the chip image for the flickering pixel search. If set to NONE,
all grades are used, and the 'grade' parameter is ignored.
- (grade = 0,2,3,4,6) [string]
- Parameter for searchflickpix: Event grade(s) for cleaning. This is a list of grade
values used in accumulating the chip image for the flickering pixel
search. If set to ALL, all grades are used.
- (n_division = 1) [integer]
- Parameter for searchflickpix: Divide total observation time into the given number.
- (cleaning = no) [boolean yes|no]
- Parameter for searchflickpix: Output cleaned image for debugging.
- (cellsize = 7) [integer]
- Parameter for searchflickpix: Poisson clean cell size (odd integer > 1), in
units of pixels. If set to 0 this invokes the simple counts-per-pixel cutoff.
- (impfac = 320) [double]
- Parameter for searchflickpix: Impact factor for the gamma function used for the Poisson search.
- (logprob1 = -5.6) [double]
- Parameter for searchflickpix: Log (base 10) Poisson probability threshold for the first step of the
flickering pixel search (using the entire chip).
- (logprob2 = -5.6) [double]
- Parameter for searchflickpix: Log (base 10) of the Poisson probability threshold for
the second step of the flickering pixel search (comparing to the surrounding pixels).
- (iterate = yes) [boolean yes|no]
- Parameter for searchflickpix: Iterate the second step of Poisson cleaning.
- (flagedge = no) [boolean yes|no]
- Parameter for searchflickpix: If set to yes, pixels along the chip edge are flagged as flickering for
the entire duration of the observation.
- (bthresh = 3) [integer]
- Parameter for searchflickpix: Zero background cutoff threshold, applied when the local mean
background level is zero.
- (duration = no) [boolean yes|no]
- Parameter for searchflickpix: Perform detailed search for flickering pixel duration.
- (sigma = 3.0) [double]
- Parameter for searchflickpix: Significance level for flickering pixel duration.
- (firstchip = TLMIN) [string]
- Parameter for searchflickpix: Minimum value for chip number in the 'chipcol' column.
- (lastchip = TLMAX) [string]
- Parameter for searchflickpix: Maximum value for chip number in the 'chipcol' column.
- (xmin = TLMIN) [string]
- Parameter for searchflickpix: Minimium value for X-coordinate.
- (xmax = TLMAX) [string]
- Parameter for searchflickpix: Maximum value for X-coordinate.
- (ymin = TLMIN) [string]
- Parameter for searchflickpix: Minimum value for Y-coordinate.
- (ymax = TLMAX) [string]
- Parameter for searchflickpix: Maximum value for Y-coordinate.
- (chanmin = TLMIN) [string]
- Parameter for searchflickpix: Minimum pulse height value (inclusive) for accumulating image
to search for flickering pixels.
- (chanmax = TLMAX) [string]
- Parameter for searchflickpix: Maximum pulse height value inclusive) for accumulating image
to search for flickering pixels.
- (outbadpix = no) [boolean yes|no]
- Parameter for sxiflagpix: If 'outbadpix=yes', output bad pixel file(s) made by sxiflagpix. It is not possible to specifiy individual names
of the bad pixel files. Although an individual run of sxiflagpix allows specifying an output file name,
the task sxipipeline calls sxiflagpix multiple times and does not allow specifying the bad pixel name.
- (outbadimg = yes) [boolean yes|no]
- Parameter for sxiflagpix: If 'outbadimg=yes', bad pixel images are output.
Note that in sxiflagpix this parameter is a file name, but here there can be multiple files and the user
cannot specify the file names, only whether or not the files are output.
- (npixnbr = 1) [integer]
- Parameter for sxiflagpix: Pixel distance defining a neighbor.
- (nboundnbr = 1) [integer]
- Parameter for sxiflagpix: Pixel distance defining neighbor from CCD/window/segment boundary.
- (citrailnbr = 2) [integer]
- Parameter for sxiflagpix: Pixel distance trailing CI row.
- Pixel distance trailing CI row.
- (ciprenbr = 1) [integer]
- Parameter for sxiflagpix: Pixel distance preceding CI row.
- (echoflag = yes) [integer]
- Parameter for sxiflagpix: Flag cosmic ray echo pixels.
- (echomap = no) [integer]
- Parameter for sxiflagpix: Output cosmic ray echo pixel fraction map.
- (echonbr = 2) [integer]
- Parameter for sxiflagpix: Distance in pixels from a cosmic ray echo pixel to flag a neighbor
pixel.
- (echomin = 6) [integer]
- Parameter for sxiflagpix: Minimum number of events for the cosmic ray echo fraction
calculation.
- (echospth = 15) [integer]
- Parameter for sxiflagpix: Split threshold for cosmic ray echo fraction calculation.
- (echofrac = 0.7) [real]
- Parameter for sxiflagpix: Minimum fraction of hits defining a cosmic ray echo pixel. For any
pixel contained in at least 'echomin' events, if at least a fraction 'echofrac' of those
events have a pulse height above 'echospth', that pixel is
considered a cosmic ray echo pixel.
- (bad_status = 3:9,11,12,16:19,25:28,30,37) [string]
- Parameter for sxiflagpix:
List of STATUS flags which are considered bad. If any of these flags
are set to 1 for an event, then STATUS flag 1 will also be set to 1 for
that event. Colons can be used to specify a range (e.g., "3:5,7" is equivalent to "3,4,5,7").
- (copyphas = yes) [boolean yes|no]
- Parameter for sxiflagpix: Copy original PHAS before processing.
- (resetflags = yes) [boolean yes|no]
- Parameter for sxiflagpix: Reset all sxiflagpix STATUS flags.
- (hkext = HK_SXI_USR_USER_HK1) [string]
- Parameter for sxipi: Name of HK extension with video temperatures.
- (hkcolstem = SXI_USR_HKTBL_) [string]
- Parameter for sxipi: Column name stem for video temperatures.
- (hkvideoid = A,B,B,B) [string]
- Parameter for sxipi: Video card IDs used for the even-odd correction for CCD1, CCD2, CCD3,
and CCD4. This parameter must consist of a comma-separated list of 4 characters
A or B.
- (startcol = PHAS) [string PHAS|PHAS_EVENODD|PHAS_TRAILCORR|PHAS_CTICORR|PHA]
- Parameter for sxipi: Starting point of corrections to calculate PI.
- (evnoddcor = yes) [boolean yes|no]
- Parameter for sxipi: Enable even-odd correction for SXI PI calculation.
- (chtrailcor = yes) [boolean yes|no]
- Parameter for sxipi: Enable charge trail correction for SXI PI calculaton.
- (cticor = yes) [boolean yes|no]
- Parameter for sxipi: Enable CTI correction for SXI PI calculation.
- (gaincor = yes) [boolean yes|no]
- Parameter for sxipi: Enable gain correction for SXI PI calculation.
- (ctigrade = yes) [boolean yes|no]
- Parameter for sxipi: Use grade information in SXI CTI correction in the second sxipi pass. The first pass always uses 'ctigrade=no'.
- (copygrade = no) [boolean yes|no]
- Parameter for sxipi: Copy existing GRADE and PHA columns to GRADE_COPY and PHA_COPY columns respectively.
- (phcut = CALDB) [string]
- Parameter for sxipi: Pulse height cut for CTI correction. If set to CALDB,
the value from the header of the CTI CALDB file ('ctifile') is used.
- (badpixopt = 2) [integer 1|2|3]
- Parameter for sxipi: Options for events with bad pixels: ignore bad pixels (1), null bad pixels (2), or null whole event (3).
- (spthiter = yes) [boolean yes|no]
- Parameter for sxipi: Enable split threshold iteration.
- (spthcaldb = yes) [boolean yes|no]
- Parameter for sxipi: Use split thresholds from 'spthfile'.
- (spthoffset = 15.) [real]
- Parameter for sxipi: Split threshold offset value (if 'spthcaldb=no').
- (spthslope = 0.) [real]
- Parameter for sxipi: Split threshold slope value (if 'spthcaldb=no').
- (evtthre = DEFAULT) [string]
- Parameter for sxipi: Event threshold. If set to DEFAULT, the task uses the values in
the 'infile' header keyword EVENTTHR, which contains a comma-separated list
of values for each CCD_ID and SEGMENT combination.
- (negthre = -5000) [integer]
- Parameter for sxipi: Minimum PHAS value for normal event.
- (deltatime = 8) [integer]
- Parameter for sxipi: Maximum allowed time gap [s] in HK temp search.
- (debugcol = no) [boolean yes|no]
- Parameter for sxipi: Write out the debuging columns.
- (randomize = yes) [boolean yes|no]
- Parameter for sxipi:
If set to yes, randomization is used to convert the input
integer PHAS or PHA column to floating point. If 'startcol' is
PHAS_EVENODD, PHAS_TRAILCORR, or PHAS_CTICORR, this parameter is
ignored, since those columns are floating point values.
- (seed = 0) [integer]
- Parameter for coordevt, sxipi: Random number generator seed; uses system time for 'seed=0'.
- (stemreport) [string]
- File stem for log and temporary files. If the parameter is not set, the script automatically sets the stem to sxipipeline_YYYYMMDDTHHMMSS_ and appends log file and temporary file names as needed. Intended to be set by ahpipeline.
- (numerrs = 0) [string]
- Number of errors from sxipipeline (output).
- (cleanup = yes) [boolean yes|no]
- Delete temporary files if 'cleanup=yes'.
- (clobber = no) [boolean yes|no]
- Overwrites the existing output file if set to yes.
- (chatter = 2) [integer 0|1|2|3]
- Chatter level for output. Set to 0 to suppress output,
or to 1, 2, or 3 for increasing the chatter of the output.
- (logfile = !DEFAULT) [string DEFAULT|NONE|file name]
- Log file name. If set to DEFAULT, uses the name of the task and, if
preceded by "!", overwrites the file if it exists. If set to NONE, no
log file is created.
- (debug = no) [boolean yes|no]
- Diagnostic output is printed to the screen if set to yes.
- (history = yes) [boolean yes|no]
- Records tool parameters in HISTORY.
EXAMPLES
- The following command recalibrates (Stage 1) and re-screens (Stage 2) all SXI data for sequence 100039010 that currently resides in the directory /data/100039010/sxi/event_uf. The output is stored in a directory called /data/100039010_reproc/.
sxipipeline indir=/data/100039010/sxi/event_uf outdir=/data/100039010_reproc entry_stage=1 exit_stage=2 \
steminputs=ah100039010 attitude=/data/100039010/auxil/ah100039010/ah100039010.att \
orbit=/data/100039010/auxil/ah100039010/ah100039010.orb obsgti=/data/100039010/auxil/ah100039010/ah100039010_gen.gti \
housekeeping=/data/100039010/sxi/hk/ah100039010sxi_a0.hk makefilter=/data/100039010/auxil/ah100039010/ah100039010.mkf \
exended_housekeeping=/data/100039010/auxil/ah100039010/ah100039010.ehk
- The following command re-screens (Stage 2 only) SXI data for the same data set as in the previous example, as well as recalculate the SXI mode GTI.
sxipipeline indir=/data/100039010/sxi/event_uf outdir=/data/100039010_reproc entry_stage=2 exit_stage=2 \
steminputs=ah100039010 calc_modegti=yes obsgti=/data/100039010/auxil/ah100039010/ah100039010_gen.gti \
makefilter=/data/100039010/auxil/ah100039010/ah100039010.mkf \
exended_housekeeping=/data/100039010/auxil/ah100039010/ah100039010.ehk
SEE ALSO
ahcalctime,
ahpipeline,
sxiphas,
sxiflagpix,
sxipi,
searchflickpix,
coordevt,
sximodegti,
ahfilter,
ahgtigen,
ahscreen
LAST MODIFIED
November 1, 2023