XRISM+Hitomi Common Applications

ahbackscal - Corrects BACKSCAL keyword in a spectrum extracted with xselect
ahcalcl32ti - Computes L32TI from S_TIME
ahfilecaldb - Creates a FITS file from a set of text files
ahgainfit - Calculates the time-dependent energy gain corrections using known calibration lines
ahgetvector - Extracts vectors from a FITS file and outputs to a text file
ahgtigen - Creates and/or merge GTI files
ahmodhkext - Merges extensions of FITS file into single extension
ahscreen - Screens a science event file
ahsysinfo - Displays system build information about an executable and/or information about the current system
ahtimeconv - Converts mission time in different formats

HITOMI-Specific Applications

Mission Applications

aharfgen - Makes an ancillary response function (ARF) file for the SXS or SXI, or a response matrix (RSP) file for the HXI
ahcalctime - Reruns the timing tools on an output directory from the pipeline
ahexpmap - Generates an exposure map for HXI, SXI, and SXS, or a flat field image for SXI and SXS
ahfilter - Generates an EHK file and a MKF filter file
ahmkehk - Extracts and calculates parameters from orbit and attitude (EHK)
ahmkregion - Creates regions files showing the field of view of all HITOMI instruments
ahmktim - Calculates the relation of Time Invariant vs Time and the GTI for when the GPS is on
ahpipeline - HXI/SGD/SXS/SXI reprocessing tool
ahsxtarfgen - Creates an ancillary response file (ARF) for the SXS + SXT-S or SXI + SXT-I, accounting for the telescope effective area and detector efficiencies.
ahtime - Calculates times and populate the TIME column for all science and housekeeping data
ahtrendtemp - Calculates the quartz clock frequency vs tempereature relation for the on-board clock
hitomiversion - Reports version string for Hitomi tools

HXI/SGD Applications

cams2att - Computes a time-dependent delta-attitude file
cams2det - Calculates offsets and rotations in HXI coordinates using CAMS telemetry input
camssim - (1) Simulates motion of the Extensible Optical Bench (EOB) for testing CAMS-correction. (2) Generates RAW coordinates associated with given HXI ACT coordinates and the simulated motion
hxievtid - Reconstructs HXI events
hxigainfit - Calculates the HXI time-dependent energy gain corrections for events from comparison with known calibration lines
hxinxbgen - Creates a Non-X-ray Background (NXB) spectrum for HXI
hxipipeline - HXI reprocessing tool
hxirspeffimg - Creates a combined effective are and spectral response matrix ("RSP" file) and/or a flat-field corection image, for the HXI1 + HXT1 or HXI2 + HXT2 combinations, accounting for the telescope effective area, detector efficiencies, and CAMS motion.
hxisgddtime - Calculates and corrects for deadtime HXI and SGD spectra and lightcurves
hxisgdexpand - Expands HXI and SGD SFF occurrences to have one signal in each row
hxisgdmerge - Merges slew and pointing raw (unprocessed) event files for the HXI or SGD
hxisgdpha - Calibrates the HXI or SGD PHA for each signal in the SFF event file
hxisgdsff - Converts an HXI or SGD First FITS File (FFF) into the Second FITS File (SFF)
hxisgdshield - Extracts lightcurves or spectra from shield data of HXI or SGD
sgdarfgen - Calculates SGD transmission ratio for a source on the sky and create arf file
sgdevtid - Reconstructs SGD events
sgdgainfit - Calculates the SGD time-dependent energy gain corrections for events from comparison with known calibration lines
sgdpipeline - SGD reprocessing tool

SXI Applications

sxiflagpix - Flags pixel STATUS for SXI event data
sxigainfit - Calculates the SXI time-dependent energy gain corrections for events from comparison with known calibration lines
sximodegti - Creates GTI excluding dead time for each SXI observing
sxinxbgen - Creates a Non-X-ray Background (NXB) spectrum for SXI
sxiphas - Merges inner 3x3 and outer 5x5 pulse height columns in SXI event list
sxipi - Calculates pulse invariant (PI) values and assign grades for SXI events
sxipipeline - Calculates pulse invariant (PI) values and assign grades for SXI events
sxirmf - Creates an SXI energy Redistribution Matrix File (RMF)

SXS Applications

mxsgti - Creates MXS GTI files
mxstime - Calculates the times of the MXS start and stop and generates coarse and fine GTI files
sxsanticolc - Extracts SXS antico light curve(s) and spectra using optional screening criteria
sxsanticopi - Assigns PHA and PI columns to the SXS anticoincidence events
sxsbranch - Computes rates, branching ratios, and effective exposure times for each SXS event grade for an input real or simulated file, or based on a count rate
sxsextend - Reruns tasks sxspha2pi, sxsperseus (if necessary), and ahscreen in order to produce SXS event files in extended energy mode
sxsflagpix - Flags SXS events for antico and MXS event coincidence, temporal proximity, and crosstalk
sxsgain - Calculates the time-dependent energy correction for SXS events from comparison with known calibration lines
sxsmkrmf - Creates an SXS RMF file and/or an RSP file for selected SXS pixels and grades
sxsnxbgen - Creates a Non-X-ray Background (NXB) spectrum for SXS
sxsperseus - Removes differential gain error and fiducial gain error
sxspha2pi - Calculates the PI for the SXS event files
sxspipeline - SXS reprocessing tool
sxspixgti - Creates SXS GTI files
sxsregext - Extracts SXS data products from an event file using a region and selection of grades.
sxsrmf - Creates an SXS RMF file for selcted SXS pixels and grades with weighting factors
sxssamcnt - Calculates the local time in the SXS files necessary to assign time
sxsseccor - Corrects PHA for secondary events
sxssecid - Associates SXS secondary events to the primary and allow to recalculate event grades

Non-Hitomi-Specific Applications

Attitude

aberattitude - Corrects an attitude file for aberration effects
aberposition - Corrects coordinates for aberration effects
attconvert - Converts attitude format
coordevt - Converts events from one coordinate system to another
coordpnt - Converts a single point or region file from one coordinate system to another
det2att2 - Converts detector coordinate offsets and rotations to attitude quaternions

FTOOL TIME Applications

gticolconv - Merges or splits GTI based on specified 'column' and 'direction'
gtiinvert - Creates a gti file by inverting the time intervals of an input gti file

HEASIM Applications

heasim - Multi-mission high-energy astrophysics simulation tool
skyback - Simulates the total, broadband, discrete and diffuse high-energy astrophysical background

HEAGEN Applications

arftable - Creates an ancillary response function (ARF), or effective area file from the output events from the raytracing code xrtraytrace, not including any detector efficiencies
dustmodeleffarea - For X-ray point sources with dust halos, makes an effective area correction (or modifier) file, with the option of inputting raytracing event files made by the tool dustyarfmod
dustyarfmod - For X-ray point sources with dust halos, makes an effective area correction (or modifier) file, with the option of running raytracing simulations for the calculations
eeftable - Creates an encircled energy function (EEF) file based on the output history file from the raytracing tool xrtraytrace
xrtraytrace - Performs raytracing simulations of X-ray telescopes, calculating photon paths, PSF, EEF, and effective area
xrtreftable - Calculates the probability of reflection and transmission of a ray upon a surface, and mass absorption coefficients for mirror surface
barycen - Applies barycenter corrections to X-ray timing data

HEASARC Applications

searchflickpix - Searches for anomalous 'flickering' pixels in event files from CCD-type detectors

SEE ALSO

LAST MODIFIED

August 2024