Radar.add_filter(gatefilter, replace_existing=False, include_fields=None)[source]#

Updates the radar object with an applied gatefilter provided by the user that masks values in fields within the radar object.

  • gatefilter (GateFilter) – GateFilter instance. This filter will exclude equal to the conditions provided in the gatefilter and mask values in fields specified or all fields if include_fields is None.

  • replace_existing (bool, optional) – If True, replaces the fields in the radar object with copies of those fields with the applied gatefilter. False will return new fields with the appended ‘filtered_’ prefix.

  • include_fields (list, optional) – List of fields to have filtered applied to. If none, all fields will have applied filter.