Ray casting performed on the GPU. More...

#include <vtkGPUVolumeRayCastMapper.h>

Inheritance diagram for vtkGPUVolumeRayCastMapper:

Collaboration diagram for vtkGPUVolumeRayCastMapper:

Public Types
enum	{ BinaryMaskType = 0, LabelMapMaskType }

enum	TFRangeType { SCALAR = 0, NATIVE }

typedef vtkVolumeMapper	Superclass

Public Types inherited from vtkVolumeMapper
enum	BlendModes { COMPOSITE_BLEND, MAXIMUM_INTENSITY_BLEND, MINIMUM_INTENSITY_BLEND, AVERAGE_INTENSITY_BLEND, ADDITIVE_BLEND, ISOSURFACE_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. More...

vtkGPUVolumeRayCastMapper *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

vtkContourValues *	GetDepthPassContourValues ()
	Return handle to contour values container so that values can be set by the application. More...

virtual int	IsRenderSupported (vtkRenderWindow vtkNotUsed(window), vtkVolumeProperty vtkNotUsed(property))
	Based on hardware and properties, we may or may not be able to render using 3D texture mapping. More...

void	CreateCanonicalView (vtkRenderer ren, vtkVolume volume, vtkImageData *image, int blend_mode, double viewDirection[3], double viewUp[3])

virtual void	GetDepthImage (vtkImageData *)
	Low level API to export the depth texture as vtkImageData in RenderToImage mode. More...

virtual void	GetColorImage (vtkImageData *)
	Low level API to export the color texture as vtkImageData in RenderToImage mode. More...

void	Render (vtkRenderer , vtkVolume ) override
	Initialize rendering for this volume. More...

virtual void	GPURender (vtkRenderer , vtkVolume )
	Handled in the subclass - the actual render method. More...

void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this mapper. More...

virtual void	GetReductionRatio (double ratio[3])=0
	Return how much the dataset has to be reduced in each dimension to fit on the GPU. More...

vtkImageData *	GetInput () override
	Set/Get the input data. More...

int	GetInputCount ()
	Number of currently active ports. More...

vtkImageData *	GetTransformedInput (const int port=0)

double *	GetBoundsFromPort (const int port)


virtual void	SetAutoAdjustSampleDistances (vtkTypeBool)
	If AutoAdjustSampleDistances is on, the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use). More...

virtual vtkTypeBool	GetAutoAdjustSampleDistances ()
	If AutoAdjustSampleDistances is on, the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use). More...

virtual void	AutoAdjustSampleDistancesOn ()
	If AutoAdjustSampleDistances is on, the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use). More...

virtual void	AutoAdjustSampleDistancesOff ()
	If AutoAdjustSampleDistances is on, the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use). More...


virtual void	SetLockSampleDistanceToInputSpacing (vtkTypeBool)
	Compute the sample distance from the data spacing. More...

virtual vtkTypeBool	GetLockSampleDistanceToInputSpacing ()
	Compute the sample distance from the data spacing. More...

virtual void	LockSampleDistanceToInputSpacingOn ()
	Compute the sample distance from the data spacing. More...

virtual void	LockSampleDistanceToInputSpacingOff ()
	Compute the sample distance from the data spacing. More...


virtual void	SetUseJittering (vtkTypeBool)
	If UseJittering is on, each ray traversal direction will be perturbed slightly using a noise-texture to get rid of wood-grain effect. More...

virtual vtkTypeBool	GetUseJittering ()
	If UseJittering is on, each ray traversal direction will be perturbed slightly using a noise-texture to get rid of wood-grain effect. More...

virtual void	UseJitteringOn ()
	If UseJittering is on, each ray traversal direction will be perturbed slightly using a noise-texture to get rid of wood-grain effect. More...

virtual void	UseJitteringOff ()
	If UseJittering is on, each ray traversal direction will be perturbed slightly using a noise-texture to get rid of wood-grain effect. More...


virtual void	SetUseDepthPass (vtkTypeBool)
	If UseDepthPass is on, the mapper will use two passes. More...

virtual vtkTypeBool	GetUseDepthPass ()
	If UseDepthPass is on, the mapper will use two passes. More...

virtual void	UseDepthPassOn ()
	If UseDepthPass is on, the mapper will use two passes. More...

virtual void	UseDepthPassOff ()
	If UseDepthPass is on, the mapper will use two passes. More...


virtual void	SetSampleDistance (float)
	Set/Get the distance between samples used for rendering when AutoAdjustSampleDistances is off, or when this mapper has more than 1 second allocated to it for rendering. More...

virtual float	GetSampleDistance ()
	Set/Get the distance between samples used for rendering when AutoAdjustSampleDistances is off, or when this mapper has more than 1 second allocated to it for rendering. More...


virtual void	SetImageSampleDistance (float)
	Sampling distance in the XY image dimensions. More...

virtual float	GetImageSampleDistance ()
	Sampling distance in the XY image dimensions. More...


virtual void	SetMinimumImageSampleDistance (float)
	This is the minimum image sample distance allow when the image sample distance is being automatically adjusted. More...

virtual float	GetMinimumImageSampleDistance ()
	This is the minimum image sample distance allow when the image sample distance is being automatically adjusted. More...


virtual void	SetMaximumImageSampleDistance (float)
	This is the maximum image sample distance allow when the image sample distance is being automatically adjusted. More...

virtual float	GetMaximumImageSampleDistance ()
	This is the maximum image sample distance allow when the image sample distance is being automatically adjusted. More...


virtual void	SetFinalColorWindow (float)
	Set/Get the window / level applied to the final color. More...

virtual float	GetFinalColorWindow ()
	Set/Get the window / level applied to the final color. More...

virtual void	SetFinalColorLevel (float)
	Set/Get the window / level applied to the final color. More...

virtual float	GetFinalColorLevel ()
	Set/Get the window / level applied to the final color. More...


virtual void	SetMaxMemoryInBytes (vtkIdType)
	Maximum size of the 3D texture in GPU memory. More...

virtual vtkIdType	GetMaxMemoryInBytes ()
	Maximum size of the 3D texture in GPU memory. More...


virtual void	SetMaxMemoryFraction (float)
	Maximum fraction of the MaxMemoryInBytes that should be used to hold the texture. More...

virtual float	GetMaxMemoryFraction ()
	Maximum fraction of the MaxMemoryInBytes that should be used to hold the texture. More...


virtual void	SetReportProgress (bool)
	Tells if the mapper will report intermediate progress. More...

virtual bool	GetReportProgress ()
	Tells if the mapper will report intermediate progress. More...


void	SetMaskInput (vtkImageData *mask)
	Optionally, set a mask input. More...

virtual vtkImageData *	GetMaskInput ()
	Optionally, set a mask input. More...


virtual void	SetMaskType (int)
	Set the mask type, if mask is to be used. More...

virtual int	GetMaskType ()
	Set the mask type, if mask is to be used. More...

void	SetMaskTypeToBinary ()
	Set the mask type, if mask is to be used. More...

void	SetMaskTypeToLabelMap ()
	Set the mask type, if mask is to be used. More...


virtual void	SetMaskBlendFactor (float)
	Tells how much mask color transfer function is used compared to the standard color transfer function when the mask is true. More...

virtual float	GetMaskBlendFactor ()
	Tells how much mask color transfer function is used compared to the standard color transfer function when the mask is true. More...


virtual void	SetRenderToImage (vtkTypeBool)
	Enable or disable setting output of volume rendering to be color and depth textures. More...

virtual vtkTypeBool	GetRenderToImage ()
	Enable or disable setting output of volume rendering to be color and depth textures. More...

virtual void	RenderToImageOn ()
	Enable or disable setting output of volume rendering to be color and depth textures. More...

virtual void	RenderToImageOff ()
	Enable or disable setting output of volume rendering to be color and depth textures. More...


virtual void	SetDepthImageScalarType (int)
	Set/Get the scalar type of the depth texture in RenderToImage mode. More...

virtual int	GetDepthImageScalarType ()
	Set/Get the scalar type of the depth texture in RenderToImage mode. More...

void	SetDepthImageScalarTypeToUnsignedChar ()
	Set/Get the scalar type of the depth texture in RenderToImage mode. More...

void	SetDepthImageScalarTypeToUnsignedShort ()
	Set/Get the scalar type of the depth texture in RenderToImage mode. More...

void	SetDepthImageScalarTypeToFloat ()
	Set/Get the scalar type of the depth texture in RenderToImage mode. More...


virtual void	SetClampDepthToBackface (vtkTypeBool)
	Enable or disable clamping the depth value of the fully transparent voxel to the depth of the back-face of the volume. More...

virtual vtkTypeBool	GetClampDepthToBackface ()
	Enable or disable clamping the depth value of the fully transparent voxel to the depth of the back-face of the volume. More...

virtual void	ClampDepthToBackfaceOn ()
	Enable or disable clamping the depth value of the fully transparent voxel to the depth of the back-face of the volume. More...

virtual void	ClampDepthToBackfaceOff ()
	Enable or disable clamping the depth value of the fully transparent voxel to the depth of the back-face of the volume. More...


virtual void	SetColorRangeType (int)
	Set whether to use the scalar range or the native transfer function range when looking up transfer functions for color and opacity values. More...

virtual int	GetColorRangeType ()
	Set whether to use the scalar range or the native transfer function range when looking up transfer functions for color and opacity values. More...

virtual void	SetScalarOpacityRangeType (int)
	Set whether to use the scalar range or the native transfer function range when looking up transfer functions for color and opacity values. More...

virtual int	GetScalarOpacityRangeType ()
	Set whether to use the scalar range or the native transfer function range when looking up transfer functions for color and opacity values. More...

virtual void	SetGradientOpacityRangeType (int)
	Set whether to use the scalar range or the native transfer function range when looking up transfer functions for color and opacity values. More...

virtual int	GetGradientOpacityRangeType ()
	Set whether to use the scalar range or the native transfer function range when looking up transfer functions for color and opacity values. More...


void	RemoveInputConnection (int port, vtkAlgorithmOutput *input) override
	Add/Remove input connections. More...

void	RemoveInputConnection (int port, int idx) override
	Add/Remove input connections. More...

void	SetInputConnection (int port, vtkAlgorithmOutput *input) override
	Add/Remove input connections. More...

void	SetInputConnection (vtkAlgorithmOutput *input) override
	Add/Remove input connections. More...

Public Member Functions inherited from vtkVolumeMapper
vtkVolumeMapper *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	ReleaseGraphicsResources (vtkWindow *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this mapper. More...

virtual void	SetInputData (vtkImageData *)
	Set/Get the input data. More...

virtual void	SetInputData (vtkDataSet *)
	Set/Get the input data. More...

virtual void	SetBlendMode (int)
	Set/Get the blend mode. More...

void	SetBlendModeToComposite ()
	Set/Get the blend mode. More...

void	SetBlendModeToMaximumIntensity ()
	Set/Get the blend mode. More...

void	SetBlendModeToMinimumIntensity ()
	Set/Get the blend mode. More...

void	SetBlendModeToAverageIntensity ()
	Set/Get the blend mode. More...

void	SetBlendModeToAdditive ()
	Set/Get the blend mode. More...

void	SetBlendModeToIsoSurface ()
	Set/Get the blend mode. More...

virtual int	GetBlendMode ()
	Set/Get the blend mode. More...

virtual void	SetAverageIPScalarRange (double, double)
	Set/Get the scalar range to be considered for average intensity projection blend mode. More...

void	SetAverageIPScalarRange (double[2])
	Set/Get the scalar range to be considered for average intensity projection blend mode. More...

virtual double *	GetAverageIPScalarRange ()
	Set/Get the scalar range to be considered for average intensity projection blend mode. More...

virtual void	GetAverageIPScalarRange (double data[2])
	Set/Get the scalar range to be considered for average intensity projection blend mode. More...

virtual void	SetCropping (vtkTypeBool)
	Turn On/Off orthogonal cropping. More...

virtual vtkTypeBool	GetCropping ()
	Turn On/Off orthogonal cropping. More...

virtual void	CroppingOn ()
	Turn On/Off orthogonal cropping. More...

virtual void	CroppingOff ()
	Turn On/Off orthogonal cropping. More...

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. More...

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. More...

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. More...

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. More...

virtual double *	GetVoxelCroppingRegionPlanes ()
	Get the cropping region planes in voxels. More...

virtual void	GetVoxelCroppingRegionPlanes (double data[6])
	Get the cropping region planes in voxels. More...

virtual void	SetCroppingRegionFlags (int)
	Set the flags for the cropping regions. More...

virtual int	GetCroppingRegionFlags ()
	Set the flags for the cropping regions. More...

void	SetCroppingRegionFlagsToSubVolume ()
	Set the flags for the cropping regions. More...

void	SetCroppingRegionFlagsToFence ()
	Set the flags for the cropping regions. More...

void	SetCroppingRegionFlagsToInvertedFence ()
	Set the flags for the cropping regions. More...

void	SetCroppingRegionFlagsToCross ()
	Set the flags for the cropping regions. More...

void	SetCroppingRegionFlagsToInvertedCross ()
	Set the flags for the cropping regions. More...

Public Member Functions inherited from vtkAbstractVolumeMapper
vtkAbstractVolumeMapper *	NewInstance () const

virtual char *	GetArrayName ()
	Get the array name or number and component to use for rendering. More...

virtual int	GetArrayId ()

virtual int	GetArrayAccessMode ()

const char *	GetScalarModeAsString ()
	Return the method for obtaining scalar data. More...

virtual vtkDataSet *	GetDataSetInput ()
	Set/Get the input data. More...

virtual vtkDataObject *	GetDataObjectInput ()
	Set/Get the input data. More...

double *	GetBounds () override
	Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax). More...

void	GetBounds (double bounds[6]) override
	Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax). More...

virtual void	SetScalarMode (int)
	Control how the mapper works with scalar point data and cell attribute data. More...

virtual int	GetScalarMode ()
	Control how the mapper works with scalar point data and cell attribute data. More...

virtual void	SetArrayAccessMode (int)
	Control how the mapper works with scalar point data and cell attribute data. More...

void	SetScalarModeToDefault ()
	Control how the mapper works with scalar point data and cell attribute data. More...

void	SetScalarModeToUsePointData ()
	Control how the mapper works with scalar point data and cell attribute data. More...

void	SetScalarModeToUseCellData ()
	Control how the mapper works with scalar point data and cell attribute data. More...

void	SetScalarModeToUsePointFieldData ()
	Control how the mapper works with scalar point data and cell attribute data. More...

void	SetScalarModeToUseCellFieldData ()
	Control how the mapper works with scalar point data and cell attribute data. More...

virtual void	SelectScalarArray (int arrayNum)
	When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which scalar array to use during rendering. More...

virtual void	SelectScalarArray (const char *arrayName)
	When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which scalar array to use during rendering. More...

virtual float	GetGradientMagnitudeScale ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE. More...

virtual float	GetGradientMagnitudeBias ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE. More...

virtual float	GetGradientMagnitudeScale (int)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE. More...

virtual float	GetGradientMagnitudeBias (int)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE. More...

Public Member Functions inherited from vtkAbstractMapper3D
vtkAbstractMapper3D *	NewInstance () const

double	GetLength ()
	Return the diagonal length of this mappers bounding box. More...

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. More...

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. More...

void	GetClippingPlaneInDataCoords (vtkMatrix4x4 *propMatrix, int i, double planeEquation[4])
	Get the ith clipping plane as a homogeneous plane equation. More...

double *	GetCenter ()
	Return the Center of this mapper's data. More...

void	GetCenter (double center[3])
	Return the Center of this mapper's data. More...

Public Member Functions inherited from vtkAbstractMapper
vtkAbstractMapper *	NewInstance () const

vtkMTimeType	GetMTime () override
	Override Modifiedtime as we have added Clipping planes. More...

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. More...

virtual void	ShallowCopy (vtkAbstractMapper *m)
	Make a shallow copy of this mapper. More...

int	GetNumberOfClippingPlanes ()
	Get the number of clipping planes. More...

virtual double	GetTimeToDraw ()
	Get the time required to draw the geometry last time it was rendered. More...

void	AddClippingPlane (vtkPlane *plane)
	Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified). More...

void	RemoveClippingPlane (vtkPlane *plane)
	Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified). More...

void	RemoveAllClippingPlanes ()
	Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified). More...

virtual void	SetClippingPlanes (vtkPlaneCollection *)
	Get/Set the vtkPlaneCollection which specifies the clipping planes. More...

virtual vtkPlaneCollection *	GetClippingPlanes ()
	Get/Set the vtkPlaneCollection which specifies the clipping planes. More...

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()
	Check whether this algorithm has an assigned executive. More...

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive. More...

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive. More...

virtual int	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality. More...

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped. More...

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. More...

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. More...

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port. More...

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port. More...

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm. More...

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm. More...

void	UpdateProgress (double amount)
	Update the progress of the process object. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	String based versions of SetInputArrayToProcess(). More...

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm. More...

void	RemoveAllInputs ()
	Remove all the input data. More...

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port. More...

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection. More...

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections. More...

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index. More...

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port. More...

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm. More...

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port. More...

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm. More...

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port. More...

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. More...

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair. More...

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0). More...

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection. More...

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0) More...

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection. More...

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0) More...

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port. More...

virtual int	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). More...

virtual int	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port. More...

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. More...

virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port. More...

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. More...

virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date. More...

virtual void	UpdateDataObject ()
	Create output object(s). More...

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream. More...

virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date. More...

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm. More...

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm. More...

void	Register (vtkObjectBase *o) override
	Participate in garbage collection. More...

void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection. More...

virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object. More...

virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object. More...

virtual void	SetProgress (double)
	Set/Get the execution progress of a process object. More...

virtual double	GetProgress ()
	Set/Get the execution progress of a process object. More...

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state. More...

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state. More...

virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process. More...

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process. More...

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...

virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date. More...

virtual void	Update ()
	Bring this algorithm's outputs up-to-date. More...

virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports. More...

virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports. More...

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports. More...

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. More...

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. More...

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents. More...

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents. More...

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. More...

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. More...

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents. More...

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents. More...

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents. More...

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

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. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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. More...

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. More...

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. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkGPUVolumeRayCastMapper *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkGPUVolumeRayCastMapper *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkVolumeMapper
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. More...

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. More...

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. More...

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. More...

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...

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. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Types
using	DataMap = std::unordered_map< int, vtkImageData * >

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkGPUVolumeRayCastMapper ()

	~vtkGPUVolumeRayCastMapper () override

int	FillInputPortInformation (int port, vtkInformation *info) override
	Handle inputs. More...

void	TransformInput (const int port)
	A transformation is applied (translation) to the input. More...

void	CanonicalViewRender (vtkRenderer , vtkVolume )

virtual void	PreRender (vtkRenderer ren, vtkVolume vol, double datasetBounds[6], double scalarRange[2], int numberOfScalarComponents, unsigned int numberOfLevels)=0

virtual void	RenderBlock (vtkRenderer ren, vtkVolume vol, unsigned int level)=0

virtual void	PostRender (vtkRenderer *ren, int numberOfScalarComponents)=0

vtkImageData *	GetInput (const int port) override
	Set/Get the input data. More...

void	SetCellFlag (int cellFlag)
	Called by the AMR Volume Mapper. More...

void	RemovePortInternal (const int port)

virtual void	ClipCroppingRegionPlanes ()
	Compute the cropping planes clipped by the bounds of the volume. More...

void	SetTransformedInput (vtkImageData *)

vtkImageData *	FindData (int port, DataMap &container)


int	ValidateRender (vtkRenderer , vtkVolume )
	This method is used by the Render() method to validate everything before attempting to render. More...

int	ValidateInputs ()
	This method is used by the Render() method to validate everything before attempting to render. More...

int	ValidateInput (vtkVolumeProperty *property, const int port)
	This method is used by the Render() method to validate everything before attempting to render. More...


void	CloneInputs ()
	Shallow-copy the inputs into a transform-adjusted clone. More...

void	CloneInput (vtkImageData *input, const int port)
	Shallow-copy the inputs into a transform-adjusted clone. More...


virtual void	SetAMRMode (vtkTypeBool)
	Set the mapper in AMR Mode or not. More...

virtual vtkTypeBool	GetAMRMode ()
	Set the mapper in AMR Mode or not. More...

virtual void	AMRModeOn ()
	Set the mapper in AMR Mode or not. More...

virtual void	AMRModeOff ()
	Set the mapper in AMR Mode or not. More...

Protected Member Functions inherited from vtkVolumeMapper
	vtkVolumeMapper ()

	~vtkVolumeMapper () override

double	SpacingAdjustedSampleDistance (double inputSpacing[3], int inputExtent[6])
	Compute a sample distance from the data spacing. More...

int	FillInputPortInformation (int, vtkInformation *) override
	Fill the input port information objects for this algorithm. More...

void	ConvertCroppingRegionPlanesToVoxels ()
	Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates. More...

Protected Member Functions inherited from vtkAbstractVolumeMapper
	vtkAbstractVolumeMapper ()

	~vtkAbstractVolumeMapper () override

Protected Member Functions inherited from vtkAbstractMapper3D
	vtkAbstractMapper3D ()

	~vtkAbstractMapper3D () override

Protected Member Functions inherited from vtkAbstractMapper
	vtkAbstractMapper ()

	~vtkAbstractMapper () override

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm () override

virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm. More...

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm. More...

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm. More...

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. More...

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive. More...

void	ReportReferences (vtkGarbageCollector *) override

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port. More...

virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port. More...

void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input. More...

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. More...

int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

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. More...

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. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

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. More...

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. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...

virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file. More...

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. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkTypeBool	LockSampleDistanceToInputSpacing

vtkTypeBool	AutoAdjustSampleDistances

float	ImageSampleDistance

float	MinimumImageSampleDistance

float	MaximumImageSampleDistance

vtkTypeBool	RenderToImage

int	DepthImageScalarType

vtkTypeBool	ClampDepthToBackface

vtkTypeBool	UseJittering

vtkTypeBool	UseDepthPass

vtkContourValues *	DepthPassContourValues

float	SampleDistance

int	SmallVolumeRender

double	BigTimeToDraw

double	SmallTimeToDraw

float	FinalColorWindow

float	FinalColorLevel

int	GeneratingCanonicalView

vtkImageData *	CanonicalViewImageData

vtkImageData *	MaskInput

float	MaskBlendFactor

int	MaskType

vtkTypeBool	AMRMode

int	ColorRangeType

int	ScalarOpacityRangeType

int	GradientOpacityRangeType

int	CellFlag

double	ClippedCroppingRegionPlanes [6]

vtkIdType	MaxMemoryInBytes

float	MaxMemoryFraction

bool	ReportProgress

std::vector< int >	Ports

std::vector< int >	RemovedPorts

DataMap	TransformedInputs

DataMap	LastInputs
	This is needed only to check if the input data has been changed since the last Render() call. More...

Protected Attributes inherited from vtkVolumeMapper
int	BlendMode

double	AverageIPScalarRange [2]
	Threshold range for average intensity projection. More...

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

double	CroppingRegionPlanes [6]
	Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates. More...

double	VoxelCroppingRegionPlanes [6]
	Cropping variables, and a method for converting the world coordinate cropping region planes to voxel coordinates. More...

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

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. More...

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Ray casting performed on the GPU.

vtkGPUVolumeRayCastMapper is a volume mapper that performs ray casting on the GPU using fragment programs.

This mapper supports connections in multiple ports of input 0 (port 0 being the only required connection). It is up to the concrete implementation whether additional inputs will be used during rendering. This class maintains a list of the currently active input ports (Ports) as well as a list of the ports that have been disconnected (RemovedPorts). RemovedPorts is used the the concrete implementation to clean up internal structures.

Definition at line 43 of file vtkGPUVolumeRayCastMapper.h.

Member Typedef Documentation

typedef vtkVolumeMapper vtkGPUVolumeRayCastMapper::Superclass

Definition at line 47 of file vtkGPUVolumeRayCastMapper.h.

using vtkGPUVolumeRayCastMapper::DataMap = std::unordered_map<int, vtkImageData*>

protected

Definition at line 585 of file vtkGPUVolumeRayCastMapper.h.

Member Enumeration Documentation

anonymous enum

Enumerator
BinaryMaskType
LabelMapMaskType

Definition at line 245 of file vtkGPUVolumeRayCastMapper.h.

enum vtkGPUVolumeRayCastMapper::TFRangeType

Enumerator
SCALAR
NATIVE

Definition at line 371 of file vtkGPUVolumeRayCastMapper.h.

Constructor & Destructor Documentation

vtkGPUVolumeRayCastMapper::vtkGPUVolumeRayCastMapper ( )

protected

vtkGPUVolumeRayCastMapper::~vtkGPUVolumeRayCastMapper ( )

overrideprotected

Member Function Documentation

static vtkGPUVolumeRayCastMapper* vtkGPUVolumeRayCastMapper::New ( )

static

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

static

virtual vtkTypeBool vtkGPUVolumeRayCastMapper::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 vtkVolumeMapper.

Reimplemented in vtkOpenGLGPUVolumeRayCastMapper.

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

static

virtual vtkObjectBase* vtkGPUVolumeRayCastMapper::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkVolumeMapper.

Reimplemented in vtkOpenGLGPUVolumeRayCastMapper.

vtkGPUVolumeRayCastMapper* vtkGPUVolumeRayCastMapper::NewInstance ( ) const

void vtkGPUVolumeRayCastMapper::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 vtkOpenGLGPUVolumeRayCastMapper.

virtual void vtkGPUVolumeRayCastMapper::SetAutoAdjustSampleDistances ( vtkTypeBool )

virtual

If AutoAdjustSampleDistances is on, the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

virtual vtkTypeBool vtkGPUVolumeRayCastMapper::GetAutoAdjustSampleDistances ( )

virtual

If AutoAdjustSampleDistances is on, the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

virtual void vtkGPUVolumeRayCastMapper::AutoAdjustSampleDistancesOn ( )

virtual

If AutoAdjustSampleDistances is on, the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

virtual void vtkGPUVolumeRayCastMapper::AutoAdjustSampleDistancesOff ( )

virtual

If AutoAdjustSampleDistances is on, the ImageSampleDistance will be varied to achieve the allocated render time of this prop (controlled by the desired update rate and any culling in use).

virtual void vtkGPUVolumeRayCastMapper::SetLockSampleDistanceToInputSpacing ( vtkTypeBool )

virtual

Compute the 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). Off by default.

virtual vtkTypeBool vtkGPUVolumeRayCastMapper::GetLockSampleDistanceToInputSpacing ( )

virtual

Compute the 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). Off by default.

virtual void vtkGPUVolumeRayCastMapper::LockSampleDistanceToInputSpacingOn ( )

virtual

Compute the 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). Off by default.

virtual void vtkGPUVolumeRayCastMapper::LockSampleDistanceToInputSpacingOff ( )

virtual

Compute the 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). Off by default.

virtual void vtkGPUVolumeRayCastMapper::SetUseJittering ( vtkTypeBool )

virtual

If UseJittering is on, each ray traversal direction will be perturbed slightly using a noise-texture to get rid of wood-grain effect.

virtual vtkTypeBool vtkGPUVolumeRayCastMapper::GetUseJittering ( )

virtual

If UseJittering is on, each ray traversal direction will be perturbed slightly using a noise-texture to get rid of wood-grain effect.

virtual void vtkGPUVolumeRayCastMapper::UseJitteringOn ( )

virtual

If UseJittering is on, each ray traversal direction will be perturbed slightly using a noise-texture to get rid of wood-grain effect.

virtual void vtkGPUVolumeRayCastMapper::UseJitteringOff ( )

virtual

If UseJittering is on, each ray traversal direction will be perturbed slightly using a noise-texture to get rid of wood-grain effect.

virtual void vtkGPUVolumeRayCastMapper::SetUseDepthPass ( vtkTypeBool )

virtual

If UseDepthPass is on, the mapper will use two passes.

In the first pass, an isocontour depth buffer will be utilized as starting point for ray-casting hence eliminating traversal on voxels that are not going to participate in final rendering. UseDepthPass requires reasonable contour values to be set which can be set by calling GetDepthPassContourValues() method and using vtkControurValues API.

virtual vtkTypeBool vtkGPUVolumeRayCastMapper::GetUseDepthPass ( )

virtual

If UseDepthPass is on, the mapper will use two passes.

In the first pass, an isocontour depth buffer will be utilized as starting point for ray-casting hence eliminating traversal on voxels that are not going to participate in final rendering. UseDepthPass requires reasonable contour values to be set which can be set by calling GetDepthPassContourValues() method and using vtkControurValues API.

virtual void vtkGPUVolumeRayCastMapper::UseDepthPassOn ( )

virtual

If UseDepthPass is on, the mapper will use two passes.

In the first pass, an isocontour depth buffer will be utilized as starting point for ray-casting hence eliminating traversal on voxels that are not going to participate in final rendering. UseDepthPass requires reasonable contour values to be set which can be set by calling GetDepthPassContourValues() method and using vtkControurValues API.

virtual void vtkGPUVolumeRayCastMapper::UseDepthPassOff ( )

virtual

If UseDepthPass is on, the mapper will use two passes.

In the first pass, an isocontour depth buffer will be utilized as starting point for ray-casting hence eliminating traversal on voxels that are not going to participate in final rendering. UseDepthPass requires reasonable contour values to be set which can be set by calling GetDepthPassContourValues() method and using vtkControurValues API.

vtkContourValues* vtkGPUVolumeRayCastMapper::GetDepthPassContourValues ( )

Return handle to contour values container so that values can be set by the application.

Contour values will be used only when UseDepthPass is on.

virtual void vtkGPUVolumeRayCastMapper::SetSampleDistance ( float )

virtual

Set/Get the distance between samples used for rendering when AutoAdjustSampleDistances is off, or when this mapper has more than 1 second allocated to it for rendering.

Initial value is 1.0.

virtual float vtkGPUVolumeRayCastMapper::GetSampleDistance ( )

virtual

Set/Get the distance between samples used for rendering when AutoAdjustSampleDistances is off, or when this mapper has more than 1 second allocated to it for rendering.

Initial value is 1.0.

virtual void vtkGPUVolumeRayCastMapper::SetImageSampleDistance ( float )

virtual

Sampling distance in the XY image dimensions.

Default value of 1 meaning 1 ray cast per pixel. If set to 0.5, 4 rays will be cast per pixel. If set to 2.0, 1 ray will be cast for every 4 (2 by 2) pixels. This value will be adjusted to meet a desired frame rate when AutoAdjustSampleDistances is on.

virtual float vtkGPUVolumeRayCastMapper::GetImageSampleDistance ( )

virtual

Sampling distance in the XY image dimensions.

Default value of 1 meaning 1 ray cast per pixel. If set to 0.5, 4 rays will be cast per pixel. If set to 2.0, 1 ray will be cast for every 4 (2 by 2) pixels. This value will be adjusted to meet a desired frame rate when AutoAdjustSampleDistances is on.

virtual void vtkGPUVolumeRayCastMapper::SetMinimumImageSampleDistance ( float )

virtual

This is the minimum image sample distance allow when the image sample distance is being automatically adjusted.

virtual float vtkGPUVolumeRayCastMapper::GetMinimumImageSampleDistance ( )

virtual

This is the minimum image sample distance allow when the image sample distance is being automatically adjusted.

virtual void vtkGPUVolumeRayCastMapper::SetMaximumImageSampleDistance ( float )

virtual

This is the maximum image sample distance allow when the image sample distance is being automatically adjusted.

virtual float vtkGPUVolumeRayCastMapper::GetMaximumImageSampleDistance ( )

virtual

This is the maximum image sample distance allow when the image sample distance is being automatically adjusted.

virtual void vtkGPUVolumeRayCastMapper::SetFinalColorWindow ( float )

virtual

Set/Get the window / level applied to the final color.

This allows brightness / contrast adjustments on the final image. window is the width of the window. level is the center of the window. Initial window value is 1.0 Initial level value is 0.5 window cannot be null but can be negative, this way values will be reversed. |window| can be larger than 1.0 level can be any real value.

virtual float vtkGPUVolumeRayCastMapper::GetFinalColorWindow ( )

virtual

Set/Get the window / level applied to the final color.

This allows brightness / contrast adjustments on the final image. window is the width of the window. level is the center of the window. Initial window value is 1.0 Initial level value is 0.5 window cannot be null but can be negative, this way values will be reversed. |window| can be larger than 1.0 level can be any real value.

virtual void vtkGPUVolumeRayCastMapper::SetFinalColorLevel ( float )

virtual

Set/Get the window / level applied to the final color.

This allows brightness / contrast adjustments on the final image. window is the width of the window. level is the center of the window. Initial window value is 1.0 Initial level value is 0.5 window cannot be null but can be negative, this way values will be reversed. |window| can be larger than 1.0 level can be any real value.

virtual float vtkGPUVolumeRayCastMapper::GetFinalColorLevel ( )

virtual

Set/Get the window / level applied to the final color.

This allows brightness / contrast adjustments on the final image. window is the width of the window. level is the center of the window. Initial window value is 1.0 Initial level value is 0.5 window cannot be null but can be negative, this way values will be reversed. |window| can be larger than 1.0 level can be any real value.

virtual void vtkGPUVolumeRayCastMapper::SetMaxMemoryInBytes ( vtkIdType )

virtual

Maximum size of the 3D texture in GPU memory.

Will default to the size computed from the graphics card. Can be adjusted by the user.

virtual vtkIdType vtkGPUVolumeRayCastMapper::GetMaxMemoryInBytes ( )

virtual

Maximum size of the 3D texture in GPU memory.

Will default to the size computed from the graphics card. Can be adjusted by the user.

virtual void vtkGPUVolumeRayCastMapper::SetMaxMemoryFraction ( float )

virtual

Maximum fraction of the MaxMemoryInBytes that should be used to hold the texture.

Valid values are 0.1 to 1.0.

virtual float vtkGPUVolumeRayCastMapper::GetMaxMemoryFraction ( )

virtual

Maximum fraction of the MaxMemoryInBytes that should be used to hold the texture.

Valid values are 0.1 to 1.0.

virtual void vtkGPUVolumeRayCastMapper::SetReportProgress ( bool )

virtual

Tells if the mapper will report intermediate progress.

Initial value is true. As the progress works with a GL blocking call (glFinish()), this can be useful for huge dataset but can slow down rendering of small dataset. It should be set to true for big dataset or complex shading and streaming but to false for small datasets.

virtual bool vtkGPUVolumeRayCastMapper::GetReportProgress ( )

virtual

Tells if the mapper will report intermediate progress.

Initial value is true. As the progress works with a GL blocking call (glFinish()), this can be useful for huge dataset but can slow down rendering of small dataset. It should be set to true for big dataset or complex shading and streaming but to false for small datasets.

virtual int vtkGPUVolumeRayCastMapper::IsRenderSupported	(	vtkRenderWindow *	vtkNotUsedwindow,
		vtkVolumeProperty *	vtkNotUsedproperty
	)

inlinevirtual

Based on hardware and properties, we may or may not be able to render using 3D texture mapping.

This indicates if 3D texture mapping is supported by the hardware, and if the other extensions necessary to support the specific properties are available.

Reimplemented in vtkOpenGLGPUVolumeRayCastMapper.

Definition at line 206 of file vtkGPUVolumeRayCastMapper.h.

void vtkGPUVolumeRayCastMapper::CreateCanonicalView	(	vtkRenderer *	ren,
		vtkVolume *	volume,
		vtkImageData *	image,
		int	blend_mode,
		double	viewDirection[3],
		double	viewUp[3]
	)

void vtkGPUVolumeRayCastMapper::SetMaskInput ( vtkImageData * mask )

Optionally, set a mask input.

This mask may be a binary mask or a label map. This must be specified via SetMaskType.

If the mask is a binary mask, the volume rendering is confined to regions within the binary mask. The binary mask is assumed to have a datatype of UCHAR and values of 255 (inside) and 0 (outside).

The mask may also be a label map. The label map is allowed to contain only 3 labels (values of 0, 1 and 2) and must have a datatype of UCHAR. In voxels with label value of 0, the color transfer function supplied by component 0 is used. In voxels with label value of 1, the color transfer function supplied by component 1 is used and blended with the transfer function supplied by component 0, with the blending weight being determined by MaskBlendFactor. In voxels with a label value of 2, the color transfer function supplied by component 2 is used and blended with the transfer function supplied by component 0, with the blending weight being determined by MaskBlendFactor.

virtual vtkImageData* vtkGPUVolumeRayCastMapper::GetMaskInput ( )

virtual

Optionally, set a mask input.

This mask may be a binary mask or a label map. This must be specified via SetMaskType.

If the mask is a binary mask, the volume rendering is confined to regions within the binary mask. The binary mask is assumed to have a datatype of UCHAR and values of 255 (inside) and 0 (outside).

The mask may also be a label map. The label map is allowed to contain only 3 labels (values of 0, 1 and 2) and must have a datatype of UCHAR. In voxels with label value of 0, the color transfer function supplied by component 0 is used. In voxels with label value of 1, the color transfer function supplied by component 1 is used and blended with the transfer function supplied by component 0, with the blending weight being determined by MaskBlendFactor. In voxels with a label value of 2, the color transfer function supplied by component 2 is used and blended with the transfer function supplied by component 0, with the blending weight being determined by MaskBlendFactor.

virtual void vtkGPUVolumeRayCastMapper::SetMaskType ( int )

virtual

Set the mask type, if mask is to be used.

See documentation for SetMaskInput(). The default is a LabelMapMaskType.

virtual int vtkGPUVolumeRayCastMapper::GetMaskType ( )

virtual

Set the mask type, if mask is to be used.

See documentation for SetMaskInput(). The default is a LabelMapMaskType.

void vtkGPUVolumeRayCastMapper::SetMaskTypeToBinary ( )

Set the mask type, if mask is to be used.

See documentation for SetMaskInput(). The default is a LabelMapMaskType.

void vtkGPUVolumeRayCastMapper::SetMaskTypeToLabelMap ( )

Set the mask type, if mask is to be used.

See documentation for SetMaskInput(). The default is a LabelMapMaskType.

virtual void vtkGPUVolumeRayCastMapper::SetMaskBlendFactor ( float )

virtual

Tells how much mask color transfer function is used compared to the standard color transfer function when the mask is true.

This is relevant only for the label map mask. 0.0 means only standard color transfer function. 1.0 means only mask color transfer function. The default value is 1.0.

virtual float vtkGPUVolumeRayCastMapper::GetMaskBlendFactor ( )

virtual

Tells how much mask color transfer function is used compared to the standard color transfer function when the mask is true.

This is relevant only for the label map mask. 0.0 means only standard color transfer function. 1.0 means only mask color transfer function. The default value is 1.0.

virtual void vtkGPUVolumeRayCastMapper::SetRenderToImage ( vtkTypeBool )

virtual

Enable or disable setting output of volume rendering to be color and depth textures.

By default this is set to 0 (off). It should be noted that it is possible that underlying API specific mapper may not supoport RenderToImage mode.

Warning

This method ignores any other volumes / props in the scene.
This method does not respect the general attributes of the scene i.e. background color, etc. It always produces a color image that has a transparent white background outside the bounds of the volume.

See also: GetDepthImage(), GetColorImage()

virtual vtkTypeBool vtkGPUVolumeRayCastMapper::GetRenderToImage ( )

virtual

Enable or disable setting output of volume rendering to be color and depth textures.

By default this is set to 0 (off). It should be noted that it is possible that underlying API specific mapper may not supoport RenderToImage mode.

Warning

This method ignores any other volumes / props in the scene.
This method does not respect the general attributes of the scene i.e. background color, etc. It always produces a color image that has a transparent white background outside the bounds of the volume.

See also: GetDepthImage(), GetColorImage()

virtual void vtkGPUVolumeRayCastMapper::RenderToImageOn ( )

virtual

Enable or disable setting output of volume rendering to be color and depth textures.

By default this is set to 0 (off). It should be noted that it is possible that underlying API specific mapper may not supoport RenderToImage mode.

Warning

This method ignores any other volumes / props in the scene.
This method does not respect the general attributes of the scene i.e. background color, etc. It always produces a color image that has a transparent white background outside the bounds of the volume.

See also: GetDepthImage(), GetColorImage()

virtual void vtkGPUVolumeRayCastMapper::RenderToImageOff ( )

virtual

Enable or disable setting output of volume rendering to be color and depth textures.

By default this is set to 0 (off). It should be noted that it is possible that underlying API specific mapper may not supoport RenderToImage mode.

Warning

This method ignores any other volumes / props in the scene.
This method does not respect the general attributes of the scene i.e. background color, etc. It always produces a color image that has a transparent white background outside the bounds of the volume.

See also: GetDepthImage(), GetColorImage()

virtual void vtkGPUVolumeRayCastMapper::SetDepthImageScalarType ( int )

virtual

Set/Get the scalar type of the depth texture in RenderToImage mode.

By default, the type if VTK_FLOAT.

See also: SetRenderToImage()

virtual int vtkGPUVolumeRayCastMapper::GetDepthImageScalarType ( )

virtual

Set/Get the scalar type of the depth texture in RenderToImage mode.

By default, the type if VTK_FLOAT.

See also: SetRenderToImage()

void vtkGPUVolumeRayCastMapper::SetDepthImageScalarTypeToUnsignedChar ( )

Set/Get the scalar type of the depth texture in RenderToImage mode.

By default, the type if VTK_FLOAT.

See also: SetRenderToImage()

void vtkGPUVolumeRayCastMapper::SetDepthImageScalarTypeToUnsignedShort ( )

Set/Get the scalar type of the depth texture in RenderToImage mode.

By default, the type if VTK_FLOAT.

See also: SetRenderToImage()

void vtkGPUVolumeRayCastMapper::SetDepthImageScalarTypeToFloat ( )

Set/Get the scalar type of the depth texture in RenderToImage mode.

By default, the type if VTK_FLOAT.

See also: SetRenderToImage()

virtual void vtkGPUVolumeRayCastMapper::SetClampDepthToBackface ( vtkTypeBool )

virtual

Enable or disable clamping the depth value of the fully transparent voxel to the depth of the back-face of the volume.

This parameter is used when RenderToImage mode is enabled. When ClampDepthToBackFace is false, the fully transparent voxels will have a value of 1.0 in the depth image. When this is true, the fully transparent voxels will have the depth value of the face at which the ray exits the volume. By default, this is set to 0 (off).

See also: SetRenderToImage(), GetDepthImage()

virtual vtkTypeBool vtkGPUVolumeRayCastMapper::GetClampDepthToBackface ( )

virtual

Enable or disable clamping the depth value of the fully transparent voxel to the depth of the back-face of the volume.

This parameter is used when RenderToImage mode is enabled. When ClampDepthToBackFace is false, the fully transparent voxels will have a value of 1.0 in the depth image. When this is true, the fully transparent voxels will have the depth value of the face at which the ray exits the volume. By default, this is set to 0 (off).

See also: SetRenderToImage(), GetDepthImage()

virtual void vtkGPUVolumeRayCastMapper::ClampDepthToBackfaceOn ( )

virtual

Enable or disable clamping the depth value of the fully transparent voxel to the depth of the back-face of the volume.

This parameter is used when RenderToImage mode is enabled. When ClampDepthToBackFace is false, the fully transparent voxels will have a value of 1.0 in the depth image. When this is true, the fully transparent voxels will have the depth value of the face at which the ray exits the volume. By default, this is set to 0 (off).

See also: SetRenderToImage(), GetDepthImage()

virtual void vtkGPUVolumeRayCastMapper::ClampDepthToBackfaceOff ( )

virtual

Enable or disable clamping the depth value of the fully transparent voxel to the depth of the back-face of the volume.

This parameter is used when RenderToImage mode is enabled. When ClampDepthToBackFace is false, the fully transparent voxels will have a value of 1.0 in the depth image. When this is true, the fully transparent voxels will have the depth value of the face at which the ray exits the volume. By default, this is set to 0 (off).

See also: SetRenderToImage(), GetDepthImage()

virtual void vtkGPUVolumeRayCastMapper::GetDepthImage ( vtkImageData * )

inlinevirtual

Low level API to export the depth texture as vtkImageData in RenderToImage mode.

Should be implemented by the graphics API specific mapper (GL or other).

See also: SetRenderToImage()

Reimplemented in vtkOpenGLGPUVolumeRayCastMapper.

Definition at line 327 of file vtkGPUVolumeRayCastMapper.h.

virtual void vtkGPUVolumeRayCastMapper::GetColorImage ( vtkImageData * )

inlinevirtual

Low level API to export the color texture as vtkImageData in RenderToImage mode.

Should be implemented by the graphics API specific mapper (GL or other).

See also: SetRenderToImage()

Reimplemented in vtkOpenGLGPUVolumeRayCastMapper.

Definition at line 335 of file vtkGPUVolumeRayCastMapper.h.

void vtkGPUVolumeRayCastMapper::Render	(	vtkRenderer *	,
		vtkVolume *
	)

overridevirtual

Initialize rendering for this volume.

Warning: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE

Implements vtkVolumeMapper.

virtual void vtkGPUVolumeRayCastMapper::GPURender	(	vtkRenderer *	,
		vtkVolume *
	)

inlinevirtual

Handled in the subclass - the actual render method.

Precondition: input is up-to-date.

Reimplemented in vtkOpenGLGPUVolumeRayCastMapper.

Definition at line 347 of file vtkGPUVolumeRayCastMapper.h.

void vtkGPUVolumeRayCastMapper::ReleaseGraphicsResources ( vtkWindow * )

inlineoverridevirtual

Release any graphics resources that are being consumed by this mapper.

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

Warning: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE

Reimplemented from vtkAbstractVolumeMapper.

Reimplemented in vtkOpenGLGPUVolumeRayCastMapper.

Definition at line 355 of file vtkGPUVolumeRayCastMapper.h.

virtual void vtkGPUVolumeRayCastMapper::GetReductionRatio ( double ratio[3] )

pure virtual

Return how much the dataset has to be reduced in each dimension to fit on the GPU.

If the value is 1.0, there is no need to reduce the dataset.

Precondition: the calling thread has a current OpenGL context.; mapper_supported: IsRenderSupported(renderer->GetRenderWindow(),0) The computation is based on hardware limits (3D texture indexable size) and MaxMemoryInBytes.

Postcondition: valid_i_ratio: ratio[0]>0 && ratio[0]<=1.0; valid_j_ratio: ratio[1]>0 && ratio[1]<=1.0; valid_k_ratio: ratio[2]>0 && ratio[2]<=1.0

virtual void vtkGPUVolumeRayCastMapper::SetColorRangeType ( int )

virtual