icecube.offline_filterscripts.ref_offline_filter_mask module

Reference offline filter mask tray segment.

This segment will copy the OfflineFilterMask to Ref_OfflineFilterMask in each P frame. Optionally compress P frames to a Q frame, storing each P-frame Ref_OfflineFilterMask in the Q frame labelled with a suffix like _InIceSplit2.

icecube.offline_filterscripts.ref_offline_filter_mask.ref_offline_filter_mask(tray, name='ref_offline_filter_mask', *, eatP=True)

Create reference objects and optionally compress P frames to Q frames.

This segment will copy the OfflineFilterMask to Ref_OfflineFilterMask in each P frame. Optionally compress P frames to a Q frame, storing each P-frame Ref_OfflineFilterMask in the Q frame labelled with a suffix like _InIceSplit2.

Parameters:
  • tray – The tray object.

  • name – The name of this segment.

  • eatP – A boolean indicating whether to compress P frames to Q frames