This Page

scikits.hydroclimpy.core.ts_addons.mask_inside_period

mask_inside_period(data, start_date=None, end_date=None, include_edges=True, inplace=False)

Masks a series where the dates fall inside a given period.

Parameters:

data : Timeseries

Data to process

start_date : {None, string/Date }, optional

Starting date of the masking period. If None, uses the first date of the series.

end_date : {None, string/Date }, optional

Ending date of the masking period. If None, uses the last date of the series.

include_edges : {True, False}, optional

Whether the starting and ending dates should be masked.

inplace : {True, False}, optional

Whether the data mask should be modified in place. If not, returns a new TimeSeries object.