uwacan._core.TimeDataRoller#

class TimeDataRoller(obj, duration=None, step=None, overlap=0, squeeze_time=True)[source]#

Bases: Roller

Rolling windows of time data.

Parameters:
objTimeData

The time data wrapper to roll over.

durationfloat

The duration of each frame, in seconds.

stepfloat

The step between consecutive frames, in seconds.

overlapfloat

The overlap between consecutive frames, as a fraction of the duration.

squeeze_timebool, default True

If this is set to False, rolling over windows with single time values will still give output with a time axis/dim.

Methods

numpy_frames()

Generate numpy frames with data.

time_data()

Generate rolling frames of the contained data, as TimeData.

Inherited methods

Attributes

coords

The coords of the output frames.

dims

The dimensions of the output frames.

num_frames

The number of frames in this rolling output.

shape

The shape of the output frames.