vtkKWVolumePropertyHelper Class Reference

a render widget for volumes More...

#include <vtkKWVolumePropertyHelper.h>

Inheritance diagram for vtkKWVolumePropertyHelper:
Inheritance graph
[legend]
Collaboration diagram for vtkKWVolumePropertyHelper:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)

Static Public Member Functions

static vtkKWVolumePropertyHelper * New ()
static int IsTypeOf (const char *type)
static vtkKWVolumePropertyHelper * SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkKWVolumePropertyHelper ()
 ~vtkKWVolumePropertyHelper ()



enum  { ScalarOpacityRamp0At0To20At100 = 0, ScalarOpacityRamp0At25To100At50, ScalarOpacityRamp0At50To100At75, ScalarOpacitySteps0To25Then20To50Then40To75Then100To100 }
enum  { RGBTransferFunctionRampAt0At100 = 0, RGBTransferFunctionRampAt0At70At100, RGBTransferFunctionStepsTo25To50To75To100 }
enum  { GradientOpacityNoEdge = 0, GradientOpacityMediumEdge, GradientOpacityStrongEdge }
enum  { LightingFullAmbient = 0, LightingDull, LightingSmooth, LightingShiny }
enum  {
  Preset1 = 0, Preset2, Preset3, Preset4,
  Preset5, Preset6
}
enum  {
  Black = 0, White, Gray3, Red,
  Green, Blue, Yellow, Magenta,
  Cyan, Tan
}
enum  { CopySkipOpacityUnitDistance = 1, CopySkipIndependentComponents = 2 }
static void ApplyScalarOpacityPreset (vtkVolumeProperty *prop, int comp, int preset)
static void ApplyRGBTransferFunctionPreset (vtkVolumeProperty *prop, int comp, int preset, int nb_colors, double **rgb)
static void ApplyRGBTransferFunctionPreset (vtkVolumeProperty *prop, int comp, int preset, double rgb[3])
static void ApplyRGBTransferFunctionPreset (vtkVolumeProperty *prop, int comp, int preset, double rgb1[3], double rgb2[3])
static void ApplyRGBTransferFunctionPreset (vtkVolumeProperty *prop, int comp, int preset, double rgb1[3], double rgb2[3], double rgb3[3])
static void ApplyRGBTransferFunctionPreset (vtkVolumeProperty *prop, int comp, int preset, double rgb1[3], double rgb2[3], double rgb3[3], double rgb4[3])
static void ApplyGradientOpacityPreset (vtkVolumeProperty *prop, int comp, int preset)
static void ApplyLightingPreset (vtkVolumeProperty *prop, int comp, int preset)
static void ApplyPreset (vtkVolumeProperty *prop, int preset)
static double * GetRGBColor (int preset)
static void ConvertNormalizedRange (vtkVolumeProperty *normalized_prop, vtkVolumeProperty *target_prop, vtkImageData *image, int independent_component, vtkKWHistogramSet *histogram_set)
static void ApplyPresetAndConvertNormalizedRange (int preset, vtkVolumeProperty *target_prop, vtkImageData *image, int independent_component, vtkKWHistogramSet *histogram_set)
static void DeepCopyVolumeProperty (vtkVolumeProperty *target, vtkVolumeProperty *source)
static void CopyVolumeProperty (vtkVolumeProperty *target, vtkVolumeProperty *source, int options)

Detailed Description

a render widget for volumes

Definition at line 37 of file vtkKWVolumePropertyHelper.h.

Member Typedef Documentation

typedef vtkObject vtkKWVolumePropertyHelper::Superclass

Reimplemented from vtkObject.

Definition at line 42 of file vtkKWVolumePropertyHelper.h.

Member Enumeration Documentation

anonymous enum

Apply a normalized scalar opacity preset to a specific component Such normalized values can later be converted to real scalar values given an image data and/or an histogram (see ConvertNormalizedToReal). BTX

Enumerator:
ScalarOpacityRamp0At0To20At100 
ScalarOpacityRamp0At25To100At50 
ScalarOpacityRamp0At50To100At75 
ScalarOpacitySteps0To25Then20To50Then40To75Then100To100 

Definition at line 49 of file vtkKWVolumePropertyHelper.h.

anonymous enum

Apply a normalized color transfer function preset to a specific component. Such normalized values can later be converted to real scalar values given an image data and/or an histogram (see ConvertNormalizedToReal). Some presets will set 2, 3, 4 or more color points. You can specify any number of colors though, the missing ones will be picked/rotated from the one you passed (i.e. if 2 points are created and one color is provided, the same color will be used at both locations). Convenience methods are provided to pass one, two, three or four RGB color(s) directly instead of an array of RGB colors (i.e. an array of double triplets). BTX

Enumerator:
RGBTransferFunctionRampAt0At100 
RGBTransferFunctionRampAt0At70At100 
RGBTransferFunctionStepsTo25To50To75To100 

Definition at line 80 of file vtkKWVolumePropertyHelper.h.

anonymous enum

Apply a normalized gradient opacity preset to a specific component Such normalized values can later be converted to real scalar values given an image data and/or an histogram (see ConvertNormalizedToReal). BTX

Enumerator:
GradientOpacityNoEdge 
GradientOpacityMediumEdge 
GradientOpacityStrongEdge 

Definition at line 115 of file vtkKWVolumePropertyHelper.h.

anonymous enum

Apply a lighting preset to a specific component BTX

Enumerator:
LightingFullAmbient 
LightingDull 
LightingSmooth 
LightingShiny 

Definition at line 133 of file vtkKWVolumePropertyHelper.h.

anonymous enum

Apply a normalized preset, i.e. a combination of a scalar opacity preset, a color transfer function preset, a gradient opacity preset and a lighting preset (see ApplyScalarOpacityPreset, ApplyRGBTransferFunctionPreset, ApplyGradientOpacityPreset and ApplyLightingPreset). IMPORTANT: note that the vtkVolumeProperty's IndependentComponenents flag will be taken into account when setting the transfer functions for each components of the property. See ConvertNormalizedRange and/or ApplyPresetAndConvertNormalizedRange to convert the normalized range to real scalar ranges. BTX

Enumerator:
Preset1 
Preset2 
Preset3 
Preset4 
Preset5 
Preset6 

Definition at line 162 of file vtkKWVolumePropertyHelper.h.

anonymous enum

Retrieve some solid color RGB presets. BTX

Enumerator:
Black 
White 
Gray3 
Red 
Green 
Blue 
Yellow 
Magenta 
Cyan 
Tan 

Definition at line 217 of file vtkKWVolumePropertyHelper.h.

anonymous enum

Copy a volume property from source to target, optionally skipping some fields. BTX

Enumerator:
CopySkipOpacityUnitDistance 
CopySkipIndependentComponents 

Definition at line 274 of file vtkKWVolumePropertyHelper.h.

Constructor & Destructor Documentation

vtkKWVolumePropertyHelper::vtkKWVolumePropertyHelper (  )  [inline, protected]

Definition at line 287 of file vtkKWVolumePropertyHelper.h.

vtkKWVolumePropertyHelper::~vtkKWVolumePropertyHelper (  )  [inline, protected]

Definition at line 288 of file vtkKWVolumePropertyHelper.h.

Member Function Documentation

static vtkKWVolumePropertyHelper* vtkKWVolumePropertyHelper::New (  )  [static]

Reimplemented from vtkObject.

virtual const char* vtkKWVolumePropertyHelper::GetClassName (  )  [virtual]

Reimplemented from vtkObject.

static int vtkKWVolumePropertyHelper::IsTypeOf ( const char *  type  )  [static]

Reimplemented from vtkObject.

virtual int vtkKWVolumePropertyHelper::IsA ( const char *  type  )  [virtual]

Reimplemented from vtkObject.

static vtkKWVolumePropertyHelper* vtkKWVolumePropertyHelper::SafeDownCast ( vtkObject *  o  )  [static]
void vtkKWVolumePropertyHelper::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Reimplemented from vtkObject.

static void vtkKWVolumePropertyHelper::ApplyScalarOpacityPreset ( vtkVolumeProperty *  prop,
int  comp,
int  preset 
) [static]

Apply a normalized scalar opacity preset to a specific component Such normalized values can later be converted to real scalar values given an image data and/or an histogram (see ConvertNormalizedToReal). BTX

static void vtkKWVolumePropertyHelper::ApplyRGBTransferFunctionPreset ( vtkVolumeProperty *  prop,
int  comp,
int  preset,
int  nb_colors,
double **  rgb 
) [static]

Apply a normalized scalar opacity preset to a specific component Such normalized values can later be converted to real scalar values given an image data and/or an histogram (see ConvertNormalizedToReal). BTX

static void vtkKWVolumePropertyHelper::ApplyRGBTransferFunctionPreset ( vtkVolumeProperty *  prop,
int  comp,
int  preset,
double  rgb[3] 
) [static]

Apply a normalized scalar opacity preset to a specific component Such normalized values can later be converted to real scalar values given an image data and/or an histogram (see ConvertNormalizedToReal). BTX

static void vtkKWVolumePropertyHelper::ApplyRGBTransferFunctionPreset ( vtkVolumeProperty *  prop,
int  comp,
int  preset,
double  rgb1[3],
double  rgb2[3] 
) [static]

Apply a normalized scalar opacity preset to a specific component Such normalized values can later be converted to real scalar values given an image data and/or an histogram (see ConvertNormalizedToReal). BTX

static void vtkKWVolumePropertyHelper::ApplyRGBTransferFunctionPreset ( vtkVolumeProperty *  prop,
int  comp,
int  preset,
double  rgb1[3],
double  rgb2[3],
double  rgb3[3] 
) [static]

Apply a normalized scalar opacity preset to a specific component Such normalized values can later be converted to real scalar values given an image data and/or an histogram (see ConvertNormalizedToReal). BTX

static void vtkKWVolumePropertyHelper::ApplyRGBTransferFunctionPreset ( vtkVolumeProperty *  prop,
int  comp,
int  preset,
double  rgb1[3],
double  rgb2[3],
double  rgb3[3],
double  rgb4[3] 
) [static]

Apply a normalized scalar opacity preset to a specific component Such normalized values can later be converted to real scalar values given an image data and/or an histogram (see ConvertNormalizedToReal). BTX

static void vtkKWVolumePropertyHelper::ApplyGradientOpacityPreset ( vtkVolumeProperty *  prop,
int  comp,
int  preset 
) [static]

Apply a normalized scalar opacity preset to a specific component Such normalized values can later be converted to real scalar values given an image data and/or an histogram (see ConvertNormalizedToReal). BTX

static void vtkKWVolumePropertyHelper::ApplyLightingPreset ( vtkVolumeProperty *  prop,
int  comp,
int  preset 
) [static]

Apply a normalized scalar opacity preset to a specific component Such normalized values can later be converted to real scalar values given an image data and/or an histogram (see ConvertNormalizedToReal). BTX

static void vtkKWVolumePropertyHelper::ApplyPreset ( vtkVolumeProperty *  prop,
int  preset 
) [static]

Apply a normalized scalar opacity preset to a specific component Such normalized values can later be converted to real scalar values given an image data and/or an histogram (see ConvertNormalizedToReal). BTX

static double* vtkKWVolumePropertyHelper::GetRGBColor ( int  preset  )  [static]

Apply a normalized scalar opacity preset to a specific component Such normalized values can later be converted to real scalar values given an image data and/or an histogram (see ConvertNormalizedToReal). BTX

static void vtkKWVolumePropertyHelper::ConvertNormalizedRange ( vtkVolumeProperty *  normalized_prop,
vtkVolumeProperty *  target_prop,
vtkImageData *  image,
int  independent_component,
vtkKWHistogramSet *  histogram_set 
) [static]

Convert a normalized volume property to real scalar ranges. The contents of normalized_prop is entirely deep-copied to target_prop (EXCEPT the ScalarOpacityUnitDistance). The points are all moved from normalized space to real scalar ranges computed either from the image's data range or from its histogram (if any).

static void vtkKWVolumePropertyHelper::ApplyPresetAndConvertNormalizedRange ( int  preset,
vtkVolumeProperty *  target_prop,
vtkImageData *  image,
int  independent_component,
vtkKWHistogramSet *  histogram_set 
) [static]

Convenience method that will create a temporary volume property, use ApplyPreset to convert it to a normalized preset, then convert its normalized values to real scalar ranges by calling ConvertNormalizedRange. The points are all moved from normalized space to real scalar ranges computed either from the image's data range or from its histogram (if any).

static void vtkKWVolumePropertyHelper::DeepCopyVolumeProperty ( vtkVolumeProperty *  target,
vtkVolumeProperty *  source 
) [static]

Deep copy a volume property from source to target.

static void vtkKWVolumePropertyHelper::CopyVolumeProperty ( vtkVolumeProperty *  target,
vtkVolumeProperty *  source,
int  options 
) [static]

Apply a normalized scalar opacity preset to a specific component Such normalized values can later be converted to real scalar values given an image data and/or an histogram (see ConvertNormalizedToReal). BTX

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Tue Apr 27 02:38:56 2010 for KWWidgets by  doxygen 1.6.1