runtimepy.task.trig package

runtimepy.task.trig package#

Module contents#

A module implementing basic trigonometric tasks.

class runtimepy.task.trig.Sinusoid[source]#

Bases: TaskFactory[SinusoidTask]

A factory for the sinusoid task.

kind#

alias of SinusoidTask

class runtimepy.task.trig.SinusoidTask(name: str, average_depth: int = 10, metrics: PeriodicTaskMetrics = None, period_s: float = 1.0, env: ChannelEnvironment = None, period_controls: dict[str, int | float | bool | dict[str, int | float | bool]] | str = 'period', markdown: str = None, config: dict[str, str | int | float | bool | None | dict[str, str | int | float | bool | None] | list[str | int | float | bool | None]] = None)[source]#

Bases: ArbiterTask, TrigMixin

A task for logging metrics.

auto_finalize = True#
async dispatch() → bool[source]#

Dispatch an iteration of this task.

Contents