MonthlyFourier.sample_curve#

MonthlyFourier.sample_curve(parameters, use_dates=False, start_date=None, sum=True)[source]#

Create full period of the Fourier seasonality.

Parameters:
parametersxr.DataTree | xr.Dataset

Inference data or dataset containing the Fourier parameters. Can be posterior or prior.

use_datesbool, optional

If True, use datetime coordinates for the x-axis. Defaults to False.

start_datedatetime.datetime, optional

Starting date for the Fourier curve. If not provided and use_dates is True, it will be derived from the current year or month. Defaults to None.

sumbool, default True

Whether to sum the Fourier components. If False, returns individual components along the {prefix} dimension (e.g. "fourier").

Returns:
xr.DataArray

Full period of the Fourier seasonality.