.. .. copyright (C) 2024 .. The Icecube Collaboration .. .. @author Katherine Rawlins PulseExtractor modules for South Pole processing ================================================ These modules are used during South Pole processing (online_filterscripts), to create I3RecoPulses from I3Waveform's. There are two different modules for doing this: one for IceTop HLC's, and one for IceTop SLC's. I3TopHLCPulseExtractor ---------------------- Extract pulses from HLC waveforms and calibrate to PE and/or VEM. The pulse charge is determined by integrating the whole waveform. Pulse time is defined by the "leading edge", i.e. the slope between the bins where 10 and 90% of the first peak are reached extrapolated to the baseline. The trailing edge of the pulse is defined as the point where the waveform drops below 10% of the first pulse for the last time. This is used to calculate the pulse width. Furthermore the rise time of the 10-90% slope and the pulse amplitude are calculated. Parameters ^^^^^^^^^^ ``Waveforms`` Calibrated input waveforms. Use ``I3WaveformSplitter`` from :ref:`WaveCalibrator-main` to extract HLC ATWD waveforms from WaveCalibrator output. ``PEPulses`` Name of the ``I3RecoPulseSeriesMap`` with pulses calibrated in PE. Set to an empty string if you do not need these pulses. They are still calculated, however, because they are the bases of the VEM pulses. ``VEMPulses`` Name of the pulses calibrated in VEM. Set to an empty string if you do not need them. In that case they are never determined (e.g. in vemcal). ``PulseInfo`` Pulse info objects. These contain additional information that cannot be stored in :cpp:class:`I3RecoPulse`\ s, like amplitude and rise-time. Writes and :cpp:type:`I3TopPulseInfoSeriesMap` to the frame. ``MinimumLeadingEdgeTime`` Earliest possible time of the leading edge, measured from the beginning of the ATWD waveform. If the leading-edge extrapolation returns a time earlier that this minimum (for example, when the algorithm extrapolates from the peak rather than the true leading edge because the ATWD turns on halfway into the pulse), the leading-edge time will be snapped to this value. ``BadDomList`` A list of bad DOMs. All waveforms from DOMs on this list are ignored. I3TopSLCPulseExtractor ---------------------- Treats SLC charge stamps. Parameters ^^^^^^^^^^ ``Waveforms`` Calibrated input waveforms. Use ``I3WaveformSplitter`` from :ref:`WaveCalibrator-main` to extract HLC ATWD waveforms from WaveCalibrator output. ``PEPulses`` Name of the ``I3RecoPulseSeriesMap`` with pulses calibrated in PE. Set to an empty string if you do not need these pulses. They are still calculated, however, because they are the bases of the VEM pulses. ``VEMPulses`` Name of the pulses calibrated in VEM. Set to an empty string if you do not need them. In that case they are never determined (e.g. in vemcal). ``BadDomList`` A list of bad DOMs. All waveforms from DOMs on this list are ignored.