ivwdataframe

DataFrame Module API

Functions

`appendColumns`(left, right[, ...])	Create a new DataFrame by appending the columns of DataFrame right to DataFrame left
`appendRows`(top, bottom[, matchByName])	Create a new DataFrame by appending the rows of DataFrame bottom to DataFrame top
`innerJoin`(args, *kwargs)	Overloaded function.
`leftJoin`(left, right, keyColumn)	Create a new DataFrame by using an outer left join of DataFrame left and DataFrame right.

Classes

`CategoricalColumn`
`Column`
`ColumnType`	Members:
`DataFrame`
`DataFrameFlatMultiInport`
`DataFrameInport`
`DataFrameMultiInport`
`DataFrameOutport`
`DoubleColumn`
`FloatColumn`
`IndexColumn`
`Int64Column`
`IntColumn`
`Size_tColumn`
`UIntColumn`

class ivwdataframe.CategoricalColumn

Bases: Column

__init__(self: ivwdataframe.CategoricalColumn, arg0: str) → None

__iter__(self: ivwdataframe.CategoricalColumn) → Iterator[str]

__repr__(self: ivwdataframe.CategoricalColumn) → str

add(self: ivwdataframe.CategoricalColumn, arg0: str) → None

append(*args, **kwargs)

Overloaded function.

append(self: ivwdataframe.CategoricalColumn, arg0: ivwdataframe.CategoricalColumn) -> None
append(self: ivwdataframe.CategoricalColumn, arg0: list[str]) -> None

get(self: ivwdataframe.CategoricalColumn, arg0: int) → str

getId(self: ivwdataframe.CategoricalColumn, arg0: int) → int

set(*args, **kwargs)

Overloaded function.

set(self: ivwdataframe.CategoricalColumn, arg0: int, arg1: int) -> None
set(self: ivwdataframe.CategoricalColumn, arg0: int, arg1: str) -> None

property categories

class ivwdataframe.Column

Bases: pybind11_object

__init__(*args, **kwargs)

__repr__(self: ivwdataframe.Column) → str

property buffer

property customRange

property dataRange

property header

property range

property size

property type

property unit

class ivwdataframe.ColumnType

Bases: pybind11_object

Members:

Index

Ordinal

Categorical

__eq__(self: object, other: object) → bool

__hash__(self: object) → int

__index__(self: ivwdataframe.ColumnType) → int

__init__(self: ivwdataframe.ColumnType, value: int) → None

__int__(self: ivwdataframe.ColumnType) → int

__ne__(self: object, other: object) → bool

__repr__(self: object) → str

__str__(self: object) → str

Categorical = <ColumnType.Categorical: 2>

Index = <ColumnType.Index: 0>

Ordinal = <ColumnType.Ordinal: 1>

property name

property value

class ivwdataframe.DataFrame

Bases: pybind11_object

__getitem__(self: ivwdataframe.DataFrame, arg0: int) → ivwdataframe.Column

__init__(self: ivwdataframe.DataFrame, size: int = 0) → None

__iter__(self: ivwdataframe.DataFrame) → Iterator[ivwdataframe.Column]

__repr__(self: ivwdataframe.DataFrame) → str

addCategoricalColumn(*args, **kwargs)

Overloaded function.

addCategoricalColumn(self: ivwdataframe.DataFrame, header: str, size: int = 0) -> ivwdataframe.CategoricalColumn
addCategoricalColumn(self: ivwdataframe.DataFrame, header: str, values: list[str]) -> ivwdataframe.CategoricalColumn

addColumn(self: ivwdataframe.DataFrame, column: ivwdataframe.Column) → ivwdataframe.Column

addColumnFromBuffer(self: ivwdataframe.DataFrame, identifier: str, buffer: inviwopy.data.Buffer, unit: inviwopy.data.Unit =, range: Optional[inviwopy.glm.dvec2] = None) → ivwdataframe.Column

addDoubleColumn(*args, **kwargs)

Overloaded function.

addDoubleColumn(self: ivwdataframe.DataFrame, header: str, size: int = 0, unit: inviwopy.data.Unit = , range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.DoubleColumn
addDoubleColumn(self: ivwdataframe.DataFrame, header: str, data: std::vector<double,std::allocator<double> >, unit: inviwopy.data.Unit = , range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.DoubleColumn

addFloatColumn(*args, **kwargs)

Overloaded function.

addFloatColumn(self: ivwdataframe.DataFrame, header: str, size: int = 0, unit: inviwopy.data.Unit = , range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.FloatColumn
addFloatColumn(self: ivwdataframe.DataFrame, header: str, data: std::vector<float,std::allocator<float> >, unit: inviwopy.data.Unit = , range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.FloatColumn

addInt64Column(*args, **kwargs)

Overloaded function.

addInt64Column(self: ivwdataframe.DataFrame, header: str, size: int = 0, unit: inviwopy.data.Unit = , range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.Int64Column
addInt64Column(self: ivwdataframe.DataFrame, header: str, data: list[int], unit: inviwopy.data.Unit = , range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.Int64Column

addIntColumn(*args, **kwargs)

Overloaded function.

addIntColumn(self: ivwdataframe.DataFrame, header: str, size: int = 0, unit: inviwopy.data.Unit = , range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.IntColumn
addIntColumn(self: ivwdataframe.DataFrame, header: str, data: std::vector<int,std::allocator<int> >, unit: inviwopy.data.Unit = , range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.IntColumn

addSize_tColumn(*args, **kwargs)

Overloaded function.

addSize_tColumn(self: ivwdataframe.DataFrame, header: str, size: int = 0, unit: inviwopy.data.Unit = , range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.Size_tColumn
addSize_tColumn(self: ivwdataframe.DataFrame, header: str, data: list[int], unit: inviwopy.data.Unit = , range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.Size_tColumn

addUIntColumn(*args, **kwargs)

Overloaded function.

addUIntColumn(self: ivwdataframe.DataFrame, header: str, size: int = 0, unit: inviwopy.data.Unit = , range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.UIntColumn
addUIntColumn(self: ivwdataframe.DataFrame, header: str, data: std::vector<unsigned int,std::allocator<unsigned int> >, unit: inviwopy.data.Unit = , range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.UIntColumn

column(self: ivwdataframe.DataFrame, arg0: int) → ivwdataframe.Column

dropColumn(*args, **kwargs)

Overloaded function.

dropColumn(self: ivwdataframe.DataFrame, name: str) -> None
dropColumn(self: ivwdataframe.DataFrame, index: int) -> None

getColumn(*args, **kwargs)

Overloaded function.

getColumn(self: ivwdataframe.DataFrame, name: str) -> ivwdataframe.Column
getColumn(self: ivwdataframe.DataFrame, index: int) -> ivwdataframe.Column

getIndexColumn(self: ivwdataframe.DataFrame) → ivwdataframe.IndexColumn

indexcol(self: ivwdataframe.DataFrame) → ivwdataframe.IndexColumn

updateIndex(self: ivwdataframe.DataFrame) → None

property cols

property rows

class ivwdataframe.DataFrameFlatMultiInport

Bases: Inport

class ChangedAndDataGenerator

Bases: pybind11_object

__init__(*args, **kwargs)

__next__(self: ivwdataframe.DataFrameFlatMultiInport.ChangedAndDataGenerator) → tuple[bool, ivwdataframe.DataFrame]

class DataGenerator

Bases: pybind11_object

__init__(*args, **kwargs)

__next__(self: ivwdataframe.DataFrameFlatMultiInport.DataGenerator) → ivwdataframe.DataFrame

class OutportAndDataGenerator

Bases: pybind11_object

__init__(*args, **kwargs)

__next__(self: ivwdataframe.DataFrameFlatMultiInport.OutportAndDataGenerator) → tuple[inviwopy.Outport, ivwdataframe.DataFrame]

__init__(self: ivwdataframe.DataFrameFlatMultiInport, identifier: str, help: inviwopy.doc.Document = <inviwopy.doc.Document object at 0x000001F4A5FD4D70>) → None

changedAndData(self: ivwdataframe.DataFrameFlatMultiInport) → ivwdataframe.DataFrameFlatMultiInport.ChangedAndDataGenerator

data(self: ivwdataframe.DataFrameFlatMultiInport) → ivwdataframe.DataFrameFlatMultiInport.DataGenerator

getData(self: ivwdataframe.DataFrameFlatMultiInport) → ivwdataframe.DataFrame

getSourceVectorData(self: ivwdataframe.DataFrameFlatMultiInport) → list[tuple[inviwopy.Outport, ivwdataframe.DataFrame]]

getVectorData(self: ivwdataframe.DataFrameFlatMultiInport) → list[ivwdataframe.DataFrame]

hasData(self: ivwdataframe.DataFrameFlatMultiInport) → bool

outportAndData(self: ivwdataframe.DataFrameFlatMultiInport) → ivwdataframe.DataFrameFlatMultiInport.OutportAndDataGenerator

class ivwdataframe.DataFrameInport

Bases: Inport

class ChangedAndDataGenerator

Bases: pybind11_object

__init__(*args, **kwargs)

__next__(self: ivwdataframe.DataFrameInport.ChangedAndDataGenerator) → tuple[bool, ivwdataframe.DataFrame]

class DataGenerator

Bases: pybind11_object

__init__(*args, **kwargs)

__next__(self: ivwdataframe.DataFrameInport.DataGenerator) → ivwdataframe.DataFrame

class OutportAndDataGenerator

Bases: pybind11_object

__init__(*args, **kwargs)

__next__(self: ivwdataframe.DataFrameInport.OutportAndDataGenerator) → tuple[inviwopy.Outport, ivwdataframe.DataFrame]

__init__(self: ivwdataframe.DataFrameInport, identifier: str, help: inviwopy.doc.Document = <inviwopy.doc.Document object at 0x000001F4A5EAD570>) → None

changedAndData(self: ivwdataframe.DataFrameInport) → ivwdataframe.DataFrameInport.ChangedAndDataGenerator

data(self: ivwdataframe.DataFrameInport) → ivwdataframe.DataFrameInport.DataGenerator

getData(self: ivwdataframe.DataFrameInport) → ivwdataframe.DataFrame

getSourceVectorData(self: ivwdataframe.DataFrameInport) → list[tuple[inviwopy.Outport, ivwdataframe.DataFrame]]

getVectorData(self: ivwdataframe.DataFrameInport) → list[ivwdataframe.DataFrame]

hasData(self: ivwdataframe.DataFrameInport) → bool

outportAndData(self: ivwdataframe.DataFrameInport) → ivwdataframe.DataFrameInport.OutportAndDataGenerator

class ivwdataframe.DataFrameMultiInport

Bases: Inport

class ChangedAndDataGenerator

Bases: pybind11_object

__init__(*args, **kwargs)

__next__(self: ivwdataframe.DataFrameMultiInport.ChangedAndDataGenerator) → tuple[bool, ivwdataframe.DataFrame]

class DataGenerator

Bases: pybind11_object

__init__(*args, **kwargs)

__next__(self: ivwdataframe.DataFrameMultiInport.DataGenerator) → ivwdataframe.DataFrame

class OutportAndDataGenerator

Bases: pybind11_object

__init__(*args, **kwargs)

__next__(self: ivwdataframe.DataFrameMultiInport.OutportAndDataGenerator) → tuple[inviwopy.Outport, ivwdataframe.DataFrame]

__init__(self: ivwdataframe.DataFrameMultiInport, identifier: str, help: inviwopy.doc.Document = <inviwopy.doc.Document object at 0x000001F4A609A1F0>) → None

changedAndData(self: ivwdataframe.DataFrameMultiInport) → ivwdataframe.DataFrameMultiInport.ChangedAndDataGenerator

data(self: ivwdataframe.DataFrameMultiInport) → ivwdataframe.DataFrameMultiInport.DataGenerator

getData(self: ivwdataframe.DataFrameMultiInport) → ivwdataframe.DataFrame

getSourceVectorData(self: ivwdataframe.DataFrameMultiInport) → list[tuple[inviwopy.Outport, ivwdataframe.DataFrame]]

getVectorData(self: ivwdataframe.DataFrameMultiInport) → list[ivwdataframe.DataFrame]

hasData(self: ivwdataframe.DataFrameMultiInport) → bool

outportAndData(self: ivwdataframe.DataFrameMultiInport) → ivwdataframe.DataFrameMultiInport.OutportAndDataGenerator

class ivwdataframe.DataFrameOutport

Bases: Outport

__init__(self: ivwdataframe.DataFrameOutport, identifier: str, help: inviwopy.doc.Document = <inviwopy.doc.Document object at 0x000001F4A5DD9F70>) → None

detatchData(self: ivwdataframe.DataFrameOutport) → ivwdataframe.DataFrame

getData(self: ivwdataframe.DataFrameOutport) → ivwdataframe.DataFrame

setData(self: ivwdataframe.DataFrameOutport, arg0: ivwdataframe.DataFrame) → None

class ivwdataframe.DoubleColumn

Bases: Column

__init__(self: ivwdataframe.DoubleColumn, arg0: str) → None

__iter__(self: ivwdataframe.DoubleColumn) → Iterator[float]

__repr__(self: ivwdataframe.DoubleColumn) → str

add(*args, **kwargs)

Overloaded function.

add(self: ivwdataframe.DoubleColumn, arg0: float) -> None
add(self: ivwdataframe.DoubleColumn, arg0: str) -> None

append(self: ivwdataframe.DoubleColumn, arg0: ivwdataframe.DoubleColumn) → None

get(self: ivwdataframe.DoubleColumn, i: int) → float

getAsString(self: ivwdataframe.DoubleColumn, i: int) → str

set(self: ivwdataframe.DoubleColumn, arg0: int, arg1: float) → None

property buffer

class ivwdataframe.FloatColumn

Bases: Column

__init__(self: ivwdataframe.FloatColumn, arg0: str) → None

__iter__(self: ivwdataframe.FloatColumn) → Iterator[float]

__repr__(self: ivwdataframe.FloatColumn) → str

add(*args, **kwargs)

Overloaded function.

add(self: ivwdataframe.FloatColumn, arg0: float) -> None
add(self: ivwdataframe.FloatColumn, arg0: str) -> None

append(self: ivwdataframe.FloatColumn, arg0: ivwdataframe.FloatColumn) → None

get(self: ivwdataframe.FloatColumn, i: int) → float

getAsString(self: ivwdataframe.FloatColumn, i: int) → str

set(self: ivwdataframe.FloatColumn, arg0: int, arg1: float) → None

property buffer

class ivwdataframe.IndexColumn

Bases: UIntColumn

__init__(self: ivwdataframe.IndexColumn, arg0: str) → None

class ivwdataframe.Int64Column

Bases: Column

__init__(self: ivwdataframe.Int64Column, arg0: str) → None

__iter__(self: ivwdataframe.Int64Column) → Iterator[int]

__repr__(self: ivwdataframe.Int64Column) → str

add(*args, **kwargs)

Overloaded function.

add(self: ivwdataframe.Int64Column, arg0: int) -> None
add(self: ivwdataframe.Int64Column, arg0: str) -> None

append(self: ivwdataframe.Int64Column, arg0: ivwdataframe.Int64Column) → None

get(self: ivwdataframe.Int64Column, i: int) → int

getAsString(self: ivwdataframe.Int64Column, i: int) → str

set(self: ivwdataframe.Int64Column, arg0: int, arg1: int) → None

property buffer

class ivwdataframe.IntColumn

Bases: Column

__init__(self: ivwdataframe.IntColumn, arg0: str) → None

__iter__(self: ivwdataframe.IntColumn) → Iterator[int]

__repr__(self: ivwdataframe.IntColumn) → str

add(*args, **kwargs)

Overloaded function.

add(self: ivwdataframe.IntColumn, arg0: int) -> None
add(self: ivwdataframe.IntColumn, arg0: str) -> None

append(self: ivwdataframe.IntColumn, arg0: ivwdataframe.IntColumn) → None

get(self: ivwdataframe.IntColumn, i: int) → int

getAsString(self: ivwdataframe.IntColumn, i: int) → str

set(self: ivwdataframe.IntColumn, arg0: int, arg1: int) → None

property buffer

class ivwdataframe.Size_tColumn

Bases: Column

__init__(self: ivwdataframe.Size_tColumn, arg0: str) → None

__iter__(self: ivwdataframe.Size_tColumn) → Iterator[int]

__repr__(self: ivwdataframe.Size_tColumn) → str

add(*args, **kwargs)

Overloaded function.

add(self: ivwdataframe.Size_tColumn, arg0: int) -> None
add(self: ivwdataframe.Size_tColumn, arg0: str) -> None

append(self: ivwdataframe.Size_tColumn, arg0: ivwdataframe.Size_tColumn) → None

get(self: ivwdataframe.Size_tColumn, i: int) → int

getAsString(self: ivwdataframe.Size_tColumn, i: int) → str

set(self: ivwdataframe.Size_tColumn, arg0: int, arg1: int) → None

property buffer

class ivwdataframe.UIntColumn

Bases: Column

__init__(self: ivwdataframe.UIntColumn, arg0: str) → None

__iter__(self: ivwdataframe.UIntColumn) → Iterator[int]

__repr__(self: ivwdataframe.UIntColumn) → str

add(*args, **kwargs)

Overloaded function.

add(self: ivwdataframe.UIntColumn, arg0: int) -> None
add(self: ivwdataframe.UIntColumn, arg0: str) -> None

append(self: ivwdataframe.UIntColumn, arg0: ivwdataframe.UIntColumn) → None

get(self: ivwdataframe.UIntColumn, i: int) → int

getAsString(self: ivwdataframe.UIntColumn, i: int) → str

set(self: ivwdataframe.UIntColumn, arg0: int, arg1: int) → None

property buffer

ivwdataframe.appendColumns(left: ivwdataframe.DataFrame, right: ivwdataframe.DataFrame, ignoreDuplicates: bool = False, fillMissingRows: bool = False) → ivwdataframe.DataFrame

Create a new DataFrame by appending the columns of DataFrame right to DataFrame left

Parameters:

ignoreDuplicates – duplicate columns, i.e. same column header, are ignored if true
fillMissingRows – if true, missing rows in either DataFrame are filled with 0 or “undefined” (for categorical columns)

ivwdataframe.appendRows(top: ivwdataframe.DataFrame, bottom: ivwdataframe.DataFrame, matchByName: bool = False) → ivwdataframe.DataFrame

Create a new DataFrame by appending the rows of DataFrame bottom to DataFrame top

Parameters:: matchByName – if true, column headers are used for matching columns. Otherwise columns are matched by order (default)

ivwdataframe.innerJoin(*args, **kwargs)

Overloaded function.

innerJoin(left: ivwdataframe.DataFrame, right: ivwdataframe.DataFrame, keyColumn: tuple[str, str] = ‘index’) -> ivwdataframe.DataFrame

Create a new DataFrame by using an inner join of DataFrame left and DataFrame right. That is only rows with matching keys are kept.

It is assumed that the entries in the key columns are unique. Otherwise results are undefined.

Args:

keyColumn: header of the column used as key for the join operation
(default: index column)
innerJoin(left: ivwdataframe.DataFrame, right: ivwdataframe.DataFrame, keyColumn: list[tuple[str, str]]) -> ivwdataframe.DataFrame

Create a new DataFrame by using an inner join of DataFrame left and DataFrame right. That is only rows with matching all keys are kept.

It is assumed that the entries in the key columns are unique. Otherwise results are undefined.

Args:
keyColumn: list of headers of the columns used as key for the join operation
innerJoin(left: ivwdataframe.DataFrame, right: ivwdataframe.DataFrame, keyColumn: tuple[str, str] = ‘index’) -> ivwdataframe.DataFrame

Create a new DataFrame by using an outer left join of DataFrame left and DataFrame right. That is all rows of left are augmented with matching rows from right.

It is assumed that the entries in the key columns of right are unique. Otherwise results are undefined.

Args:

keyColumn: header of the column used as key for the join operation
(default: index column)

ivwdataframe.leftJoin(left: ivwdataframe.DataFrame, right: ivwdataframe.DataFrame, keyColumn: list[tuple[str, str]]) → ivwdataframe.DataFrame

Create a new DataFrame by using an outer left join of DataFrame left and DataFrame right. That is all rows of left are augmented with matching rows from right.

It is assumed that the entries in the key columns of right are unique. Otherwise results are undefined.

Parameters:: keyColumn – list of headers of the columns used as key for the join operation