utils.noise.from_series

utils.noise.from_series(target_series, method, number=1, seed=None, label=None)

Generate surrogate series matched to a target Pyleoclim series.

Parameters

target_series : pyleoclim.Series

Target series used to infer surrogate properties (time axis, autocorrelation structure, etc.).

method : str

Surrogate method. Supported values: 'ar1sim', 'phaseran', 'uar1'.

number : int = 1

Number of surrogate realizations to generate. Default 1.

seed : int or None = None

Random seed for reproducibility. Default None.

label : str or None = None

Label attached to the returned SurrogateSeries. Default None.

Returns

surr : pyleoclim.SurrogateSeries

Surrogate series object; surr.series_list contains number series.

See also

pyleoclim.SurrogateSeries : Underlying surrogate generator.

Examples

import pyleoclim as pyleo
from climatecritters.utils.noise import from_series

soi = pyleo.utils.load_dataset('SOI')
surr = from_series(soi, method='ar1sim', number=10, seed=42)