ActiViz .NET  5.8.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkGPUVolumeRayCastMapper Class Reference

vtkGPUVolumeRayCastMapper - Ray casting performed on the GPU. More...

Inheritance diagram for Kitware.VTK.vtkGPUVolumeRayCastMapper:
[legend]
Collaboration diagram for Kitware.VTK.vtkGPUVolumeRayCastMapper:
[legend]

List of all members.

Public Types

enum  BinaryMaskType_WrapperEnum { BinaryMaskType = 0, LabelMapMaskType = 1 }
 Optionally, set a mask input. This mask may be a binary mask or a label map. This must be specified via SetMaskType. More...

Public Member Functions

 vtkGPUVolumeRayCastMapper (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkGPUVolumeRayCastMapper ()
 Undocumented Block.
virtual void AutoAdjustSampleDistancesOff ()
 If AutoAdjustSampleDistances is on, the 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 AutoAdjustSampleDistancesOn ()
 If AutoAdjustSampleDistances is on, the 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).
void CreateCanonicalView (vtkRenderer ren, vtkVolume volume, vtkImageData image, int blend_mode, IntPtr viewDirection, IntPtr viewUp)
 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.
virtual void GPURender (vtkRenderer arg0, vtkVolume arg1)
 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 tranfer function. The default value is 1.0.
virtual int GetAutoAdjustSampleDistances ()
 If AutoAdjustSampleDistances is on, the 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 int GetAutoAdjustSampleDistancesMaxValue ()
 If AutoAdjustSampleDistances is on, the 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 int GetAutoAdjustSampleDistancesMinValue ()
 If AutoAdjustSampleDistances is on, the 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 float GetFinalColorLevel ()
 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 GetFinalColorWindow ()
 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 GetImageSampleDistance ()
 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 GetImageSampleDistanceMaxValue ()
 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 GetImageSampleDistanceMinValue ()
 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 GetMaskBlendFactor ()
 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 tranfer function. The default value is 1.0.
virtual float GetMaskBlendFactorMaxValue ()
 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 tranfer function. The default value is 1.0.
virtual float GetMaskBlendFactorMinValue ()
 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 tranfer function. The default value is 1.0.
virtual vtkImageData GetMaskInput ()
 Optionally, set a mask input. This mask may be a binary mask or a label map. This must be specified via SetMaskType.
virtual int GetMaskType ()
 Set the mask type, if mask is to be used. See documentation for SetMaskInput(). The default is a LabelMapMaskType.
virtual float GetMaxMemoryFraction ()
 Maximum fraction of the MaxMemoryInBytes that should be used to hold the texture. Valid values are 0.1 to 1.0.
virtual float GetMaxMemoryFractionMaxValue ()
 Maximum fraction of the MaxMemoryInBytes that should be used to hold the texture. Valid values are 0.1 to 1.0.
virtual float GetMaxMemoryFractionMinValue ()
 Maximum fraction of the MaxMemoryInBytes that should be used to hold the texture. Valid values are 0.1 to 1.0.
virtual int GetMaxMemoryInBytes ()
 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 float GetMaximumImageSampleDistance ()
 This is the maximum image sample distance allow when the image sample distance is being automatically adjusted.
virtual float GetMaximumImageSampleDistanceMaxValue ()
 This is the maximum image sample distance allow when the image sample distance is being automatically adjusted.
virtual float GetMaximumImageSampleDistanceMinValue ()
 This is the maximum image sample distance allow when the image sample distance is being automatically adjusted.
virtual float GetMinimumImageSampleDistance ()
 This is the minimum image sample distance allow when the image sample distance is being automatically adjusted.
virtual float GetMinimumImageSampleDistanceMaxValue ()
 This is the minimum image sample distance allow when the image sample distance is being automatically adjusted.
virtual float GetMinimumImageSampleDistanceMinValue ()
 This is the minimum image sample distance allow when the image sample distance is being automatically adjusted.
virtual void GetReductionRatio (IntPtr ratio)
 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 tranfer function. The default value is 1.0.
virtual bool GetReportProgress ()
 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 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. Initial value is 1.0.
override int IsA (string type)
 Undocumented Block.
virtual int IsRenderSupported (vtkRenderWindow arg0, vtkVolumeProperty arg1)
 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.
new vtkGPUVolumeRayCastMapper NewInstance ()
 Undocumented Block.
override void ReleaseGraphicsResources (vtkWindow arg0)
 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 tranfer function. The default value is 1.0.
override void Render (vtkRenderer arg0, vtkVolume arg1)
 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 tranfer function. The default value is 1.0.
virtual void SetAutoAdjustSampleDistances (int _arg)
 If AutoAdjustSampleDistances is on, the 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 SetFinalColorLevel (float _arg)
 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 SetFinalColorWindow (float _arg)
 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 SetImageSampleDistance (float _arg)
 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 SetMaskBlendFactor (float _arg)
 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 tranfer function. The default value is 1.0.
void 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.
virtual void SetMaskType (int _arg)
 Set the mask type, if mask is to be used. See documentation for SetMaskInput(). The default is a LabelMapMaskType.
void SetMaskTypeToBinary ()
 Set the mask type, if mask is to be used. See documentation for SetMaskInput(). The default is a LabelMapMaskType.
void SetMaskTypeToLabelMap ()
 Set the mask type, if mask is to be used. See documentation for SetMaskInput(). The default is a LabelMapMaskType.
virtual void SetMaxMemoryFraction (float _arg)
 Maximum fraction of the MaxMemoryInBytes that should be used to hold the texture. Valid values are 0.1 to 1.0.
virtual void SetMaxMemoryInBytes (int _arg)
 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 SetMaximumImageSampleDistance (float _arg)
 This is the maximum image sample distance allow when the image sample distance is being automatically adjusted.
virtual void SetMinimumImageSampleDistance (float _arg)
 This is the minimum image sample distance allow when the image sample distance is being automatically adjusted.
virtual void SetReportProgress (bool _arg)
 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 void SetSampleDistance (float _arg)
 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.

Static Public Member Functions

static new
vtkGPUVolumeRayCastMapper 
New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new
vtkGPUVolumeRayCastMapper 
SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkGPUVolumeRayCastMapper"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "25vtkGPUVolumeRayCastMapper"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkGPUVolumeRayCastMapper_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkGPUVolumeRayCastMapper_AutoAdjustSampleDistancesOff_01 (HandleRef pThis)
static internal void vtkGPUVolumeRayCastMapper_AutoAdjustSampleDistancesOn_02 (HandleRef pThis)
static internal void vtkGPUVolumeRayCastMapper_CreateCanonicalView_03 (HandleRef pThis, HandleRef ren, HandleRef volume, HandleRef image, int blend_mode, IntPtr viewDirection, IntPtr viewUp)
static internal void vtkGPUVolumeRayCastMapper_GPURender_04 (HandleRef pThis, HandleRef arg0, HandleRef arg1)
static internal int vtkGPUVolumeRayCastMapper_GetAutoAdjustSampleDistances_05 (HandleRef pThis)
static internal int vtkGPUVolumeRayCastMapper_GetAutoAdjustSampleDistancesMaxValue_06 (HandleRef pThis)
static internal int vtkGPUVolumeRayCastMapper_GetAutoAdjustSampleDistancesMinValue_07 (HandleRef pThis)
static internal float vtkGPUVolumeRayCastMapper_GetFinalColorLevel_08 (HandleRef pThis)
static internal float vtkGPUVolumeRayCastMapper_GetFinalColorWindow_09 (HandleRef pThis)
static internal float vtkGPUVolumeRayCastMapper_GetImageSampleDistance_10 (HandleRef pThis)
static internal float vtkGPUVolumeRayCastMapper_GetImageSampleDistanceMaxValue_11 (HandleRef pThis)
static internal float vtkGPUVolumeRayCastMapper_GetImageSampleDistanceMinValue_12 (HandleRef pThis)
static internal float vtkGPUVolumeRayCastMapper_GetMaskBlendFactor_13 (HandleRef pThis)
static internal float vtkGPUVolumeRayCastMapper_GetMaskBlendFactorMaxValue_14 (HandleRef pThis)
static internal float vtkGPUVolumeRayCastMapper_GetMaskBlendFactorMinValue_15 (HandleRef pThis)
static internal IntPtr vtkGPUVolumeRayCastMapper_GetMaskInput_16 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkGPUVolumeRayCastMapper_GetMaskType_17 (HandleRef pThis)
static internal float vtkGPUVolumeRayCastMapper_GetMaxMemoryFraction_18 (HandleRef pThis)
static internal float vtkGPUVolumeRayCastMapper_GetMaxMemoryFractionMaxValue_19 (HandleRef pThis)
static internal float vtkGPUVolumeRayCastMapper_GetMaxMemoryFractionMinValue_20 (HandleRef pThis)
static internal int vtkGPUVolumeRayCastMapper_GetMaxMemoryInBytes_21 (HandleRef pThis)
static internal float vtkGPUVolumeRayCastMapper_GetMaximumImageSampleDistance_22 (HandleRef pThis)
static internal float vtkGPUVolumeRayCastMapper_GetMaximumImageSampleDistanceMaxValue_23 (HandleRef pThis)
static internal float vtkGPUVolumeRayCastMapper_GetMaximumImageSampleDistanceMinValue_24 (HandleRef pThis)
static internal float vtkGPUVolumeRayCastMapper_GetMinimumImageSampleDistance_25 (HandleRef pThis)
static internal float vtkGPUVolumeRayCastMapper_GetMinimumImageSampleDistanceMaxValue_26 (HandleRef pThis)
static internal float vtkGPUVolumeRayCastMapper_GetMinimumImageSampleDistanceMinValue_27 (HandleRef pThis)
static internal void vtkGPUVolumeRayCastMapper_GetReductionRatio_28 (HandleRef pThis, IntPtr ratio)
static internal byte vtkGPUVolumeRayCastMapper_GetReportProgress_29 (HandleRef pThis)
static internal float vtkGPUVolumeRayCastMapper_GetSampleDistance_30 (HandleRef pThis)
static internal int vtkGPUVolumeRayCastMapper_IsA_31 (HandleRef pThis, string type)
static internal int vtkGPUVolumeRayCastMapper_IsRenderSupported_32 (HandleRef pThis, HandleRef arg0, HandleRef arg1)
static internal int vtkGPUVolumeRayCastMapper_IsTypeOf_33 (string type)
static internal IntPtr vtkGPUVolumeRayCastMapper_NewInstance_35 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkGPUVolumeRayCastMapper_ReleaseGraphicsResources_36 (HandleRef pThis, HandleRef arg0)
static internal void vtkGPUVolumeRayCastMapper_Render_37 (HandleRef pThis, HandleRef arg0, HandleRef arg1)
static internal IntPtr vtkGPUVolumeRayCastMapper_SafeDownCast_38 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkGPUVolumeRayCastMapper_SetAutoAdjustSampleDistances_39 (HandleRef pThis, int _arg)
static internal void vtkGPUVolumeRayCastMapper_SetFinalColorLevel_40 (HandleRef pThis, float _arg)
static internal void vtkGPUVolumeRayCastMapper_SetFinalColorWindow_41 (HandleRef pThis, float _arg)
static internal void vtkGPUVolumeRayCastMapper_SetImageSampleDistance_42 (HandleRef pThis, float _arg)
static internal void vtkGPUVolumeRayCastMapper_SetMaskBlendFactor_43 (HandleRef pThis, float _arg)
static internal void vtkGPUVolumeRayCastMapper_SetMaskInput_44 (HandleRef pThis, HandleRef mask)
static internal void vtkGPUVolumeRayCastMapper_SetMaskType_45 (HandleRef pThis, int _arg)
static internal void vtkGPUVolumeRayCastMapper_SetMaskTypeToBinary_46 (HandleRef pThis)
static internal void vtkGPUVolumeRayCastMapper_SetMaskTypeToLabelMap_47 (HandleRef pThis)
static internal void vtkGPUVolumeRayCastMapper_SetMaxMemoryFraction_48 (HandleRef pThis, float _arg)
static internal void vtkGPUVolumeRayCastMapper_SetMaxMemoryInBytes_49 (HandleRef pThis, int _arg)
static internal void vtkGPUVolumeRayCastMapper_SetMaximumImageSampleDistance_50 (HandleRef pThis, float _arg)
static internal void vtkGPUVolumeRayCastMapper_SetMinimumImageSampleDistance_51 (HandleRef pThis, float _arg)
static internal void vtkGPUVolumeRayCastMapper_SetReportProgress_52 (HandleRef pThis, byte _arg)
static internal void vtkGPUVolumeRayCastMapper_SetSampleDistance_53 (HandleRef pThis, float _arg)

Static Private Member Functions

static vtkGPUVolumeRayCastMapper ()
 Automatically generated type registration mechanics.

Detailed Description

vtkGPUVolumeRayCastMapper - Ray casting performed on the GPU.

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


Member Enumeration Documentation

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.

Enumerator:
BinaryMaskType 

enum member

LabelMapMaskType 

enum member


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

If AutoAdjustSampleDistances is on, the 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).

If AutoAdjustSampleDistances is on, the 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).

void Kitware.VTK.vtkGPUVolumeRayCastMapper.CreateCanonicalView ( vtkRenderer  ren,
vtkVolume  volume,
vtkImageData  image,
int  blend_mode,
IntPtr  viewDirection,
IntPtr  viewUp 
)

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.

override void Kitware.VTK.vtkGPUVolumeRayCastMapper.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkVolumeMapper.

Reimplemented in Kitware.VTK.vtkOpenGLGPUVolumeRayCastMapper.

If AutoAdjustSampleDistances is on, the 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).

If AutoAdjustSampleDistances is on, the 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).

If AutoAdjustSampleDistances is on, the 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).

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.

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.

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.

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.

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.

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 tranfer function. The default value is 1.0.

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 tranfer function. The default value is 1.0.

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 tranfer function. The default value is 1.0.

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.

Here is the call graph for this function:

Set the mask type, if mask is to be used. See documentation for SetMaskInput(). The default is a LabelMapMaskType.

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

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

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

Maximum fraction of the MaxMemoryInBytes that should be used to hold the texture. Valid values are 0.1 to 1.0.

Maximum fraction of the MaxMemoryInBytes that should be used to hold the texture. Valid values are 0.1 to 1.0.

Maximum fraction of the MaxMemoryInBytes that should be used to hold the texture. Valid values are 0.1 to 1.0.

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.

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

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

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

virtual void Kitware.VTK.vtkGPUVolumeRayCastMapper.GetReductionRatio ( IntPtr  ratio) [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 tranfer function. The default value is 1.0.

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.

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 Kitware.VTK.vtkGPUVolumeRayCastMapper.GPURender ( vtkRenderer  arg0,
vtkVolume  arg1 
) [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 tranfer function. The default value is 1.0.

override int Kitware.VTK.vtkGPUVolumeRayCastMapper.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkVolumeMapper.

Reimplemented in Kitware.VTK.vtkOpenGLGPUVolumeRayCastMapper.

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 Kitware.VTK.vtkOpenGLGPUVolumeRayCastMapper.

static new int Kitware.VTK.vtkGPUVolumeRayCastMapper.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkVolumeMapper.

Reimplemented in Kitware.VTK.vtkOpenGLGPUVolumeRayCastMapper.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAlgorithm.

Reimplemented in Kitware.VTK.vtkOpenGLGPUVolumeRayCastMapper.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkVolumeMapper.

Reimplemented in Kitware.VTK.vtkOpenGLGPUVolumeRayCastMapper.

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 tranfer function. The default value is 1.0.

Reimplemented from Kitware.VTK.vtkVolumeMapper.

Reimplemented in Kitware.VTK.vtkOpenGLGPUVolumeRayCastMapper.

override void Kitware.VTK.vtkGPUVolumeRayCastMapper.Render ( vtkRenderer  arg0,
vtkVolume  arg1 
) [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 tranfer function. The default value is 1.0.

Reimplemented from Kitware.VTK.vtkVolumeMapper.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkVolumeMapper.

Reimplemented in Kitware.VTK.vtkOpenGLGPUVolumeRayCastMapper.

Here is the call graph for this function:

If AutoAdjustSampleDistances is on, the 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 Kitware.VTK.vtkGPUVolumeRayCastMapper.SetFinalColorLevel ( float  _arg) [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 Kitware.VTK.vtkGPUVolumeRayCastMapper.SetFinalColorWindow ( float  _arg) [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 Kitware.VTK.vtkGPUVolumeRayCastMapper.SetImageSampleDistance ( float  _arg) [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 Kitware.VTK.vtkGPUVolumeRayCastMapper.SetMaskBlendFactor ( float  _arg) [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 tranfer function. The default value is 1.0.

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 Kitware.VTK.vtkGPUVolumeRayCastMapper.SetMaskType ( int  _arg) [virtual]

Set the mask type, if mask is to be used. See documentation for SetMaskInput(). The default is a LabelMapMaskType.

Set the mask type, if mask is to be used. See documentation for SetMaskInput(). The default is a LabelMapMaskType.

Set the mask type, if mask is to be used. See documentation for SetMaskInput(). The default is a LabelMapMaskType.

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

virtual void Kitware.VTK.vtkGPUVolumeRayCastMapper.SetMaxMemoryFraction ( float  _arg) [virtual]

Maximum fraction of the MaxMemoryInBytes that should be used to hold the texture. Valid values are 0.1 to 1.0.

virtual void Kitware.VTK.vtkGPUVolumeRayCastMapper.SetMaxMemoryInBytes ( int  _arg) [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.

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

virtual void Kitware.VTK.vtkGPUVolumeRayCastMapper.SetReportProgress ( bool  _arg) [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 void Kitware.VTK.vtkGPUVolumeRayCastMapper.SetSampleDistance ( float  _arg) [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.

static internal void Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_CreateCanonicalView_03 ( HandleRef  pThis,
HandleRef  ren,
HandleRef  volume,
HandleRef  image,
int  blend_mode,
IntPtr  viewDirection,
IntPtr  viewUp 
) [private]
static internal IntPtr Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_GetMaskInput_16 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_GetMaskType_17 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_GetReductionRatio_28 ( HandleRef  pThis,
IntPtr  ratio 
) [private]
static internal void Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_GPURender_04 ( HandleRef  pThis,
HandleRef  arg0,
HandleRef  arg1 
) [private]
static internal int Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_IsA_31 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_IsRenderSupported_32 ( HandleRef  pThis,
HandleRef  arg0,
HandleRef  arg1 
) [private]
static internal IntPtr Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_NewInstance_35 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_ReleaseGraphicsResources_36 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_Render_37 ( HandleRef  pThis,
HandleRef  arg0,
HandleRef  arg1 
) [private]
static internal IntPtr Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_SafeDownCast_38 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_SetAutoAdjustSampleDistances_39 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_SetFinalColorLevel_40 ( HandleRef  pThis,
float  _arg 
) [private]
static internal void Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_SetFinalColorWindow_41 ( HandleRef  pThis,
float  _arg 
) [private]
static internal void Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_SetImageSampleDistance_42 ( HandleRef  pThis,
float  _arg 
) [private]
static internal void Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_SetMaskBlendFactor_43 ( HandleRef  pThis,
float  _arg 
) [private]
static internal void Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_SetMaskInput_44 ( HandleRef  pThis,
HandleRef  mask 
) [private]
static internal void Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_SetMaskType_45 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_SetMaximumImageSampleDistance_50 ( HandleRef  pThis,
float  _arg 
) [private]
static internal void Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_SetMaxMemoryFraction_48 ( HandleRef  pThis,
float  _arg 
) [private]
static internal void Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_SetMaxMemoryInBytes_49 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_SetMinimumImageSampleDistance_51 ( HandleRef  pThis,
float  _arg 
) [private]
static internal void Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_SetReportProgress_52 ( HandleRef  pThis,
byte  _arg 
) [private]
static internal void Kitware.VTK.vtkGPUVolumeRayCastMapper.vtkGPUVolumeRayCastMapper_SetSampleDistance_53 ( HandleRef  pThis,
float  _arg 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkGPUVolumeRayCastMapper.MRClassNameKey = "25vtkGPUVolumeRayCastMapper" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkVolumeMapper.

Reimplemented in Kitware.VTK.vtkOpenGLGPUVolumeRayCastMapper.

new const string Kitware.VTK.vtkGPUVolumeRayCastMapper.MRFullTypeName = "Kitware.VTK.vtkGPUVolumeRayCastMapper"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkVolumeMapper.

Reimplemented in Kitware.VTK.vtkOpenGLGPUVolumeRayCastMapper.


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