VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkImageProperty Class Reference

image display properties More...

#include <vtkImageProperty.h>

Inheritance diagram for vtkImageProperty:
Inheritance graph
[legend]
Collaboration diagram for vtkImageProperty:
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)
void DeepCopy (vtkImageProperty *p)
unsigned long GetMTime ()
virtual void SetColorWindow (double)
virtual double GetColorWindow ()
virtual void SetColorLevel (double)
virtual double GetColorLevel ()
virtual void SetLookupTable (vtkScalarsToColors *lut)
virtual vtkScalarsToColorsGetLookupTable ()
virtual void SetUseLookupTableScalarRange (int)
virtual int GetUseLookupTableScalarRange ()
virtual void UseLookupTableScalarRangeOn ()
virtual void UseLookupTableScalarRangeOff ()
virtual void SetOpacity (double)
virtual double GetOpacity ()
virtual void SetAmbient (double)
virtual double GetAmbient ()
virtual void SetDiffuse (double)
virtual double GetDiffuse ()
virtual void SetInterpolationType (int)
virtual int GetInterpolationType ()
void SetInterpolationTypeToNearest ()
void SetInterpolationTypeToLinear ()
void SetInterpolationTypeToCubic ()
virtual const char * GetInterpolationTypeAsString ()
virtual void SetLayerNumber (int)
int GetLayerNumber ()
virtual void SetCheckerboard (int)
virtual void CheckerboardOn ()
virtual void CheckerboardOff ()
virtual int GetCheckerboard ()
virtual void SetCheckerboardSpacing (double, double)
void SetCheckerboardSpacing (double[2])
virtual doubleGetCheckerboardSpacing ()
virtual void GetCheckerboardSpacing (double &, double &)
virtual void GetCheckerboardSpacing (double[2])
virtual void SetCheckerboardOffset (double, double)
void SetCheckerboardOffset (double[2])
virtual doubleGetCheckerboardOffset ()
virtual void GetCheckerboardOffset (double &, double &)
virtual void GetCheckerboardOffset (double[2])
virtual void SetBacking (int)
virtual void BackingOn ()
virtual void BackingOff ()
virtual int GetBacking ()
virtual void SetBackingColor (double, double, double)
virtual void SetBackingColor (double[3])
virtual doubleGetBackingColor ()
virtual void GetBackingColor (double &, double &, double &)
virtual void GetBackingColor (double[3])

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkImagePropertySafeDownCast (vtkObject *o)
static vtkImagePropertyNew ()

Protected Member Functions

 vtkImageProperty ()
 ~vtkImageProperty ()

Protected Attributes

vtkScalarsToColorsLookupTable
double ColorWindow
double ColorLevel
int UseLookupTableScalarRange
int InterpolationType
int LayerNumber
double Opacity
double Ambient
double Diffuse
int Checkerboard
double CheckerboardSpacing [2]
double CheckerboardOffset [2]
int Backing
double BackingColor [3]

Detailed Description

image display properties

vtkImageProperty is an object that allows control of the display of an image slice.

Thanks:
Thanks to David Gobbi at the Seaman Family MR Centre and Dept. of Clinical Neurosciences, Foothills Medical Centre, Calgary, for providing this class.
See also:
vtkImage vtkImageMapper3D vtkImageSliceMapper vtkImageResliceMapper
Examples:
vtkImageProperty (Examples)
Tests:
vtkImageProperty (Tests)

Definition at line 40 of file vtkImageProperty.h.


Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 43 of file vtkImageProperty.h.


Constructor & Destructor Documentation

vtkImageProperty::vtkImageProperty ( ) [protected]
vtkImageProperty::~vtkImageProperty ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkObject.

static int vtkImageProperty::IsTypeOf ( const char *  name) [static]

Return 1 if this class type 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 vtkObject.

virtual int vtkImageProperty::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 vtkObject.

static vtkImageProperty* vtkImageProperty::SafeDownCast ( vtkObject o) [static]

Reimplemented from vtkObject.

void vtkImageProperty::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

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

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

Construct a property with no lookup table.

Reimplemented from vtkObject.

void vtkImageProperty::DeepCopy ( vtkImageProperty p)

Assign one property to another.

virtual void vtkImageProperty::SetColorWindow ( double  ) [virtual]

The window value for window/level.

virtual double vtkImageProperty::GetColorWindow ( ) [virtual]

The window value for window/level.

virtual void vtkImageProperty::SetColorLevel ( double  ) [virtual]

The level value for window/level.

virtual double vtkImageProperty::GetColorLevel ( ) [virtual]

The level value for window/level.

virtual void vtkImageProperty::SetLookupTable ( vtkScalarsToColors lut) [virtual]

Specify a lookup table for the data. If the data is to be displayed as greyscale, or if the input data is already RGB, there is no need to set a lookup table.

virtual vtkScalarsToColors* vtkImageProperty::GetLookupTable ( ) [virtual]

Specify a lookup table for the data. If the data is to be displayed as greyscale, or if the input data is already RGB, there is no need to set a lookup table.

virtual void vtkImageProperty::SetUseLookupTableScalarRange ( int  ) [virtual]

Use the range that is set in the lookup table, instead of setting the range from the Window/Level settings. This is off by default.

virtual int vtkImageProperty::GetUseLookupTableScalarRange ( ) [virtual]

Use the range that is set in the lookup table, instead of setting the range from the Window/Level settings. This is off by default.

virtual void vtkImageProperty::UseLookupTableScalarRangeOn ( ) [virtual]

Use the range that is set in the lookup table, instead of setting the range from the Window/Level settings. This is off by default.

virtual void vtkImageProperty::UseLookupTableScalarRangeOff ( ) [virtual]

Use the range that is set in the lookup table, instead of setting the range from the Window/Level settings. This is off by default.

virtual void vtkImageProperty::SetOpacity ( double  ) [virtual]

The opacity of the image, where 1.0 is opaque and 0.0 is transparent. If the image has an alpha component, then the alpha component will be multiplied by this value.

virtual double vtkImageProperty::GetOpacity ( ) [virtual]

The opacity of the image, where 1.0 is opaque and 0.0 is transparent. If the image has an alpha component, then the alpha component will be multiplied by this value.

virtual void vtkImageProperty::SetAmbient ( double  ) [virtual]

The ambient lighting coefficient. The default is 1.0.

virtual double vtkImageProperty::GetAmbient ( ) [virtual]

The ambient lighting coefficient. The default is 1.0.

virtual void vtkImageProperty::SetDiffuse ( double  ) [virtual]

The diffuse lighting coefficient. The default is 0.0.

virtual double vtkImageProperty::GetDiffuse ( ) [virtual]

The diffuse lighting coefficient. The default is 0.0.

virtual void vtkImageProperty::SetInterpolationType ( int  ) [virtual]

The interpolation type (default: nearest neighbor).

virtual int vtkImageProperty::GetInterpolationType ( ) [virtual]

The interpolation type (default: nearest neighbor).

void vtkImageProperty::SetInterpolationTypeToNearest ( ) [inline]

The interpolation type (default: nearest neighbor).

Definition at line 105 of file vtkImageProperty.h.

void vtkImageProperty::SetInterpolationTypeToLinear ( ) [inline]

The interpolation type (default: nearest neighbor).

Definition at line 107 of file vtkImageProperty.h.

void vtkImageProperty::SetInterpolationTypeToCubic ( ) [inline]

The interpolation type (default: nearest neighbor).

Definition at line 109 of file vtkImageProperty.h.

virtual const char* vtkImageProperty::GetInterpolationTypeAsString ( ) [virtual]

The interpolation type (default: nearest neighbor).

virtual void vtkImageProperty::SetLayerNumber ( int  ) [virtual]

Set the layer number. This is ignored unless the image is part of a vtkImageStack. The default layer number is zero.

int vtkImageProperty::GetLayerNumber ( ) [inline]

Set the layer number. This is ignored unless the image is part of a vtkImageStack. The default layer number is zero.

Definition at line 118 of file vtkImageProperty.h.

virtual void vtkImageProperty::SetCheckerboard ( int  ) [virtual]

Make a checkerboard pattern where the black squares are transparent. The pattern is aligned with the camera, and centered by default.

virtual void vtkImageProperty::CheckerboardOn ( ) [virtual]

Make a checkerboard pattern where the black squares are transparent. The pattern is aligned with the camera, and centered by default.

virtual void vtkImageProperty::CheckerboardOff ( ) [virtual]

Make a checkerboard pattern where the black squares are transparent. The pattern is aligned with the camera, and centered by default.

virtual int vtkImageProperty::GetCheckerboard ( ) [virtual]

Make a checkerboard pattern where the black squares are transparent. The pattern is aligned with the camera, and centered by default.

virtual void vtkImageProperty::SetCheckerboardSpacing ( double  ,
double   
) [virtual]

The spacing for checkerboarding. This is in real units, not pixels.

void vtkImageProperty::SetCheckerboardSpacing ( double  [2])

The spacing for checkerboarding. This is in real units, not pixels.

virtual double* vtkImageProperty::GetCheckerboardSpacing ( ) [virtual]

The spacing for checkerboarding. This is in real units, not pixels.

virtual void vtkImageProperty::GetCheckerboardSpacing ( double ,
double  
) [virtual]

The spacing for checkerboarding. This is in real units, not pixels.

virtual void vtkImageProperty::GetCheckerboardSpacing ( double  [2]) [virtual]

The spacing for checkerboarding. This is in real units, not pixels.

virtual void vtkImageProperty::SetCheckerboardOffset ( double  ,
double   
) [virtual]

The phase offset for checkerboarding, in units of spacing. Use a value between -1 and +1, where 1 is an offset of one squares.

void vtkImageProperty::SetCheckerboardOffset ( double  [2])

The phase offset for checkerboarding, in units of spacing. Use a value between -1 and +1, where 1 is an offset of one squares.

virtual double* vtkImageProperty::GetCheckerboardOffset ( ) [virtual]

The phase offset for checkerboarding, in units of spacing. Use a value between -1 and +1, where 1 is an offset of one squares.

virtual void vtkImageProperty::GetCheckerboardOffset ( double ,
double  
) [virtual]

The phase offset for checkerboarding, in units of spacing. Use a value between -1 and +1, where 1 is an offset of one squares.

virtual void vtkImageProperty::GetCheckerboardOffset ( double  [2]) [virtual]

The phase offset for checkerboarding, in units of spacing. Use a value between -1 and +1, where 1 is an offset of one squares.

virtual void vtkImageProperty::SetBacking ( int  ) [virtual]

Use an opaque backing polygon, which will be visible where the image is translucent. When images are in a stack, the backing polygons for all images will be drawn before any of the images in the stack, in order to allow the images in the stack to be composited.

virtual void vtkImageProperty::BackingOn ( ) [virtual]

Use an opaque backing polygon, which will be visible where the image is translucent. When images are in a stack, the backing polygons for all images will be drawn before any of the images in the stack, in order to allow the images in the stack to be composited.

virtual void vtkImageProperty::BackingOff ( ) [virtual]

Use an opaque backing polygon, which will be visible where the image is translucent. When images are in a stack, the backing polygons for all images will be drawn before any of the images in the stack, in order to allow the images in the stack to be composited.

virtual int vtkImageProperty::GetBacking ( ) [virtual]

Use an opaque backing polygon, which will be visible where the image is translucent. When images are in a stack, the backing polygons for all images will be drawn before any of the images in the stack, in order to allow the images in the stack to be composited.

virtual void vtkImageProperty::SetBackingColor ( double  ,
double  ,
double   
) [virtual]

Set the color of the backing polygon. The default color is black.

virtual void vtkImageProperty::SetBackingColor ( double  [3]) [virtual]

Set the color of the backing polygon. The default color is black.

virtual double* vtkImageProperty::GetBackingColor ( ) [virtual]

Set the color of the backing polygon. The default color is black.

virtual void vtkImageProperty::GetBackingColor ( double ,
double ,
double  
) [virtual]

Set the color of the backing polygon. The default color is black.

virtual void vtkImageProperty::GetBackingColor ( double  [3]) [virtual]

Set the color of the backing polygon. The default color is black.

unsigned long vtkImageProperty::GetMTime ( ) [virtual]

Get the MTime for this property. If the lookup table is set, the mtime will include the mtime of the lookup table.

Reimplemented from vtkObject.


Member Data Documentation

Definition at line 166 of file vtkImageProperty.h.

Definition at line 167 of file vtkImageProperty.h.

Definition at line 168 of file vtkImageProperty.h.

Definition at line 169 of file vtkImageProperty.h.

Definition at line 170 of file vtkImageProperty.h.

Definition at line 171 of file vtkImageProperty.h.

Definition at line 172 of file vtkImageProperty.h.

Definition at line 173 of file vtkImageProperty.h.

Definition at line 174 of file vtkImageProperty.h.

Definition at line 175 of file vtkImageProperty.h.

Definition at line 176 of file vtkImageProperty.h.

Definition at line 177 of file vtkImageProperty.h.

Definition at line 178 of file vtkImageProperty.h.

Definition at line 179 of file vtkImageProperty.h.


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