brainspace.vtk_interface.wrappers.data_object.BSTable

class brainspace.vtk_interface.wrappers.data_object.BSTable(vtkobject=None, **kwargs)

Wrapper for vtkTable.

__init__(vtkobject=None, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

Methods

GetAttributes(type)	Returns the attributes specified by the type as a DataSetAttributes instance.
GetFieldData()	Returns the field data as a DataSetAttributes instance.
GetRowData()	Returns the row data as a DataSetAttributes instance.
__init__([vtkobject])	Initialize self.
getVTK(*args, **kwargs)	Invoke get methods on the vtk object.
setVTK(*args, **kwargs)	Invoke set methods on the vtk object.

Attributes

FieldData	This property returns the field data of a data object.
RowData	This property returns the row data of the table.
field_keys	Returns keys of field data.
n_field_data	Returns number of entries in field data.
vtk_map	Dictionary of vtk setter and getter methods.

FieldData

This property returns the field data of a data object.

GetAttributes(type)

Returns the attributes specified by the type as a DataSetAttributes instance.

GetFieldData()

Returns the field data as a DataSetAttributes instance.

GetRowData()

Returns the row data as a DataSetAttributes instance.

RowData

This property returns the row data of the table.

field_keys

Returns keys of field data.

Type:list of str

getVTK(*args, **kwargs)

Invoke get methods on the vtk object.

Parameters:

• args (list of str) – Method that require no arguments.
• kwargs (list of keyword-value arguments) – key-word arguments can be use for methods that require arguments. When several arguments are required, use a tuple. Methods that require no arguments can also be used here using None as the argument.

Returns:

results (dict) – Dictionary of results where the keys are the method names and the values the results.

Examples

>>> import vtk
>>> from brainspace.vtk_interface.wrappers import BSVTKObjectWrapper
>>> m1 = BSVTKObjectWrapper(vtk.vtkPolyDataMapper())
>>> m1.getVTK('arrayId', colorModeAsString=None)
{'arrayId': -1, 'colorModeAsString': 'Default'}
>>> m1.getVTK('colorModeAsString', arrayId=None)
{'colorModeAsString': 'Default', 'arrayId': -1}
>>> m1.getVTK(numberOfInputConnections=0)
{'numberOfInputConnections': 0}

n_field_data

Returns number of entries in field data.

Type:int

setVTK(*args, **kwargs)

Invoke set methods on the vtk object.

Parameters:

• args (list of str) – Setter methods that require no arguments.
• kwargs (list of keyword-value arguments) – key-word arguments can be use for methods that require arguments. When several arguments are required, use a tuple. Methods that require no arguments can also be used here using None as the argument.

Returns:

self (BSVTKObjectWrapper object) – Return self.

Examples

>>> import vtk
>>> from brainspace.vtk_interface.wrappers import BSVTKObjectWrapper
>>> m1 = BSVTKObjectWrapper(vtk.vtkPolyDataMapper())
>>> m1.setVTK(arrayId=3, colorMode='mapScalars')
<brainspace.vtk_interface.base.BSVTKObjectWrapper at 0x7f38a4ace320>
>>> m1.arrayId
3
>>> m1.colorModeAsString
'MapScalars'

vtk_map

Dictionary of vtk setter and getter methods.

Type:dict