pyhctsa.operations.physics.walker¶

pyhctsa.operations.physics.walker(y, walker_rule='prop', walker_params=None)¶

Simulates a hypothetical walker moving through the time domain.

The hypothetical particle (or ‘walker’) moves in response to values of the time series at each point. Outputs from this operation are summaries of the walker’s motion, and comparisons of it to the original time series.

Parameters:¶

y : array-like¶

The input time series.

walker_rule : str, optional¶

The kinematic rule by which the walker moves in response to the time series over time:

• ’prop’: the walker narrows the gap between its value and that of the time series by a given proportion p. walker_params = p

• ’biasprop’: biased motion; narrows the gap by p_up when pushed up and p_down when pushed down. walker_params = [pup, pdown]

• ’momentum’: the walker moves with mass m and inertia from the previous step; the time series acts as a force. walker_params = m

• ’runningvar’: inertial motion as above, with values rescaled to match the local variance of the time series. walker_params = [m, wl] (inertial mass, window length)

Default is 'prop'.

walker_params : float, int, or list, optional¶

The parameters for the specified walker_rule. Default is None (use pre-defined defaults).

Returns:¶

Summaries of the walker’s trajectory and its relationship to the series.

Return type:¶

dict