pyart.correct.GateFilter.include_gates#

GateFilter.include_gates(mask, exclude_masked=True, op='and')[source]#

Include gates where a given mask is equal True.

Parameters:

mask (numpy array) – Boolean numpy array with same shape as a field array.
exclude_masked (bool, optional) – True to filter masked values in the specified mask if it 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 ‘or’ method MAY results in excluding gates which have previously been included.