Datatypes
rerun.blueprint.datatypes
ComponentColumnSelectorArrayLike = ComponentColumnSelector | Sequence[ComponentColumnSelectorLike]
module-attribute
A type alias for any ComponentColumnSelector-like array object.
ComponentColumnSelectorLike = ComponentColumnSelector | str
module-attribute
A type alias for any ComponentColumnSelector-like object.
FilterByRangeArrayLike = FilterByRange | Sequence[FilterByRangeLike]
module-attribute
A type alias for any FilterByRange-like array object.
FilterByRangeLike = FilterByRange
module-attribute
A type alias for any FilterByRange-like object.
FilterIsNotNullArrayLike = FilterIsNotNull | Sequence[FilterIsNotNullLike]
module-attribute
A type alias for any FilterIsNotNull-like array object.
FilterIsNotNullLike = FilterIsNotNull | blueprint_datatypes.ComponentColumnSelectorLike
module-attribute
A type alias for any FilterIsNotNull-like object.
SelectedColumnsArrayLike = SelectedColumns | Sequence[SelectedColumnsLike]
module-attribute
A type alias for any SelectedColumns-like array object.
SelectedColumnsLike = SelectedColumns | Sequence[blueprint_datatypes.ComponentColumnSelectorLike | datatypes.Utf8Like]
module-attribute
A type alias for any SelectedColumns-like object.
TensorDimensionIndexSliderArrayLike = TensorDimensionIndexSlider | Sequence[TensorDimensionIndexSliderLike] | npt.ArrayLike
module-attribute
A type alias for any TensorDimensionIndexSlider-like array object.
TensorDimensionIndexSliderLike = TensorDimensionIndexSlider | int
module-attribute
A type alias for any TensorDimensionIndexSlider-like object.
TextLogColumnArrayLike = TextLogColumn | Sequence[TextLogColumnLike]
module-attribute
A type alias for any TextLogColumn-like array object.
TextLogColumnKindArrayLike = TextLogColumnKind | Literal['Body', 'EntityPath', 'LogLevel', 'body', 'entitypath', 'loglevel'] | int | Sequence[TextLogColumnKindLike]
module-attribute
A type alias for any TextLogColumnKind-like array object.
TextLogColumnKindLike = TextLogColumnKind | Literal['Body', 'EntityPath', 'LogLevel', 'body', 'entitypath', 'loglevel'] | int
module-attribute
A type alias for any TextLogColumnKind-like object.
TextLogColumnLike = TextLogColumn | blueprint_datatypes.TextLogColumnKindLike
module-attribute
A type alias for any TextLogColumn-like object.
TimelineColumnArrayLike = TimelineColumn | Sequence[TimelineColumnLike]
module-attribute
A type alias for any TimelineColumn-like array object.
TimelineColumnLike = TimelineColumn | datatypes.Utf8Like
module-attribute
A type alias for any TimelineColumn-like object.
class ComponentColumnSelector
Bases: ComponentColumnSelectorExt
Datatype: Describe a component column to be selected in the dataframe view.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
def __init__(spec=None, *, entity_path=None, component=None)
Create a new instance of the ComponentColumnSelector datatype.
| PARAMETER | DESCRIPTION |
|---|---|
spec
|
A string in the format "/entity/path:Component". If used,
TYPE:
|
entity_path
|
The column's entity path. If used,
TYPE:
|
component
|
The column's component type. If used,
TYPE:
|
class FilterByRange
Bases: FilterByRangeExt
Datatype: Configuration for the filter-by-range feature of the dataframe view.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
def __init__(start, end)
Create a new instance of the FilterByRange datatype.
| PARAMETER | DESCRIPTION |
|---|---|
start
|
Beginning of the time range.
TYPE:
|
end
|
End of the time range (inclusive).
TYPE:
|
class FilterIsNotNull
Bases: FilterIsNotNullExt
Datatype: Configuration for the filter is not null feature of the dataframe view.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
def __init__(active, column)
Create a new instance of the FilterIsNotNull datatype.
| PARAMETER | DESCRIPTION |
|---|---|
active
|
Whether the filter by event feature is active.
TYPE:
|
column
|
The column used when the filter by event feature is used. |
class SelectedColumns
Bases: SelectedColumnsExt
Datatype: List of selected columns in a dataframe.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
def __init__(columns)
Create a new instance of the SelectedColumns datatype.
Example:
SelectedColumns(["timeline", "/entity/path:Component"])
| PARAMETER | DESCRIPTION |
|---|---|
columns
|
The columns to include. The column must be either of the timeline, or component kind. Timeline columns can be specified using a
TYPE:
|
class TensorDimensionIndexSlider
Bases: TensorDimensionIndexSliderExt
Datatype: Defines a slider for the index of some dimension.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
def __init__(dimension)
Create a new instance of the TensorDimensionIndexSlider datatype.
| PARAMETER | DESCRIPTION |
|---|---|
dimension
|
The dimension number. |
class TextLogColumn
Bases: TextLogColumnExt
Datatype: A text log column.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
def __init__(kind, *, visible=True)
Create a new instance of the TextLogColumn datatype.
| PARAMETER | DESCRIPTION |
|---|---|
kind
|
What kind of column is this?
TYPE:
|
visible
|
Is this column visible?
TYPE:
|
class TextLogColumnKind
Bases: Enum
Datatype: A text log column kind.
Body = 3
class-attribute
instance-attribute
The text message the log has.
EntityPath = 1
class-attribute
instance-attribute
Which entity path this was logged to.
LogLevel = 2
class-attribute
instance-attribute
The log level, i.e INFO, WARN, ERROR.
def __str__()
Returns the variant name.
def auto(val)
classmethod
Best-effort converter, including a case-insensitive string matcher.
class TimelineColumn
Bases: TimelineColumnExt
Datatype: A timeline column in a table.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.