Skip to main content
Base class for Pixeltable iterators. View source on GitHub

method close()

close() -> None
Close the iterator and release all resources

method create()

create(**kwargs: Any) -> tuple[type[ComponentIterator], dict[str, Any]]

method input_schema()

input_schema(
    *args: Any,
    **kwargs: Any
) -> dict[str, pixeltable.type_system.ColumnType]
Provide the Pixeltable types of the init() parameters The keys need to match the names of the init() parameters. This is equivalent to the parameters_types parameter of the @function decorator.

method output_schema()

output_schema(
    *args: Any,
    **kwargs: Any
) -> tuple[dict[str, pixeltable.type_system.ColumnType], list[str]]
Specify the dictionary returned by next() and a list of unstored column names Returns:
  • tuple[dict[str, pixeltable.type_system.ColumnType], list[str]]: a dictionary which is turned into a list of columns in the output table a list of unstored column names

method set_pos()

set_pos(pos: int) -> None
Set the iterator position to pos