Timeline functions
rerun
def set_time(timeline, *, recording=None, sequence=None, duration=None, timestamp=None)
Set the current time of a timeline for this thread.
Used for all subsequent logging on the same thread, until the next call to
rerun.set_time, rerun.reset_time or rerun.disable_timeline.
For example: set_time("frame_nr", sequence=frame_nr).
There is no requirement of monotonicity. You can move the time backwards if you like.
You are expected to set exactly ONE of the arguments sequence, duration, or timestamp.
You may NOT change the type of a timeline, so if you use duration for a specific timeline,
you must only use duration for that timeline going forward.
The columnar equivalent to this function is rerun.TimeColumn.
| PARAMETER | DESCRIPTION |
|---|---|
timeline
|
The name of the timeline to set the time for.
TYPE:
|
recording
|
Specifies the
TYPE:
|
sequence
|
Used for sequential indices, like
TYPE:
|
duration
|
Used for relative times, like
TYPE:
|
timestamp
|
Used for absolute time indices, like
TYPE:
|
def disable_timeline(timeline, recording=None)
Clear time information for the specified timeline on this thread.
| PARAMETER | DESCRIPTION |
|---|---|
timeline
|
The name of the timeline to clear the time for.
TYPE:
|
recording
|
Specifies the
TYPE:
|
def reset_time(recording=None)
Clear all timeline information on this thread.
This is the same as calling disable_timeline for all of the active timelines.
Used for all subsequent logging on the same thread,
until the next call to rerun.set_time.
| PARAMETER | DESCRIPTION |
|---|---|
recording
|
Specifies the
TYPE:
|