rdtools.filtering.clip_filter¶
- rdtools.filtering.clip_filter(power_ac, model='quantile', **kwargs)¶
Master wrapper for running one of the desired clipping filters. The default filter run is the quantile clipping filter.
- Parameters
power_ac (pandas.Series) -- Pandas time series, representing PV system power or energy. For best performance, timestamps should be in local time.
model (str, default 'quantile') -- Clipping filter model to run. Can be 'quantile', 'xgboost', or 'logic'. Note: using the xgboost model can result in errors on some systems. These can often be alleviated by using conda to install xgboost, see https://anaconda.org/conda-forge/xgboost.
kwargs -- Additional clipping filter args, specific to the model being used. Keyword must be passed with value.
- Returns
Boolean Series of whether to include the point because it is not clipping. True values delineate non-clipping periods, and False values delineate clipping periods.
- Return type