pyart.correct.GateFilter.exclude_transition

GateFilter.exclude_transition(trans_value=1, exclude_masked=True, op='or')

Exclude all gates in rays marked as in transition between sweeps.

Exclude all gates in rays marked as “in transition” by the antenna_transition attribute of the radar used to construct the filter. If no antenna transition information is available no gates are excluded.

Parameters

• trans_value (int, optional) – Value used in the antenna transition data to indicate that the instrument was between sweeps (in transition) during the collection of a specific ray. Typically a value of 1 is used to indicate this transition and the default can be used in these cases.

• exclude_masked (bool, optional) – True to filter masked values in antenna_transition 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.