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: ivwdataframe.Column

__init__(self: ivwdataframe.CategoricalColumn, arg0: str) None
__iter__(self: ivwdataframe.CategoricalColumn) Iterator
__repr__(self: ivwdataframe.CategoricalColumn) str
add(self: ivwdataframe.CategoricalColumn, arg0: str) None
append(*args, **kwargs)

Overloaded function.

  1. append(self: ivwdataframe.CategoricalColumn, arg0: ivwdataframe.CategoricalColumn) -> None

  2. 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.

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

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

property categories
class ivwdataframe.Column

Bases: pybind11_builtins.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_builtins.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__()

name(self: handle) -> str

Categorical = <ColumnType.Categorical: 2>
Index = <ColumnType.Index: 0>
Ordinal = <ColumnType.Ordinal: 1>
property name
property value
class ivwdataframe.DataFrame

Bases: pybind11_builtins.pybind11_object

__getitem__(self: ivwdataframe.DataFrame, arg0: int) ivwdataframe.Column
__init__(self: ivwdataframe.DataFrame, size: int = 0) None
__iter__(self: ivwdataframe.DataFrame) Iterator
__repr__(self: ivwdataframe.DataFrame) str
addCategoricalColumn(*args, **kwargs)

Overloaded function.

  1. addCategoricalColumn(self: ivwdataframe.DataFrame, header: str, size: int = 0) -> ivwdataframe.CategoricalColumn

  2. 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 = <inviwopy.data.Unit object at 0x000002D61D0D78B0>, range: Optional[inviwopy.glm.dvec2] = None) ivwdataframe.Column
addDoubleColumn(*args, **kwargs)

Overloaded function.

  1. addDoubleColumn(self: ivwdataframe.DataFrame, header: str, size: int = 0, unit: inviwopy.data.Unit = <inviwopy.data.Unit object at 0x000002D61F69C970>, range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.DoubleColumn

  2. addDoubleColumn(self: ivwdataframe.DataFrame, header: str, data: List[float], unit: inviwopy.data.Unit = <inviwopy.data.Unit object at 0x000002D61F667870>, range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.DoubleColumn

addFloatColumn(*args, **kwargs)

Overloaded function.

  1. addFloatColumn(self: ivwdataframe.DataFrame, header: str, size: int = 0, unit: inviwopy.data.Unit = <inviwopy.data.Unit object at 0x000002D61F45CFB0>, range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.FloatColumn

  2. addFloatColumn(self: ivwdataframe.DataFrame, header: str, data: List[float], unit: inviwopy.data.Unit = <inviwopy.data.Unit object at 0x000002D61F46AC70>, range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.FloatColumn

addInt64Column(*args, **kwargs)

Overloaded function.

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

  2. addInt64Column(self: ivwdataframe.DataFrame, header: str, data: List[int], unit: inviwopy.data.Unit = <inviwopy.data.Unit object at 0x000002D61F591A30>, range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.Int64Column

addIntColumn(*args, **kwargs)

Overloaded function.

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

  2. addIntColumn(self: ivwdataframe.DataFrame, header: str, data: List[int], unit: inviwopy.data.Unit = <inviwopy.data.Unit object at 0x000002D61F6676B0>, range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.IntColumn

addSize_tColumn(*args, **kwargs)

Overloaded function.

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

  2. addSize_tColumn(self: ivwdataframe.DataFrame, header: str, data: List[int], unit: inviwopy.data.Unit = <inviwopy.data.Unit object at 0x000002D61F64D2B0>, range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.Size_tColumn

addUIntColumn(*args, **kwargs)

Overloaded function.

  1. addUIntColumn(self: ivwdataframe.DataFrame, header: str, size: int = 0, unit: inviwopy.data.Unit = <inviwopy.data.Unit object at 0x000002D61F617770>, range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.UIntColumn

  2. addUIntColumn(self: ivwdataframe.DataFrame, header: str, data: List[int], unit: inviwopy.data.Unit = <inviwopy.data.Unit object at 0x000002D61F468BF0>, range: Optional[inviwopy.glm.dvec2] = None) -> ivwdataframe.UIntColumn

column(self: ivwdataframe.DataFrame, arg0: int) ivwdataframe.Column
indexcol(self: ivwdataframe.DataFrame) ivwdataframe.IndexColumn
updateIndex(self: ivwdataframe.DataFrame) None
property cols
property rows
class ivwdataframe.DataFrameFlatMultiInport

Bases: inviwopy.Inport

class ChangedAndDataGenerator

Bases: pybind11_builtins.pybind11_object

__init__(*args, **kwargs)
__next__(self: ivwdataframe.DataFrameFlatMultiInport.ChangedAndDataGenerator) Tuple[bool, ivwdataframe.DataFrame]
class DataGenerator

Bases: pybind11_builtins.pybind11_object

__init__(*args, **kwargs)
__next__(self: ivwdataframe.DataFrameFlatMultiInport.DataGenerator) ivwdataframe.DataFrame
class OutportAndDataGenerator

Bases: pybind11_builtins.pybind11_object

__init__(*args, **kwargs)
__next__(self: ivwdataframe.DataFrameFlatMultiInport.OutportAndDataGenerator) Tuple[inviwopy.Outport, ivwdataframe.DataFrame]
__init__(self: ivwdataframe.DataFrameFlatMultiInport, arg0: str) 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: inviwopy.Inport

class ChangedAndDataGenerator

Bases: pybind11_builtins.pybind11_object

__init__(*args, **kwargs)
__next__(self: ivwdataframe.DataFrameInport.ChangedAndDataGenerator) Tuple[bool, ivwdataframe.DataFrame]
class DataGenerator

Bases: pybind11_builtins.pybind11_object

__init__(*args, **kwargs)
__next__(self: ivwdataframe.DataFrameInport.DataGenerator) ivwdataframe.DataFrame
class OutportAndDataGenerator

Bases: pybind11_builtins.pybind11_object

__init__(*args, **kwargs)
__next__(self: ivwdataframe.DataFrameInport.OutportAndDataGenerator) Tuple[inviwopy.Outport, ivwdataframe.DataFrame]
__init__(self: ivwdataframe.DataFrameInport, arg0: str) 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: inviwopy.Inport

class ChangedAndDataGenerator

Bases: pybind11_builtins.pybind11_object

__init__(*args, **kwargs)
__next__(self: ivwdataframe.DataFrameMultiInport.ChangedAndDataGenerator) Tuple[bool, ivwdataframe.DataFrame]
class DataGenerator

Bases: pybind11_builtins.pybind11_object

__init__(*args, **kwargs)
__next__(self: ivwdataframe.DataFrameMultiInport.DataGenerator) ivwdataframe.DataFrame
class OutportAndDataGenerator

Bases: pybind11_builtins.pybind11_object

__init__(*args, **kwargs)
__next__(self: ivwdataframe.DataFrameMultiInport.OutportAndDataGenerator) Tuple[inviwopy.Outport, ivwdataframe.DataFrame]
__init__(self: ivwdataframe.DataFrameMultiInport, arg0: str) 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: inviwopy.Outport

__init__(self: ivwdataframe.DataFrameOutport, arg0: str) 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: ivwdataframe.Column

__init__(self: ivwdataframe.DoubleColumn, arg0: str) None
__iter__(self: ivwdataframe.DoubleColumn) Iterator
__repr__(self: ivwdataframe.DoubleColumn) str
add(*args, **kwargs)

Overloaded function.

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

  2. 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: ivwdataframe.Column

__init__(self: ivwdataframe.FloatColumn, arg0: str) None
__iter__(self: ivwdataframe.FloatColumn) Iterator
__repr__(self: ivwdataframe.FloatColumn) str
add(*args, **kwargs)

Overloaded function.

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

  2. 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: ivwdataframe.UIntColumn

__init__(self: ivwdataframe.IndexColumn, arg0: str) None
class ivwdataframe.Int64Column

Bases: ivwdataframe.Column

__init__(self: ivwdataframe.Int64Column, arg0: str) None
__iter__(self: ivwdataframe.Int64Column) Iterator
__repr__(self: ivwdataframe.Int64Column) str
add(*args, **kwargs)

Overloaded function.

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

  2. 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: ivwdataframe.Column

__init__(self: ivwdataframe.IntColumn, arg0: str) None
__iter__(self: ivwdataframe.IntColumn) Iterator
__repr__(self: ivwdataframe.IntColumn) str
add(*args, **kwargs)

Overloaded function.

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

  2. 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: ivwdataframe.Column

__init__(self: ivwdataframe.Size_tColumn, arg0: str) None
__iter__(self: ivwdataframe.Size_tColumn) Iterator
__repr__(self: ivwdataframe.Size_tColumn) str
add(*args, **kwargs)

Overloaded function.

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

  2. 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: ivwdataframe.Column

__init__(self: ivwdataframe.UIntColumn, arg0: str) None
__iter__(self: ivwdataframe.UIntColumn) Iterator
__repr__(self: ivwdataframe.UIntColumn) str
add(*args, **kwargs)

Overloaded function.

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

  2. 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.

  1. innerJoin(left: ivwdataframe.DataFrame, right: ivwdataframe.DataFrame, keyColumn: 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)

  2. innerJoin(left: ivwdataframe.DataFrame, right: ivwdataframe.DataFrame, keyColumn: List[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

  3. innerJoin(left: ivwdataframe.DataFrame, right: ivwdataframe.DataFrame, keyColumn: 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[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