VTK interface

Surface mesh functionality provided in BrainSpace is built on top of the Visualization Toolkit (VTK). BrainSpace provides several wrappers for most data objects and some filters in VTK. Here we present a subset of this functionality. Please also refer to VTK wrapping document for an introduction to the wrapping interface.

• Basic wrapping

• Pipeline functionality

• VTK wrappers

  • Data objects
  • Algorithms
  • Mappers
  • Actors
  • Lookup tables
  • Rendering
  • Properties
  • Miscellanea

• Decorators

Basic wrapping

wrap_vtk(obj, **kwargs)	Wrap input object to BSVTKObjectWrapper or one of its subclasses.
is_vtk(obj)	Check if obj is a vtk object.
is_wrapper(obj)	Check if obj is a wrapper.
BSVTKObjectWrapper(vtkobject, **kwargs)	Base class for all classes that wrap VTK objects.

Pipeline functionality

serial_connect(*filters[, as_data, update, port])	Connect filters serially.
get_output(ftr[, as_data, update, port])	Get output from filter.
to_data(ftr[, port])	Extract data from filter.
connect(ftr0, ftr1[, port0, port1, add_conn])	Connection of two filters.

VTK wrappers

Data objects

BSDataObject([vtkobject])	Wrapper for vtkDataObject.
BSTable([vtkobject])	Wrapper for vtkTable.
BSCompositeDataSet([vtkobject])	Wrapper for vtkCompositeDataSet.
BSDataSet([vtkobject])	Wrapper for vtkDataSet.
BSPointSet([vtkobject])	Wrapper for vtkPointSet.
BSPolyData([vtkobject])	Wrapper for vtkPolyData.
BSUnstructuredGrid([vtkobject])	Wrapper for vtkUnstructuredGrid.

Algorithms

BSAlgorithm([vtkobject])	Wrapper for vtkAlgorithm.
BSPolyDataAlgorithm([vtkobject])	Wrapper for vtkPolyDataAlgorithm.
BSWindowToImageFilter([vtkobject])	Wrapper for vtkWindowToImageFilter.
BSImageWriter([vtkobject])	Wrapper for vtkImageWriter.
BSBMPWriter([vtkobject])	Wrapper for vtkBMPWriter.
BSJPEGWriter([vtkobject])	Wrapper for vtkJPEGWriter.
BSPNGWriter([vtkobject])	Wrapper for vtkPNGWriter.
BSPostScriptWriter([vtkobject])	Wrapper for vtkPostScriptWriter.
BSTIFFWriter([vtkobject])	Wrapper for vtkTIFFWriter.

Mappers

BSDataSetMapper([vtkobject])	Wrapper for vtkDataSetMapper.
BSPolyDataMapper([vtkobject])	Wrapper for vtkPolyDataMapper.
BSLabeledContourMapper([vtkobject])	Wrapper for vtkLabeledContourMapper.
BSLabeledDataMapper([vtkobject])	Wrapper for vtkLabeledDataMapper.
BSLabelPlacementMapper([vtkobject])	Wrapper for vtkLabelPlacementMapper.
BSPolyDataMapper2D([vtkobject])	Wrapper for vtkPolyDataMapper2D.
BSTextMapper2D([vtkobject])	Wrapper for vtkPolyDataMapper2D.

Actors

BSActor2D([vtkobject])	Wrapper for vtkActor2D.
BSScalarBarActor([vtkobject])	Wrapper for vtkScalarBarActor.
BSTexturedActor2D([vtkobject])	Wrapper for vtkTexturedActor2D.
BSTextActor([vtkobject])	Wrapper for vtkTextActor.
BSActor([vtkobject])	Wrapper for vtkActor.

Lookup tables

BSScalarsToColors([vtkobject])	Wrapper for vtkScalarsToColors.
BSLookupTable([vtkobject])	Wrapper for vtkLookupTable.
BSLookupTableWithEnabling([vtkobject])	Wrapper for vtkLookupTableWithEnabling.
BSWindowLevelLookupTable([vtkobject])	Wrapper for vtkWindowLevelLookupTable.
BSColorTransferFunction([vtkobject])	Wrapper for vtkColorTransferFunction.
BSDiscretizableColorTransferFunction([vtkobject])	Wrapper for vtkDiscretizableColorTransferFunction.

Rendering

BSRenderer([vtkobject])	Wrapper for vtkRenderer.
BSRenderWindow([vtkobject])	Wrapper for vtkRenderWindow.
BSRenderWindowInteractor([vtkobject])	Wrapper for vtkRenderWindowInteractor.
BSGenericRenderWindowInteractor([vtkobject])	Wrapper for vtkGenericRenderWindowInteractor.
BSInteractorStyle([vtkobject])	Wrapper for vtkInteractorStyle.
BSInteractorStyleJoystickCamera([vtkobject])	Wrapper for vtkInteractorStyleJoystickCamera.
BSInteractorStyleJoystickActor([vtkobject])	Wrapper for vtkInteractorStyleJoystickActor.
BSInteractorStyleTerrain([vtkobject])	Wrapper for vtkInteractorStyleTerrain.
BSInteractorStyleRubberBandZoom([vtkobject])	Wrapper for vtkInteractorStyleRubberBandZoom.
BSInteractorStyleTrackballActor([vtkobject])	Wrapper for vtkInteractorStyleTrackballActor.
BSInteractorStyleTrackballCamera([vtkobject])	Wrapper for vtkInteractorStyleTrackballCamera.
BSInteractorStyleImage([vtkobject])	Wrapper for vtkInteractorStyleImage.
BSInteractorStyleRubberBandPick([vtkobject])	Wrapper for vtkInteractorStyleRubberBandPick.
BSInteractorStyleSwitchBase([vtkobject])	Wrapper for vtkInteractorStyleSwitchBase.
BSInteractorStyleSwitch([vtkobject])	Wrapper for vtkInteractorStyleSwitch.
BSCamera([vtkobject])	Wrapper for vtkCamera.

Properties

BSProperty([vtkobject])	Wrapper for vtkProperty.
BSProperty2D([vtkobject])	Wrapper for vtkProperty2D.
BSTextProperty([vtkobject])	Wrapper for vtkTextProperty.

Miscellanea

BSCellArray([vtkobject])	Wrapper for vtkCellArray.
BSGL2PSExporter([vtkobject])	Wrapper for vtkGL2PSExporter.
BSCollection([vtkobject])	Wrapper for vtkCollection.
BSPropCollection([vtkobject])	Wrapper for vtkPropCollection.
BSActor2DCollection([vtkobject])	Wrapper for vtkActor2DCollection.
BSActorCollection([vtkobject])	Wrapper for vtkActorCollection.
BSProp3DCollection([vtkobject])	Wrapper for vtkProp3DCollection.
BSMapperCollection([vtkobject])	Wrapper for vtkMapperCollection.
BSRendererCollection([vtkobject])	Wrapper for vtkRendererCollection.
BSPolyDataCollection([vtkobject])	Wrapper for vtkPolyDataCollection.
BSTextPropertyCollection([vtkobject])	Wrapper for vtkTextPropertyCollection.
BSCoordinate([vtkobject])	Wrapper for vtkCoordinate.

Decorators

wrap_input(*xargs[, skip])	Decorator to wrap the arguments of a function.
wrap_output(func)	Decorator to wrap output of function.
unwrap_input(*xargs[, vtype, skip])	Decorator to unwrap input arguments of function.
unwrap_output([vtype])	Decorator to wrap both arguments and output of a function.
append_vtk([to])	Decorator to append data to surface.