pyart.filters.class_based_gate_filter#
- pyart.filters.class_based_gate_filter(radar, field=None, kept_values=None)[source]#
Create a filter which removes undesired gates based on class values
- Parameters:
radar (Radar) – Radar object from which the gate filter will be built.
field (str) – Name of the radar field which contains the classification. A value of None for will use the default field name for the hydrometeor classification as defined in the Py-ART configuration file.
kept_values (list of ints or none) – The class values to keep
- Returns:
gatefilter (
GateFilter) – A gate filter based upon the described criteria. This can be used as a gatefilter parameter to various functions in pyart.correct.