Class DataSetMapper

Known Subclasses:

Class that defines a data set mapper.

Instance Methods

[hide private]

__init__(self)
Initialise the data set mapper.

__setInput(self)
Set the input for the data set mapper.

__setLookupTable(self, lookup_table)
Set the lookup table for the data set mapper.

vtkDataSetMapper

_getDataSetMapper(self)
Return the data set mapper.

vtkScalarsToColors

_getDataSetMapperLookupTable(self)
Return the data set mapper's lookup table.

Two column tuple containing numbers

_getDataSetMapperRange(self)
Return the mapper's scalar range.

Boolean

_isScalarRangeSet(self)
Return whether the data set mapper's scalar range has been specified by the user.

_setScalarRange(self, range)
Set the minimum and maximum scalar range for the data set mapper.

_setScalarVisibilityOn(self)
Scalar data is used to color the rendered object.

_setupDataSetMapper(self, object, lookup_table=None)
Setup the data set mapper.

setScalarRange(self, lower_range, upper_range)
Set the minimum and maximium scalar range for the data set mapper.

Method Details

[hide private]

__setLookupTable(self, lookup_table)

Set the lookup table for the data set mapper.

Parameters:

lookup_table (vtkLookupTable) - Map scalar values to colors

_getDataSetMapper(self)

Return the data set mapper.

Returns: vtkDataSetMapper: Data set mapper

_getDataSetMapperLookupTable(self)

Return the data set mapper's lookup table.

Returns: vtkScalarsToColors: Converts scalar data to colors

_getDataSetMapperRange(self)

Return the mapper's scalar range.

Returns: Two column tuple containing numbers: Minimum and maximum range of the data set mapper's scalar range

_isScalarRangeSet(self)

Return whether the data set mapper's scalar range has been specified by the user.

Returns: Boolean: True or False

_setScalarRange(self, range)

Set the minimum and maximum scalar range for the data set mapper. This method is called when the range has NOT been specified by the user. Therefore, the scalar range read from the source will be used instead.

Parameters:

range (Two column tuple containing numbers) - Minimum and maximum data set mapper scalar range

_setupDataSetMapper(self, object, lookup_table=None)

Setup the data set mapper.

Parameters:

object (vtkDataSet (i.e. vtkUnstructuredGrid, vtkPolyData, etc)) - Data source map
lookup_table (vtkLookupTable) - Maps scalar values to colors

setScalarRange(self, lower_range, upper_range)

Set the minimum and maximium scalar range for the data set mapper. This method is called when the range has been specified by the user. Therefore, the scalar range read from the source will be ignored.

Parameters:

lower_range (Lower range of scalar value) - Number
upper_range (Upper range of scalar value) - Number