HESSI Objects Reference Manual
This document:
(1) Presents the class diagram of the HESSI data analysis Software; (2)
Describes the object classes used in run-time configurations of the data
analysis software; (3) Describes the object accessor methods available to
retrieve data from the objects; (4) Describes control parameters and keywords
allowing to modify the contents of the objects; (5) Describes data structures
used by the classes. This document needs not to be read for analyzing HESSI
data. Instead, users of the data analysis software might want to look at the HESSI Imaging Overview describing the
command-line user interface or by using the hessi graphical user interface
(type hessi at the prompt). Furthermore, you may
also read the utility quick reference guide for an introduction to HESSI
object classes. This manual is intended to developers who need to understand
all low-level details. It is assumed that you have installed both IDL
version 5.3, as well as the Solar Soft Tree with at least the
HESSI, SPEX and XRAY branches of the tree.
See the diagram on your browser or get a
printable pdf version of the diagram.
Classes that are usually accessed by users are written in boldface. Other classes are internal steps used by collaborating classes.
Name
|
Purpose
|
Data type
|
Control parameters |
Info parameters |
|
Generic
abstract data analysis class |
Defined in
concrete class |
Defined in
concrete class |
Defined in concrete
class |
|
|
Binned event
lists |
Array
of{hsi_binned_event} |
front_segment,
rear_segment, det_index_mask,
time_bin_def, time_bin_min |
||
|
Back projection |
Image of
dimension rmap_dim |
none |
||
|
Abstract
class for the back projection methods |
N/A |
N/A |
|
|
|
Back
projection annular sector strategy |
Image of
dimension rmap_dim |
none |
||
|
Calibrated
event list |
Array of {hsi_calib_event} |
Tba |
tba |
|
|
CLEAN
algorithm |
2D array |
Tba |
tba |
|
|
Event list |
Array of {hsi_event} |
none |
||
|
Event lists
from telemetry packets |
Array of {hsi_event} |
same as HSI_Eventlist_Strategy |
same as HSI_Eventlist_Strategy |
|
|
Event lists
from simulations |
Array of {hsi_event} |
same as HSI_Eventlist_Strategy |
same as HSI_Eventlist_Strategy |
|
|
Parent class
of |
Array of {hsi_event} |
|||
|
FITS file
handler |
tba |
Tba |
tba |
|
|
Ground
Support Equipment file handler |
{hsi_gse_data} |
Tba |
tba |
|
|
Images |
FltArr( image_dim[0],
image_dim[1] ) |
image_algorithm |
tbd |
|
|
Abstract
class for imaging algorithms |
Through
concrete class |
Through
concrete class |
Through
concrete class |
|
|
Generation
and access of light curves |
FltArr(
n_time_bins, n_energy_bands, n_a2ds, coincdences ) |
ltc_energy_band, ltc_time_range,
ltc_time_resolution, all control parameters
from hsi_spectrogram |
none |
|
|
Maximum
entropy algorithm |
2D arrray |
Tba |
tba |
|
|
Modulation
patterns |
3D arrray |
Tba |
tba |
|
|
Monitor rate
reader |
||||
|
Unpacked
telemetry packet |
{hsi_packet_source} |
File_type,
app_id |
n_record |
|
|
Point Spread
Function |
fltarr(image_dim[0],
image_dim[1]) |
xy_pixel |
tbd |
|
|
Simulations |
Replicate(
{hsi_event}, n_event ) |
|
sim_out_time_unit,
sim_ref_time |
|
|
Spectrogram
abstract class |
FltArr(
n_channel_bins or n_energy_bins, n_time_intervals, n_a2ds, n_coincidences ) |
poisson,
seed, coincidence_flag, sum_flag |
binning |
|
|
Generates
count rate spectra |
FltArr(
n_energy_bins or n_channel_bins, n_time_intervals, n_a2ds, coincidence_flag+1
) |
sp_time_interval,
sp_time_range, sp_chan_binning, sp_data_unit, sp_energy_binning |
tbd |
|
|
Allows
keeping track of selected elements in a list |
N/A |
N/A |
N/A |
|
|
Grouping of
related classes |
[abstract] |
N/A |
N/A |
|