ImageExtractor 0.1.0

Release 0.1.0

Description

First pre-release version of image_extractor. Reads events from a simtel file in ctapipe, uses bins_cuts_dict from EventDisplay MSCW stage to apply pre-selection cuts and binning, writes images and other metadata parameters to Pytables formatted HDF5.

IMPORTANT NOTE: Release v0.1.0 contains deprecated image_extractor implementations (using ROOT and h5py) in various directories for reference. The newest, working version described above is located in image-extractor/ctapipe/v2_pytables/ and is named image_extractor_pytables.py. Starting from v0.2.0, all older implementations will be removed and only the current ctapipe/Pytables implementation will be supported.

Features

• Requires a saved dict (pickled) from EventDisplay MSCW analysis to determine array-level parameter cuts and energy binning
• Supports both 'all' (storage of metadata + images + blank images in a single table) and 'mapped' (storage of metadata and indices to images in table, images stored separately in arrays) modes.
• Supports both gamma-hadron classification and energy reconstruction (classification) modes
• Supports charge-only image arrays, charge + peak_pos image arrays, padded image arrays
• Supports scaling of image sizes
• Supports channels_first and channels_last image array dimension ordering
• Saves telescope information (tel_id, type, position) in a table, one per file
• Uses config_obj formatted config files to handle processing options
• Utilizes default ctapipe data calibration. Charge values per pixel are re-scaled, truncated, and converted to int.
• Saves the following event-level parameters:
  • event number
  • run number
  • gamma-hadron label (0 vs. 1)
  • MC energy
  • reconstructed energy (from EventDisplay MSCW)
  • trig_list
  • tel_map (for mapped storage method)

Notes

• Does not meet internal style guidelines (ctapipe)
• Only supports saving SCT telescope images to arrays. Although other telescope selection modes (including SST and LST) are included in the configuration file, they are not implemented and should not be used
• Telescope types determined using num_pixels
• Particle type determined by parsing input file name

v0.1 - preliminary

Preliminary release for generation of first set of image data.

Includes support for the following metadata fields:

eventType (only gamma and proton supported)
eventID
impactParameter
telescopeNumber
telx
tely
MCprim
MCe0
MCxcore
MCycore
MCze
MCaz
MCxoff
MCyoff
pedrms