vtkVolumeMapper Class Reference

Abstract class for a volume mapper. More...

#include <vtkVolumeMapper.h>

Inheritance diagram for vtkVolumeMapper:

Collaboration diagram for vtkVolumeMapper:

Public Types
enum	BlendModes {   COMPOSITE_BLEND , MAXIMUM_INTENSITY_BLEND , MINIMUM_INTENSITY_BLEND , AVERAGE_INTENSITY_BLEND ,   ADDITIVE_BLEND , ISOSURFACE_BLEND , SLICE_BLEND }
	Blend modes. More...
typedef vtkAbstractVolumeMapper	Superclass
Public Types inherited from vtkAbstractVolumeMapper
typedef vtkAbstractMapper3D	Superclass
Public Types inherited from vtkAbstractMapper3D
typedef vtkAbstractMapper	Superclass
Public Types inherited from vtkAbstractMapper
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkVolumeMapper *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Render (vtkRenderer *ren, vtkVolume *vol) override=0
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Render the volume.
void	ReleaseGraphicsResources (vtkWindow *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this mapper.
virtual void	SetInputData (vtkImageData *)
	Set/Get the input data.
virtual void	SetInputData (vtkDataSet *)
	Set/Get the input data.
virtual void	SetInputData (vtkRectilinearGrid *)
	Set/Get the input data.
virtual vtkDataSet *	GetInput ()
	Set/Get the input data.
virtual vtkDataSet *	GetInput (const int port)
	Set/Get the input data.
virtual void	SetBlendMode (int)
	Set/Get the blend mode.
void	SetBlendModeToComposite ()
	Set/Get the blend mode.
void	SetBlendModeToMaximumIntensity ()
	Set/Get the blend mode.
void	SetBlendModeToMinimumIntensity ()
	Set/Get the blend mode.
void	SetBlendModeToAverageIntensity ()
	Set/Get the blend mode.
void	SetBlendModeToAdditive ()
	Set/Get the blend mode.
void	SetBlendModeToIsoSurface ()
	Set/Get the blend mode.
void	SetBlendModeToSlice ()
	Set/Get the blend mode.
virtual int	GetBlendMode ()
	Set/Get the blend mode.
virtual void	SetAverageIPScalarRange (double, double)
	Set/Get the scalar range to be considered for average intensity projection blend mode.
void	SetAverageIPScalarRange (double[2])
	Set/Get the scalar range to be considered for average intensity projection blend mode.
virtual double *	GetAverageIPScalarRange ()
	Set/Get the scalar range to be considered for average intensity projection blend mode.
virtual void	GetAverageIPScalarRange (double data[2])
	Set/Get the scalar range to be considered for average intensity projection blend mode.
virtual void	SetCropping (vtkTypeBool)
	Turn On/Off orthogonal cropping.
virtual vtkTypeBool	GetCropping ()
	Turn On/Off orthogonal cropping.
virtual void	CroppingOn ()
	Turn On/Off orthogonal cropping.
virtual void	CroppingOff ()
	Turn On/Off orthogonal cropping.
virtual void	SetCroppingRegionPlanes (double, double, double, double, double, double)
	Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.
virtual void	SetCroppingRegionPlanes (double[6])
	Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.
virtual double *	GetCroppingRegionPlanes ()
	Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.
virtual void	GetCroppingRegionPlanes (double data[6])
	Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.
virtual double *	GetVoxelCroppingRegionPlanes ()
	Get the cropping region planes in voxels.
virtual void	GetVoxelCroppingRegionPlanes (double data[6])
	Get the cropping region planes in voxels.
virtual void	SetCroppingRegionFlags (int)
	Set the flags for the cropping regions.
virtual int	GetCroppingRegionFlags ()
	Set the flags for the cropping regions.
void	SetCroppingRegionFlagsToSubVolume ()
	Set the flags for the cropping regions.
void	SetCroppingRegionFlagsToFence ()
	Set the flags for the cropping regions.
void	SetCroppingRegionFlagsToInvertedFence ()
	Set the flags for the cropping regions.
void	SetCroppingRegionFlagsToCross ()
	Set the flags for the cropping regions.
void	SetCroppingRegionFlagsToInvertedCross ()
	Set the flags for the cropping regions.
Public Member Functions inherited from vtkAbstractVolumeMapper
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkAbstractVolumeMapper *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual char *	GetArrayName ()
	Get the array name or number and component to use for rendering.
virtual int	GetArrayId ()
virtual int	GetArrayAccessMode ()
const char *	GetScalarModeAsString ()
	Return the method for obtaining scalar data.
virtual void	Render (vtkRenderer *ren, vtkVolume *vol)=0
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Render the volume.
void	ReleaseGraphicsResources (vtkWindow *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this mapper.
virtual vtkDataSet *	GetDataSetInput ()
	Set/Get the input data.
virtual vtkDataObject *	GetDataObjectInput ()
	Set/Get the input data.
double *	GetBounds () override
	Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).
void	GetBounds (double bounds[6]) override
	Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).
virtual void	SetScalarMode (int)
	Control how the mapper works with scalar point data and cell attribute data.
virtual int	GetScalarMode ()
	Control how the mapper works with scalar point data and cell attribute data.
virtual void	SetArrayAccessMode (int)
	Control how the mapper works with scalar point data and cell attribute data.
void	SetScalarModeToDefault ()
	Control how the mapper works with scalar point data and cell attribute data.
void	SetScalarModeToUsePointData ()
	Control how the mapper works with scalar point data and cell attribute data.
void	SetScalarModeToUseCellData ()
	Control how the mapper works with scalar point data and cell attribute data.
void	SetScalarModeToUsePointFieldData ()
	Control how the mapper works with scalar point data and cell attribute data.
void	SetScalarModeToUseCellFieldData ()
	Control how the mapper works with scalar point data and cell attribute data.
virtual void	SelectScalarArray (int arrayNum)
	When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which scalar array to use during rendering.
virtual void	SelectScalarArray (const char *arrayName)
	When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which scalar array to use during rendering.
virtual float	GetGradientMagnitudeScale ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE.
virtual float	GetGradientMagnitudeBias ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE.
virtual float	GetGradientMagnitudeScale (int)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE.
virtual float	GetGradientMagnitudeBias (int)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE.
Public Member Functions inherited from vtkAbstractMapper3D
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkAbstractMapper3D *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual double *	GetBounds ()=0
	Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).
virtual void	GetBounds (double bounds[6])
	Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
double	GetLength ()
	Return the diagonal length of this mappers bounding box.
virtual vtkTypeBool	IsARayCastMapper ()
	Is this a ray cast mapper? A subclass would return 1 if the ray caster is needed to generate an image from this mapper.
virtual vtkTypeBool	IsARenderIntoImageMapper ()
	Is this a "render into image" mapper? A subclass would return 1 if the mapper produces an image by rendering into a software image buffer.
void	GetClippingPlaneInDataCoords (vtkMatrix4x4 *propMatrix, int i, double planeEquation[4])
	Get the ith clipping plane as a homogeneous plane equation.
double *	GetCenter ()
	Return the Center of this mapper's data.
void	GetCenter (double center[3])
	Return the Center of this mapper's data.
Public Member Functions inherited from vtkAbstractMapper
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkAbstractMapper *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkMTimeType	GetMTime () override
	Override Modifiedtime as we have added Clipping planes.
virtual void	ReleaseGraphicsResources (vtkWindow *)
	Release any graphics resources that are being consumed by this mapper.
void	SetClippingPlanes (vtkPlanes *planes)
	An alternative way to set clipping planes: use up to six planes found in the supplied instance of the implicit function vtkPlanes.
virtual void	ShallowCopy (vtkAbstractMapper *m)
	Make a shallow copy of this mapper.
int	GetNumberOfClippingPlanes ()
	Get the number of clipping planes.
virtual double	GetTimeToDraw ()
	Get the time required to draw the geometry last time it was rendered.
void	AddClippingPlane (vtkPlane *plane)
	Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified).
void	RemoveClippingPlane (vtkPlane *plane)
	Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified).
void	RemoveAllClippingPlanes ()
	Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified).
virtual void	SetClippingPlanes (vtkPlaneCollection *)
	Get/Set the vtkPlaneCollection which specifies the clipping planes.
virtual vtkPlaneCollection *	GetClippingPlanes ()
	Get/Set the vtkPlaneCollection which specifies the clipping planes.
Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
int	HasExecutive ()
	Check whether this algorithm has an assigned executive.
vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.
virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.
virtual vtkTypeBool	ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
vtkTypeBool	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.
virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.
vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.
vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.
int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.
int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.
void	SetProgress (double)
	SetProgress is deprecated.
void	UpdateProgress (double amount)
	Update the progress of the process object.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
	String based versions of SetInputArrayToProcess().
vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.
void	RemoveAllInputs ()
	Remove all the input data.
vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.
vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.
virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.
virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.
virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.
vtkAlgorithmOutput *	GetOutputPort ()
int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.
int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).
vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.
vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)
vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.
vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)
vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.
virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).
virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date.
virtual void	UpdateDataObject ()
	Create output object(s).
virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.
virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.
virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.
void	Register (vtkObjectBase *o) override
	Participate in garbage collection.
void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection.
virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.
virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.
virtual double	GetProgress ()
	Get the execution progress of a process object.
void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.
virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.
virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date.
virtual void	Update ()
	Bring this algorithm's outputs up-to-date.
virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports.
virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.
int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.
int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.
void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkVolumeMapper *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAbstractVolumeMapper
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAbstractVolumeMapper *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAbstractMapper3D
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAbstractMapper3D *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAbstractMapper
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAbstractMapper *	SafeDownCast (vtkObjectBase *o)
static vtkDataArray *	GetScalars (vtkDataSet *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int &cellFlag)
	Internal helper function for getting the active scalars.
static vtkAbstractArray *	GetAbstractScalars (vtkDataSet *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int &cellFlag)
	Internal helper function for getting the active scalars as an abstract array.
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkVolumeMapper ()
	~vtkVolumeMapper () override
double	SpacingAdjustedSampleDistance (double inputSpacing[3], int inputExtent[6])
	Compute a sample distance from the data spacing.
int	FillInputPortInformation (int, vtkInformation *) override
	Fill the input port information objects for this algorithm.
Protected Member Functions inherited from vtkAbstractVolumeMapper
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAbstractVolumeMapper ()
	~vtkAbstractVolumeMapper () override
int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.
Protected Member Functions inherited from vtkAbstractMapper3D
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAbstractMapper3D ()
	~vtkAbstractMapper3D () override=default
Protected Member Functions inherited from vtkAbstractMapper
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAbstractMapper ()
	~vtkAbstractMapper () override
Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAlgorithm ()
	~vtkAlgorithm () override
virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.
virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.
virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.
void	ReportReferences (vtkGarbageCollector *) override
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.
virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.
void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.
void	AddInputDataInternal (int port, vtkDataObject *input)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
int	BlendMode
double	AverageIPScalarRange [2]
	Threshold range for average intensity projection.
Protected Attributes inherited from vtkAbstractVolumeMapper
int	ScalarMode
char *	ArrayName
int	ArrayId
int	ArrayAccessMode
Protected Attributes inherited from vtkAbstractMapper3D
double	Bounds [6]
double	Center [3]
Protected Attributes inherited from vtkAbstractMapper
vtkTimerLog *	Timer
double	TimeToDraw
vtkWindow *	LastWindow
vtkPlaneCollection *	ClippingPlanes
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers
vtkTypeBool	Cropping
	Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates.
double	CroppingRegionPlanes [6]
	Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates.
double	VoxelCroppingRegionPlanes [6]
	Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates.
int	CroppingRegionFlags
	Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates.
void	ConvertCroppingRegionPlanesToVoxels ()
	Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates.

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Abstract class for a volume mapper.

vtkVolumeMapper is the abstract definition of a volume mapper for regular rectilinear data (vtkImageData). Several basic types of volume mappers are supported.

Definition at line 44 of file vtkVolumeMapper.h.

Member Typedef Documentation

Superclass

typedef vtkAbstractVolumeMapper vtkVolumeMapper::Superclass

Definition at line 47 of file vtkVolumeMapper.h.

Member Enumeration Documentation

BlendModes

enum vtkVolumeMapper::BlendModes

Blend modes.

The default mode is Composite where the scalar values are sampled through the volume and composited in a front-to-back scheme through alpha blending. The final color and opacity is determined using the color and opacity transfer functions.

Maximum and minimum intensity blend modes use the maximum and minimum scalar values, respectively, along the sampling ray. The final color and opacity is determined by passing the resultant value through the color and opacity transfer functions.

Additive blend mode accumulates scalar values by passing each value through the opacity transfer function and then adding up the product of the value and its opacity. In other words, the scalar values are scaled using the opacity transfer function and summed to derive the final color. Note that the resulting image is always grayscale i.e. aggregated values are not passed through the color transfer function. This is because the final value is a derived value and not a real data value along the sampling ray.

Average intensity blend mode works similar to the additive blend mode where the scalar values are multiplied by opacity calculated from the opacity transfer function and then added. The additional step here is to divide the sum by the number of samples taken through the volume. One can control the scalar range by setting the AverageIPScalarRange ivar to disregard scalar values, not in the range of interest, from the average computation. As is the case with the additive intensity projection, the final image will always be grayscale i.e. the aggregated values are not passed through the color transfer function. This is because the resultant value is a derived value and not a real data value along the sampling ray.

IsoSurface blend mode uses contour values defined by the user in order to display scalar values only when the ray crosses the contour. It supports opacity the same way composite blend mode does.

Note

vtkVolumeMapper::AVERAGE_INTENSITY_BLEND and ISOSURFACE_BLEND are only supported by the vtkGPUVolumeRayCastMapper with the OpenGL2 backend.

See also

SetAverageIPScalarRange()

GetIsoSurfaceValues()

Enumerator
COMPOSITE_BLEND
MAXIMUM_INTENSITY_BLEND
MINIMUM_INTENSITY_BLEND
AVERAGE_INTENSITY_BLEND
ADDITIVE_BLEND
ISOSURFACE_BLEND
SLICE_BLEND

Definition at line 249 of file vtkVolumeMapper.h.

Constructor & Destructor Documentation

vtkVolumeMapper()

vtkVolumeMapper::vtkVolumeMapper ( )

protected

~vtkVolumeMapper()

vtkVolumeMapper::~vtkVolumeMapper ( )

overrideprotected

Member Function Documentation

IsTypeOf()

static vtkTypeBool vtkVolumeMapper::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkVolumeMapper::IsA ( const char *  name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkAbstractVolumeMapper.

Reimplemented in vtkOSPRayVolumeMapper, vtkFixedPointVolumeRayCastMapper, vtkGPUVolumeRayCastMapper, vtkOSPRayVolumeInterface, vtkAMRVolumeMapper, vtkMultiBlockVolumeMapper, vtkOpenGLGPUVolumeRayCastMapper, and vtkSmartVolumeMapper.

SafeDownCast()

static vtkVolumeMapper * vtkVolumeMapper::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkVolumeMapper::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAbstractVolumeMapper.

Reimplemented in vtkOSPRayVolumeMapper, vtkFixedPointVolumeRayCastMapper, vtkGPUVolumeRayCastMapper, vtkOSPRayVolumeInterface, vtkAMRVolumeMapper, vtkMultiBlockVolumeMapper, vtkOpenGLGPUVolumeRayCastMapper, and vtkSmartVolumeMapper.

NewInstance()

vtkVolumeMapper * vtkVolumeMapper::NewInstance

(

)

const

PrintSelf()

void vtkVolumeMapper::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkAbstractVolumeMapper.

Reimplemented in vtkAMRVolumeMapper, vtkMultiBlockVolumeMapper, vtkOpenGLGPUVolumeRayCastMapper, and vtkSmartVolumeMapper.

SetInputData() [1/3]

virtual void vtkVolumeMapper::SetInputData ( vtkImageData *  )

virtual

Set/Get the input data.

Reimplemented in vtkAMRVolumeMapper.

SetInputData() [2/3]

virtual void vtkVolumeMapper::SetInputData ( vtkDataSet *  )

virtual

Set/Get the input data.

Reimplemented in vtkAMRVolumeMapper.

SetInputData() [3/3]

virtual void vtkVolumeMapper::SetInputData ( vtkRectilinearGrid *  )

virtual

Set/Get the input data.

Reimplemented in vtkAMRVolumeMapper.

GetInput() [1/2]

virtual vtkDataSet * vtkVolumeMapper::GetInput ( )

virtual

Set/Get the input data.

Reimplemented in vtkGPUVolumeRayCastMapper.

GetInput() [2/2]

virtual vtkDataSet * vtkVolumeMapper::GetInput ( const int  port )

virtual

Set/Get the input data.

Reimplemented in vtkGPUVolumeRayCastMapper.

SetBlendMode()

virtual void vtkVolumeMapper::SetBlendMode ( int  )

virtual

Set/Get the blend mode.

The default mode is Composite where the scalar values are sampled through the volume and composited in a front-to-back scheme through alpha blending. The final color and opacity is determined using the color and opacity transfer functions.

Maximum and minimum intensity blend modes use the maximum and minimum scalar values, respectively, along the sampling ray. The final color and opacity is determined by passing the resultant value through the color and opacity transfer functions.

Additive blend mode accumulates scalar values by passing each value through the opacity transfer function and then adding up the product of the value and its opacity. In other words, the scalar values are scaled using the opacity transfer function and summed to derive the final color. Note that the resulting image is always grayscale i.e. aggregated values are not passed through the color transfer function. This is because the final value is a derived value and not a real data value along the sampling ray.

Average intensity blend mode works similar to the additive blend mode where the scalar values are multiplied by opacity calculated from the opacity transfer function and then added. The additional step here is to divide the sum by the number of samples taken through the volume. One can control the scalar range by setting the AverageIPScalarRange ivar to disregard scalar values, not in the range of interest, from the average computation. As is the case with the additive intensity projection, the final image will always be grayscale i.e. the aggregated values are not passed through the color transfer function. This is because the resultant value is a derived value and not a real data value along the sampling ray.

IsoSurface blend mode uses contour values defined by the user in order to display scalar values only when the ray crosses the contour. It supports opacity the same way composite blend mode does.

Note

vtkVolumeMapper::AVERAGE_INTENSITY_BLEND and ISOSURFACE_BLEND are only supported by the vtkGPUVolumeRayCastMapper with the OpenGL2 backend.

See also

SetAverageIPScalarRange()

GetIsosurfaceValues()

Reimplemented in vtkAMRVolumeMapper, and vtkMultiBlockVolumeMapper.

SetBlendModeToComposite()

void vtkVolumeMapper::SetBlendModeToComposite ( )

inline

Set/Get the blend mode.

The default mode is Composite where the scalar values are sampled through the volume and composited in a front-to-back scheme through alpha blending. The final color and opacity is determined using the color and opacity transfer functions.

Maximum and minimum intensity blend modes use the maximum and minimum scalar values, respectively, along the sampling ray. The final color and opacity is determined by passing the resultant value through the color and opacity transfer functions.

Additive blend mode accumulates scalar values by passing each value through the opacity transfer function and then adding up the product of the value and its opacity. In other words, the scalar values are scaled using the opacity transfer function and summed to derive the final color. Note that the resulting image is always grayscale i.e. aggregated values are not passed through the color transfer function. This is because the final value is a derived value and not a real data value along the sampling ray.

Average intensity blend mode works similar to the additive blend mode where the scalar values are multiplied by opacity calculated from the opacity transfer function and then added. The additional step here is to divide the sum by the number of samples taken through the volume. One can control the scalar range by setting the AverageIPScalarRange ivar to disregard scalar values, not in the range of interest, from the average computation. As is the case with the additive intensity projection, the final image will always be grayscale i.e. the aggregated values are not passed through the color transfer function. This is because the resultant value is a derived value and not a real data value along the sampling ray.

IsoSurface blend mode uses contour values defined by the user in order to display scalar values only when the ray crosses the contour. It supports opacity the same way composite blend mode does.

Note

vtkVolumeMapper::AVERAGE_INTENSITY_BLEND and ISOSURFACE_BLEND are only supported by the vtkGPUVolumeRayCastMapper with the OpenGL2 backend.

See also

SetAverageIPScalarRange()

GetIsosurfaceValues()

Definition at line 105 of file vtkVolumeMapper.h.

SetBlendModeToMaximumIntensity()

void vtkVolumeMapper::SetBlendModeToMaximumIntensity ( )

inline

Set/Get the blend mode.

The default mode is Composite where the scalar values are sampled through the volume and composited in a front-to-back scheme through alpha blending. The final color and opacity is determined using the color and opacity transfer functions.

Maximum and minimum intensity blend modes use the maximum and minimum scalar values, respectively, along the sampling ray. The final color and opacity is determined by passing the resultant value through the color and opacity transfer functions.

Additive blend mode accumulates scalar values by passing each value through the opacity transfer function and then adding up the product of the value and its opacity. In other words, the scalar values are scaled using the opacity transfer function and summed to derive the final color. Note that the resulting image is always grayscale i.e. aggregated values are not passed through the color transfer function. This is because the final value is a derived value and not a real data value along the sampling ray.

Average intensity blend mode works similar to the additive blend mode where the scalar values are multiplied by opacity calculated from the opacity transfer function and then added. The additional step here is to divide the sum by the number of samples taken through the volume. One can control the scalar range by setting the AverageIPScalarRange ivar to disregard scalar values, not in the range of interest, from the average computation. As is the case with the additive intensity projection, the final image will always be grayscale i.e. the aggregated values are not passed through the color transfer function. This is because the resultant value is a derived value and not a real data value along the sampling ray.

IsoSurface blend mode uses contour values defined by the user in order to display scalar values only when the ray crosses the contour. It supports opacity the same way composite blend mode does.

Note

vtkVolumeMapper::AVERAGE_INTENSITY_BLEND and ISOSURFACE_BLEND are only supported by the vtkGPUVolumeRayCastMapper with the OpenGL2 backend.

See also

SetAverageIPScalarRange()

GetIsosurfaceValues()

Definition at line 106 of file vtkVolumeMapper.h.

SetBlendModeToMinimumIntensity()

void vtkVolumeMapper::SetBlendModeToMinimumIntensity ( )

inline

Set/Get the blend mode.

The default mode is Composite where the scalar values are sampled through the volume and composited in a front-to-back scheme through alpha blending. The final color and opacity is determined using the color and opacity transfer functions.

Maximum and minimum intensity blend modes use the maximum and minimum scalar values, respectively, along the sampling ray. The final color and opacity is determined by passing the resultant value through the color and opacity transfer functions.

Additive blend mode accumulates scalar values by passing each value through the opacity transfer function and then adding up the product of the value and its opacity. In other words, the scalar values are scaled using the opacity transfer function and summed to derive the final color. Note that the resulting image is always grayscale i.e. aggregated values are not passed through the color transfer function. This is because the final value is a derived value and not a real data value along the sampling ray.

Average intensity blend mode works similar to the additive blend mode where the scalar values are multiplied by opacity calculated from the opacity transfer function and then added. The additional step here is to divide the sum by the number of samples taken through the volume. One can control the scalar range by setting the AverageIPScalarRange ivar to disregard scalar values, not in the range of interest, from the average computation. As is the case with the additive intensity projection, the final image will always be grayscale i.e. the aggregated values are not passed through the color transfer function. This is because the resultant value is a derived value and not a real data value along the sampling ray.

IsoSurface blend mode uses contour values defined by the user in order to display scalar values only when the ray crosses the contour. It supports opacity the same way composite blend mode does.

Note

vtkVolumeMapper::AVERAGE_INTENSITY_BLEND and ISOSURFACE_BLEND are only supported by the vtkGPUVolumeRayCastMapper with the OpenGL2 backend.

See also

SetAverageIPScalarRange()

GetIsosurfaceValues()

Definition at line 110 of file vtkVolumeMapper.h.

SetBlendModeToAverageIntensity()

void vtkVolumeMapper::SetBlendModeToAverageIntensity ( )

inline

Set/Get the blend mode.

The default mode is Composite where the scalar values are sampled through the volume and composited in a front-to-back scheme through alpha blending. The final color and opacity is determined using the color and opacity transfer functions.

Maximum and minimum intensity blend modes use the maximum and minimum scalar values, respectively, along the sampling ray. The final color and opacity is determined by passing the resultant value through the color and opacity transfer functions.

Additive blend mode accumulates scalar values by passing each value through the opacity transfer function and then adding up the product of the value and its opacity. In other words, the scalar values are scaled using the opacity transfer function and summed to derive the final color. Note that the resulting image is always grayscale i.e. aggregated values are not passed through the color transfer function. This is because the final value is a derived value and not a real data value along the sampling ray.

Average intensity blend mode works similar to the additive blend mode where the scalar values are multiplied by opacity calculated from the opacity transfer function and then added. The additional step here is to divide the sum by the number of samples taken through the volume. One can control the scalar range by setting the AverageIPScalarRange ivar to disregard scalar values, not in the range of interest, from the average computation. As is the case with the additive intensity projection, the final image will always be grayscale i.e. the aggregated values are not passed through the color transfer function. This is because the resultant value is a derived value and not a real data value along the sampling ray.

IsoSurface blend mode uses contour values defined by the user in order to display scalar values only when the ray crosses the contour. It supports opacity the same way composite blend mode does.

Note

vtkVolumeMapper::AVERAGE_INTENSITY_BLEND and ISOSURFACE_BLEND are only supported by the vtkGPUVolumeRayCastMapper with the OpenGL2 backend.

See also

SetAverageIPScalarRange()

GetIsosurfaceValues()

Definition at line 114 of file vtkVolumeMapper.h.

SetBlendModeToAdditive()

void vtkVolumeMapper::SetBlendModeToAdditive ( )

inline

Set/Get the blend mode.

The default mode is Composite where the scalar values are sampled through the volume and composited in a front-to-back scheme through alpha blending. The final color and opacity is determined using the color and opacity transfer functions.

Maximum and minimum intensity blend modes use the maximum and minimum scalar values, respectively, along the sampling ray. The final color and opacity is determined by passing the resultant value through the color and opacity transfer functions.

Additive blend mode accumulates scalar values by passing each value through the opacity transfer function and then adding up the product of the value and its opacity. In other words, the scalar values are scaled using the opacity transfer function and summed to derive the final color. Note that the resulting image is always grayscale i.e. aggregated values are not passed through the color transfer function. This is because the final value is a derived value and not a real data value along the sampling ray.

Average intensity blend mode works similar to the additive blend mode where the scalar values are multiplied by opacity calculated from the opacity transfer function and then added. The additional step here is to divide the sum by the number of samples taken through the volume. One can control the scalar range by setting the AverageIPScalarRange ivar to disregard scalar values, not in the range of interest, from the average computation. As is the case with the additive intensity projection, the final image will always be grayscale i.e. the aggregated values are not passed through the color transfer function. This is because the resultant value is a derived value and not a real data value along the sampling ray.

IsoSurface blend mode uses contour values defined by the user in order to display scalar values only when the ray crosses the contour. It supports opacity the same way composite blend mode does.

Note

vtkVolumeMapper::AVERAGE_INTENSITY_BLEND and ISOSURFACE_BLEND are only supported by the vtkGPUVolumeRayCastMapper with the OpenGL2 backend.

See also

SetAverageIPScalarRange()

GetIsosurfaceValues()

Definition at line 118 of file vtkVolumeMapper.h.

SetBlendModeToIsoSurface()

void vtkVolumeMapper::SetBlendModeToIsoSurface ( )

inline

Set/Get the blend mode.

The default mode is Composite where the scalar values are sampled through the volume and composited in a front-to-back scheme through alpha blending. The final color and opacity is determined using the color and opacity transfer functions.

Maximum and minimum intensity blend modes use the maximum and minimum scalar values, respectively, along the sampling ray. The final color and opacity is determined by passing the resultant value through the color and opacity transfer functions.

Additive blend mode accumulates scalar values by passing each value through the opacity transfer function and then adding up the product of the value and its opacity. In other words, the scalar values are scaled using the opacity transfer function and summed to derive the final color. Note that the resulting image is always grayscale i.e. aggregated values are not passed through the color transfer function. This is because the final value is a derived value and not a real data value along the sampling ray.

Average intensity blend mode works similar to the additive blend mode where the scalar values are multiplied by opacity calculated from the opacity transfer function and then added. The additional step here is to divide the sum by the number of samples taken through the volume. One can control the scalar range by setting the AverageIPScalarRange ivar to disregard scalar values, not in the range of interest, from the average computation. As is the case with the additive intensity projection, the final image will always be grayscale i.e. the aggregated values are not passed through the color transfer function. This is because the resultant value is a derived value and not a real data value along the sampling ray.

IsoSurface blend mode uses contour values defined by the user in order to display scalar values only when the ray crosses the contour. It supports opacity the same way composite blend mode does.

Note

vtkVolumeMapper::AVERAGE_INTENSITY_BLEND and ISOSURFACE_BLEND are only supported by the vtkGPUVolumeRayCastMapper with the OpenGL2 backend.

See also

SetAverageIPScalarRange()

GetIsosurfaceValues()

Definition at line 119 of file vtkVolumeMapper.h.

SetBlendModeToSlice()

void vtkVolumeMapper::SetBlendModeToSlice ( )

inline

Set/Get the blend mode.

The default mode is Composite where the scalar values are sampled through the volume and composited in a front-to-back scheme through alpha blending. The final color and opacity is determined using the color and opacity transfer functions.

Maximum and minimum intensity blend modes use the maximum and minimum scalar values, respectively, along the sampling ray. The final color and opacity is determined by passing the resultant value through the color and opacity transfer functions.

Additive blend mode accumulates scalar values by passing each value through the opacity transfer function and then adding up the product of the value and its opacity. In other words, the scalar values are scaled using the opacity transfer function and summed to derive the final color. Note that the resulting image is always grayscale i.e. aggregated values are not passed through the color transfer function. This is because the final value is a derived value and not a real data value along the sampling ray.

Average intensity blend mode works similar to the additive blend mode where the scalar values are multiplied by opacity calculated from the opacity transfer function and then added. The additional step here is to divide the sum by the number of samples taken through the volume. One can control the scalar range by setting the AverageIPScalarRange ivar to disregard scalar values, not in the range of interest, from the average computation. As is the case with the additive intensity projection, the final image will always be grayscale i.e. the aggregated values are not passed through the color transfer function. This is because the resultant value is a derived value and not a real data value along the sampling ray.

IsoSurface blend mode uses contour values defined by the user in order to display scalar values only when the ray crosses the contour. It supports opacity the same way composite blend mode does.

Note

vtkVolumeMapper::AVERAGE_INTENSITY_BLEND and ISOSURFACE_BLEND are only supported by the vtkGPUVolumeRayCastMapper with the OpenGL2 backend.

See also

SetAverageIPScalarRange()

GetIsosurfaceValues()

Definition at line 120 of file vtkVolumeMapper.h.

GetBlendMode()

virtual int vtkVolumeMapper::GetBlendMode ( )

virtual

Set/Get the blend mode.

The default mode is Composite where the scalar values are sampled through the volume and composited in a front-to-back scheme through alpha blending. The final color and opacity is determined using the color and opacity transfer functions.

Maximum and minimum intensity blend modes use the maximum and minimum scalar values, respectively, along the sampling ray. The final color and opacity is determined by passing the resultant value through the color and opacity transfer functions.

Additive blend mode accumulates scalar values by passing each value through the opacity transfer function and then adding up the product of the value and its opacity. In other words, the scalar values are scaled using the opacity transfer function and summed to derive the final color. Note that the resulting image is always grayscale i.e. aggregated values are not passed through the color transfer function. This is because the final value is a derived value and not a real data value along the sampling ray.

Average intensity blend mode works similar to the additive blend mode where the scalar values are multiplied by opacity calculated from the opacity transfer function and then added. The additional step here is to divide the sum by the number of samples taken through the volume. One can control the scalar range by setting the AverageIPScalarRange ivar to disregard scalar values, not in the range of interest, from the average computation. As is the case with the additive intensity projection, the final image will always be grayscale i.e. the aggregated values are not passed through the color transfer function. This is because the resultant value is a derived value and not a real data value along the sampling ray.

IsoSurface blend mode uses contour values defined by the user in order to display scalar values only when the ray crosses the contour. It supports opacity the same way composite blend mode does.

Note

vtkVolumeMapper::AVERAGE_INTENSITY_BLEND and ISOSURFACE_BLEND are only supported by the vtkGPUVolumeRayCastMapper with the OpenGL2 backend.

See also

SetAverageIPScalarRange()

GetIsosurfaceValues()

Reimplemented in vtkAMRVolumeMapper.

SetAverageIPScalarRange() [1/2]

virtual void vtkVolumeMapper::SetAverageIPScalarRange ( double  , double    )

virtual

Set/Get the scalar range to be considered for average intensity projection blend mode.

Only scalar values between this range will be averaged during ray casting. This can be useful when volume rendering CT datasets where the areas occupied by air would deviate the final rendering. By default, the range is set to (VTK_FLOAT_MIN, VTK_FLOAT_MAX).

See also

SetBlendModeToAverageIntensity()

SetAverageIPScalarRange() [2/2]

void vtkVolumeMapper::SetAverageIPScalarRange

(

double

[2]

)

Set/Get the scalar range to be considered for average intensity projection blend mode.

Only scalar values between this range will be averaged during ray casting. This can be useful when volume rendering CT datasets where the areas occupied by air would deviate the final rendering. By default, the range is set to (VTK_FLOAT_MIN, VTK_FLOAT_MAX).

See also

SetBlendModeToAverageIntensity()

GetAverageIPScalarRange() [1/2]

virtual double * vtkVolumeMapper::GetAverageIPScalarRange ( )

virtual

Set/Get the scalar range to be considered for average intensity projection blend mode.

Only scalar values between this range will be averaged during ray casting. This can be useful when volume rendering CT datasets where the areas occupied by air would deviate the final rendering. By default, the range is set to (VTK_FLOAT_MIN, VTK_FLOAT_MAX).

See also

SetBlendModeToAverageIntensity()

GetAverageIPScalarRange() [2/2]

virtual void vtkVolumeMapper::GetAverageIPScalarRange ( double  data[2] )

virtual

Set/Get the scalar range to be considered for average intensity projection blend mode.

Only scalar values between this range will be averaged during ray casting. This can be useful when volume rendering CT datasets where the areas occupied by air would deviate the final rendering. By default, the range is set to (VTK_FLOAT_MIN, VTK_FLOAT_MAX).

See also

SetBlendModeToAverageIntensity()

SetCropping()

virtual void vtkVolumeMapper::SetCropping ( vtkTypeBool  )

virtual

Turn On/Off orthogonal cropping.

(Clipping planes are perpendicular to the coordinate axes.)

Reimplemented in vtkMultiBlockVolumeMapper, and vtkAMRVolumeMapper.

GetCropping()

virtual vtkTypeBool vtkVolumeMapper::GetCropping ( )

virtual

Turn On/Off orthogonal cropping.

(Clipping planes are perpendicular to the coordinate axes.)

Reimplemented in vtkAMRVolumeMapper.

CroppingOn()

virtual void vtkVolumeMapper::CroppingOn ( )

virtual

Turn On/Off orthogonal cropping.

(Clipping planes are perpendicular to the coordinate axes.)

CroppingOff()

virtual void vtkVolumeMapper::CroppingOff ( )

virtual

Turn On/Off orthogonal cropping.

(Clipping planes are perpendicular to the coordinate axes.)

SetCroppingRegionPlanes() [1/2]

virtual void vtkVolumeMapper::SetCroppingRegionPlanes ( double  , double  , double  , double  , double  , double    )

virtual

Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.

Reimplemented in vtkAMRVolumeMapper, and vtkMultiBlockVolumeMapper.

SetCroppingRegionPlanes() [2/2]

virtual void vtkVolumeMapper::SetCroppingRegionPlanes ( double  [6] )

virtual

Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.

GetCroppingRegionPlanes() [1/2]

virtual double * vtkVolumeMapper::GetCroppingRegionPlanes ( )

virtual

Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.

Reimplemented in vtkAMRVolumeMapper.

GetCroppingRegionPlanes() [2/2]

virtual void vtkVolumeMapper::GetCroppingRegionPlanes ( double  data[6] )

virtual

Set/Get the Cropping Region Planes ( xmin, xmax, ymin, ymax, zmin, zmax ) These planes are defined in volume coordinates - spacing and origin are considered.

GetVoxelCroppingRegionPlanes() [1/2]

virtual double * vtkVolumeMapper::GetVoxelCroppingRegionPlanes ( )

virtual

Get the cropping region planes in voxels.

Only valid during the rendering process

GetVoxelCroppingRegionPlanes() [2/2]

virtual void vtkVolumeMapper::GetVoxelCroppingRegionPlanes ( double  data[6] )

virtual

Get the cropping region planes in voxels.

Only valid during the rendering process

SetCroppingRegionFlags()

virtual void vtkVolumeMapper::SetCroppingRegionFlags ( int  )

virtual

Set the flags for the cropping regions.

The clipping planes divide the volume into 27 regions - there is one bit for each region. The regions start from the one containing voxel (0,0,0), moving along the x axis fastest, the y axis next, and the z axis slowest. These are represented from the lowest bit to bit number 27 in the integer containing the flags. There are several convenience functions to set some common configurations - subvolume (the default), fence (between any of the clip plane pairs), inverted fence, cross (between any two of the clip plane pairs) and inverted cross.

Reimplemented in vtkAMRVolumeMapper, and vtkMultiBlockVolumeMapper.

GetCroppingRegionFlags()

virtual int vtkVolumeMapper::GetCroppingRegionFlags ( )

virtual

Set the flags for the cropping regions.

The clipping planes divide the volume into 27 regions - there is one bit for each region. The regions start from the one containing voxel (0,0,0), moving along the x axis fastest, the y axis next, and the z axis slowest. These are represented from the lowest bit to bit number 27 in the integer containing the flags. There are several convenience functions to set some common configurations - subvolume (the default), fence (between any of the clip plane pairs), inverted fence, cross (between any two of the clip plane pairs) and inverted cross.

Reimplemented in vtkAMRVolumeMapper.

SetCroppingRegionFlagsToSubVolume()

void vtkVolumeMapper::SetCroppingRegionFlagsToSubVolume ( )

inline

Set the flags for the cropping regions.

The clipping planes divide the volume into 27 regions - there is one bit for each region. The regions start from the one containing voxel (0,0,0), moving along the x axis fastest, the y axis next, and the z axis slowest. These are represented from the lowest bit to bit number 27 in the integer containing the flags. There are several convenience functions to set some common configurations - subvolume (the default), fence (between any of the clip plane pairs), inverted fence, cross (between any two of the clip plane pairs) and inverted cross.

Definition at line 179 of file vtkVolumeMapper.h.

SetCroppingRegionFlagsToFence()

void vtkVolumeMapper::SetCroppingRegionFlagsToFence ( )

inline

Set the flags for the cropping regions.

The clipping planes divide the volume into 27 regions - there is one bit for each region. The regions start from the one containing voxel (0,0,0), moving along the x axis fastest, the y axis next, and the z axis slowest. These are represented from the lowest bit to bit number 27 in the integer containing the flags. There are several convenience functions to set some common configurations - subvolume (the default), fence (between any of the clip plane pairs), inverted fence, cross (between any two of the clip plane pairs) and inverted cross.

Definition at line 180 of file vtkVolumeMapper.h.

SetCroppingRegionFlagsToInvertedFence()

void vtkVolumeMapper::SetCroppingRegionFlagsToInvertedFence ( )

inline

Set the flags for the cropping regions.

The clipping planes divide the volume into 27 regions - there is one bit for each region. The regions start from the one containing voxel (0,0,0), moving along the x axis fastest, the y axis next, and the z axis slowest. These are represented from the lowest bit to bit number 27 in the integer containing the flags. There are several convenience functions to set some common configurations - subvolume (the default), fence (between any of the clip plane pairs), inverted fence, cross (between any two of the clip plane pairs) and inverted cross.

Definition at line 181 of file vtkVolumeMapper.h.

SetCroppingRegionFlagsToCross()

void vtkVolumeMapper::SetCroppingRegionFlagsToCross ( )

inline

Set the flags for the cropping regions.

The clipping planes divide the volume into 27 regions - there is one bit for each region. The regions start from the one containing voxel (0,0,0), moving along the x axis fastest, the y axis next, and the z axis slowest. These are represented from the lowest bit to bit number 27 in the integer containing the flags. There are several convenience functions to set some common configurations - subvolume (the default), fence (between any of the clip plane pairs), inverted fence, cross (between any two of the clip plane pairs) and inverted cross.

Definition at line 185 of file vtkVolumeMapper.h.

SetCroppingRegionFlagsToInvertedCross()

void vtkVolumeMapper::SetCroppingRegionFlagsToInvertedCross ( )

inline

Set the flags for the cropping regions.

The clipping planes divide the volume into 27 regions - there is one bit for each region. The regions start from the one containing voxel (0,0,0), moving along the x axis fastest, the y axis next, and the z axis slowest. These are represented from the lowest bit to bit number 27 in the integer containing the flags. There are several convenience functions to set some common configurations - subvolume (the default), fence (between any of the clip plane pairs), inverted fence, cross (between any two of the clip plane pairs) and inverted cross.

Definition at line 186 of file vtkVolumeMapper.h.

Render()

void vtkVolumeMapper::Render ( vtkRenderer *  ren, vtkVolume *  vol  )

overridepure virtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Render the volume.

Implements vtkAbstractVolumeMapper.

Implemented in vtkOSPRayVolumeMapper, vtkFixedPointVolumeRayCastMapper, vtkGPUVolumeRayCastMapper, vtkOSPRayVolumeInterface, vtkSmartVolumeMapper, vtkAMRVolumeMapper, and vtkMultiBlockVolumeMapper.

ReleaseGraphicsResources()

void vtkVolumeMapper::ReleaseGraphicsResources ( vtkWindow *  )

inlineoverridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this mapper.

The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkAbstractVolumeMapper.

Reimplemented in vtkAMRVolumeMapper, vtkSmartVolumeMapper, vtkMultiBlockVolumeMapper, and vtkOpenGLGPUVolumeRayCastMapper.

Definition at line 205 of file vtkVolumeMapper.h.

SpacingAdjustedSampleDistance()

double vtkVolumeMapper::SpacingAdjustedSampleDistance ( double  inputSpacing[3], int  inputExtent[6]  )

protected

Compute a sample distance from the data spacing.

When the number of voxels is 8, the sample distance will be roughly 1/200 the average voxel size. The distance will grow proportionally to numVoxels^(1/3).

ConvertCroppingRegionPlanesToVoxels()

void vtkVolumeMapper::ConvertCroppingRegionPlanesToVoxels ( )

protected

Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates.

FillInputPortInformation()

int vtkVolumeMapper::FillInputPortInformation ( int  port, vtkInformation *  info  )

overrideprotectedvirtual

Fill the input port information objects for this algorithm.

This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkAbstractVolumeMapper.

Reimplemented in vtkAMRVolumeMapper, and vtkMultiBlockVolumeMapper.

Member Data Documentation

BlendMode

int vtkVolumeMapper::BlendMode

protected

Definition at line 271 of file vtkVolumeMapper.h.

AverageIPScalarRange

double vtkVolumeMapper::AverageIPScalarRange[2]

protected

Threshold range for average intensity projection.

Definition at line 276 of file vtkVolumeMapper.h.

Cropping

vtkTypeBool vtkVolumeMapper::Cropping

protected

Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates.

Definition at line 283 of file vtkVolumeMapper.h.

CroppingRegionPlanes

double vtkVolumeMapper::CroppingRegionPlanes[6]

protected

Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates.

Definition at line 284 of file vtkVolumeMapper.h.

VoxelCroppingRegionPlanes

double vtkVolumeMapper::VoxelCroppingRegionPlanes[6]

protected

Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates.

Definition at line 285 of file vtkVolumeMapper.h.

CroppingRegionFlags

int vtkVolumeMapper::CroppingRegionFlags

protected

Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates.

Definition at line 286 of file vtkVolumeMapper.h.

---

The documentation for this class was generated from the following file:

• Rendering/Volume/vtkVolumeMapper.h