Recording
rerun.recording
class RRDArchive
deprecated
Deprecated
RRDArchive is deprecated since 0.32. Use rerun.experimental.RrdReader instead.
An archive loaded from an RRD.
RRD archives may include 1 or more recordings or blueprints.
def all_recordings()
All the recordings in the archive.
def num_recordings()
The number of recordings in the archive.
class Recording
deprecated
Deprecated
Recording is deprecated since 0.32. Use rerun.experimental.RrdReader instead.
A single Rerun recording.
This can be loaded from an RRD file using load_recording().
A recording is a collection of data that was logged to Rerun. This data is organized as a column for each index (timeline) and each entity/component pair that was logged.
You can examine the .schema() of the recording to see
what data is available.
def application_id()
The application ID of the recording.
def chunks()
Iterate over all physical chunks in this recording.
def from_chunks(chunks, application_id, recording_id)
deprecated
staticmethod
Deprecated
Recording.from_chunks is deprecated since 0.32. Use LazyChunkStream.from_iter(chunks) and pass application_id and recording_id to the destination (e.g. .write_rrd(path, application_id=…, recording_id=…)).
Create a new recording from an iterable of chunks.
| PARAMETER | DESCRIPTION |
|---|---|
chunks
|
An iterable of chunks to include in the recording. |
application_id
|
The application ID for the new recording.
TYPE:
|
recording_id
|
The recording ID for the new recording.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Recording
|
The newly created recording. |
def recording_id()
The recording ID of the recording.
def save(path)
Save this recording to an RRD file.
def schema()
The schema describing all the columns available in the recording.
def load_archive(path_to_rrd)
deprecated
Deprecated
load_archive is deprecated since 0.32. Use rerun.experimental.RrdReader(path) instead.
Load a rerun archive from an RRD file.
| PARAMETER | DESCRIPTION |
|---|---|
path_to_rrd
|
The path to the file to load. |
| RETURNS | DESCRIPTION |
|---|---|
RRDArchive
|
The loaded archive. |
def load_recording(path_to_rrd)
deprecated
Deprecated
load_recording is deprecated since 0.32. Use rerun.experimental.RrdReader(path).store() instead.
Load a single recording from an RRD file.
Will raise a ValueError if the file does not contain exactly one recording.
| PARAMETER | DESCRIPTION |
|---|---|
path_to_rrd
|
The path to the file to load. |
| RETURNS | DESCRIPTION |
|---|---|
Recording
|
The loaded recording. |