pyart.correct.GateFilter.exclude_below

GateFilter.exclude_below(field, value, exclude_masked=True, op='or', inclusive=False)[source]

Exclude gates where a given field is below a given value.

Parameters

  • field (str) – Name of field compared against the value.

  • value (float) – Gates with a value below this value in the specified field will be marked for exclusion in the filter.

  • exclude_masked (bool, optional) – True to filter masked values in the specified field if the data is a masked array, False to include any masked values.

  • op ({‘and’, ‘or’, ‘new’}) – Operation to perform when merging the existing set of excluded gates with the excluded gates from the current operation. ‘and’ will perform a logical AND operation, ‘or’ a logical OR, and ‘new’ will replace the existing excluded gates with the one generated here. ‘or’, the default for exclude methods, is typically desired when building up a set of conditions for excluding gates where the desired effect is to exclude gates which meet any of the conditions. ‘and’, the default for include methods, is typically desired when building up a set of conditions where the desired effect is to include gates which meet any of the conditions. Note that the ‘and’ method MAY results in including gates which have previously been excluded because they were masked or invalid.

  • inclusive (bool) – Indicates whether the specified value should also be excluded.