vtkImageProperty Class Reference

image display properties More...

#include <vtkImageProperty.h>

Inheritance diagram for vtkImageProperty:

Collaboration diagram for vtkImageProperty:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...
vtkImageProperty *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...
void	DeepCopy (vtkImageProperty *p)
	Assign one property to another. More...
virtual void	SetColorWindow (double)
	The window value for window/level. More...
virtual double	GetColorWindow ()
virtual void	SetColorLevel (double)
	The level value for window/level. More...
virtual double	GetColorLevel ()
virtual void	SetLookupTable (vtkScalarsToColors *lut)
	Specify a lookup table for the data. More...
virtual vtkScalarsToColors *	GetLookupTable ()
virtual void	SetUseLookupTableScalarRange (int)
	Use the range that is set in the lookup table, instead of setting the range from the Window/Level settings. More...
virtual int	GetUseLookupTableScalarRange ()
virtual void	UseLookupTableScalarRangeOn ()
virtual void	UseLookupTableScalarRangeOff ()
virtual void	SetOpacity (double)
	The opacity of the image, where 1.0 is opaque and 0.0 is transparent. More...
virtual double	GetOpacity ()
virtual void	SetAmbient (double)
	The ambient lighting coefficient. More...
virtual double	GetAmbient ()
virtual void	SetDiffuse (double)
	The diffuse lighting coefficient. More...
virtual double	GetDiffuse ()
virtual void	SetInterpolationType (int)
	The interpolation type (default: nearest neighbor). More...
virtual int	GetInterpolationType ()
void	SetInterpolationTypeToNearest ()
void	SetInterpolationTypeToLinear ()
void	SetInterpolationTypeToCubic ()
virtual const char *	GetInterpolationTypeAsString ()
virtual void	SetLayerNumber (int)
	Set the layer number. More...
int	GetLayerNumber ()
virtual void	SetCheckerboard (int)
	Make a checkerboard pattern where the black squares are transparent. More...
virtual void	CheckerboardOn ()
virtual void	CheckerboardOff ()
virtual int	GetCheckerboard ()
virtual void	SetCheckerboardSpacing (double, double)
	The spacing for checkerboarding. More...
void	SetCheckerboardSpacing (double[2])
virtual double *	GetCheckerboardSpacing ()
virtual void	GetCheckerboardSpacing (double &, double &)
virtual void	GetCheckerboardSpacing (double[2])
virtual void	SetCheckerboardOffset (double, double)
	The phase offset for checkerboarding, in units of spacing. More...
void	SetCheckerboardOffset (double[2])
virtual double *	GetCheckerboardOffset ()
virtual void	GetCheckerboardOffset (double &, double &)
virtual void	GetCheckerboardOffset (double[2])
virtual void	SetBacking (int)
	Use an opaque backing polygon, which will be visible where the image is translucent. More...
virtual void	BackingOn ()
virtual void	BackingOff ()
virtual int	GetBacking ()
virtual void	SetBackingColor (double, double, double)
	Set the color of the backing polygon. More...
virtual void	SetBackingColor (double[3])
virtual double *	GetBackingColor ()
virtual void	GetBackingColor (double &, double &, double &)
virtual void	GetBackingColor (double[3])
vtkMTimeType	GetMTime ()
	Get the MTime for this property. 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...
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...
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)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
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)
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. 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...
virtual void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). 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...

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkImageProperty *	SafeDownCast (vtkObjectBase *o)
static vtkImageProperty *	New ()
	Construct a property with no lookup table. 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 ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
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 Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkImageProperty ()
	~vtkImageProperty ()
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=NULL)
	These methods allow a command to exclusively grab all events. More...
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkScalarsToColors *	LookupTable
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]
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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 42 of file vtkImageProperty.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkImageProperty::Superclass

Definition at line 45 of file vtkImageProperty.h.

Constructor & Destructor Documentation

vtkImageProperty()

vtkImageProperty::vtkImageProperty ( )

protected

~vtkImageProperty()

vtkImageProperty::~vtkImageProperty ( )

protected

Member Function Documentation

IsTypeOf()

static int vtkImageProperty::IsTypeOf ( const char *  type )

static

IsA()

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

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkImageProperty::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkImageProperty * vtkImageProperty::NewInstance

(

)

const

PrintSelf()

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.

New()

static vtkImageProperty * vtkImageProperty::New ( )

static

Construct a property with no lookup table.

DeepCopy()

void vtkImageProperty::DeepCopy

(

vtkImageProperty *

p

)

Assign one property to another.

SetColorWindow()

virtual void vtkImageProperty::SetColorWindow ( double  )

virtual

The window value for window/level.

GetColorWindow()

virtual double vtkImageProperty::GetColorWindow ( )

virtual

SetColorLevel()

virtual void vtkImageProperty::SetColorLevel ( double  )

virtual

The level value for window/level.

GetColorLevel()

virtual double vtkImageProperty::GetColorLevel ( )

virtual

SetLookupTable()

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.

GetLookupTable()

virtual vtkScalarsToColors * vtkImageProperty::GetLookupTable ( )

virtual

SetUseLookupTableScalarRange()

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.

GetUseLookupTableScalarRange()

virtual int vtkImageProperty::GetUseLookupTableScalarRange ( )

virtual

UseLookupTableScalarRangeOn()

virtual void vtkImageProperty::UseLookupTableScalarRangeOn ( )

virtual

UseLookupTableScalarRangeOff()

virtual void vtkImageProperty::UseLookupTableScalarRangeOff ( )

virtual

SetOpacity()

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.

GetOpacity()

virtual double vtkImageProperty::GetOpacity ( )

virtual

SetAmbient()

virtual void vtkImageProperty::SetAmbient ( double  )

virtual

The ambient lighting coefficient.

The default is 1.0.

GetAmbient()

virtual double vtkImageProperty::GetAmbient ( )

virtual

SetDiffuse()

virtual void vtkImageProperty::SetDiffuse ( double  )

virtual

The diffuse lighting coefficient.

The default is 0.0.

GetDiffuse()

virtual double vtkImageProperty::GetDiffuse ( )

virtual

SetInterpolationType()

virtual void vtkImageProperty::SetInterpolationType ( int  )

virtual

The interpolation type (default: nearest neighbor).

GetInterpolationType()

virtual int vtkImageProperty::GetInterpolationType ( )

virtual

SetInterpolationTypeToNearest()

void vtkImageProperty::SetInterpolationTypeToNearest ( )

inline

Definition at line 128 of file vtkImageProperty.h.

SetInterpolationTypeToLinear()

void vtkImageProperty::SetInterpolationTypeToLinear ( )

inline

Definition at line 130 of file vtkImageProperty.h.

SetInterpolationTypeToCubic()

void vtkImageProperty::SetInterpolationTypeToCubic ( )

inline

Definition at line 132 of file vtkImageProperty.h.

GetInterpolationTypeAsString()

virtual const char * vtkImageProperty::GetInterpolationTypeAsString ( )

virtual

SetLayerNumber()

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.

GetLayerNumber()

int vtkImageProperty::GetLayerNumber ( )

inline

Definition at line 143 of file vtkImageProperty.h.

SetCheckerboard()

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.

CheckerboardOn()

virtual void vtkImageProperty::CheckerboardOn ( )

virtual

CheckerboardOff()

virtual void vtkImageProperty::CheckerboardOff ( )

virtual

GetCheckerboard()

virtual int vtkImageProperty::GetCheckerboard ( )

virtual

SetCheckerboardSpacing() [1/2]

virtual void vtkImageProperty::SetCheckerboardSpacing ( double  , double    )

virtual

The spacing for checkerboarding.

This is in real units, not pixels.

SetCheckerboardSpacing() [2/2]

void vtkImageProperty::SetCheckerboardSpacing

(

double

[2]

)

GetCheckerboardSpacing() [1/3]

virtual double * vtkImageProperty::GetCheckerboardSpacing ( )

virtual

GetCheckerboardSpacing() [2/3]

virtual void vtkImageProperty::GetCheckerboardSpacing ( double &  , double &    )

virtual

GetCheckerboardSpacing() [3/3]

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

virtual

SetCheckerboardOffset() [1/2]

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.

SetCheckerboardOffset() [2/2]

void vtkImageProperty::SetCheckerboardOffset

(

double

[2]

)

GetCheckerboardOffset() [1/3]

virtual double * vtkImageProperty::GetCheckerboardOffset ( )

virtual

GetCheckerboardOffset() [2/3]

virtual void vtkImageProperty::GetCheckerboardOffset ( double &  , double &    )

virtual

GetCheckerboardOffset() [3/3]

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

virtual

SetBacking()

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.

BackingOn()

virtual void vtkImageProperty::BackingOn ( )

virtual

BackingOff()

virtual void vtkImageProperty::BackingOff ( )

virtual

GetBacking()

virtual int vtkImageProperty::GetBacking ( )

virtual

SetBackingColor() [1/2]

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

virtual

Set the color of the backing polygon.

The default color is black.

SetBackingColor() [2/2]

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

virtual

GetBackingColor() [1/3]

virtual double * vtkImageProperty::GetBackingColor ( )

virtual

GetBackingColor() [2/3]

virtual void vtkImageProperty::GetBackingColor ( double &  , double &  , double &    )

virtual

GetBackingColor() [3/3]

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

virtual

GetMTime()

vtkMTimeType 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

LookupTable

vtkScalarsToColors* vtkImageProperty::LookupTable

protected

Definition at line 204 of file vtkImageProperty.h.

ColorWindow

double vtkImageProperty::ColorWindow

protected

Definition at line 205 of file vtkImageProperty.h.

ColorLevel

double vtkImageProperty::ColorLevel

protected

Definition at line 206 of file vtkImageProperty.h.

UseLookupTableScalarRange

int vtkImageProperty::UseLookupTableScalarRange

protected

Definition at line 207 of file vtkImageProperty.h.

InterpolationType

int vtkImageProperty::InterpolationType

protected

Definition at line 208 of file vtkImageProperty.h.

LayerNumber

int vtkImageProperty::LayerNumber

protected

Definition at line 209 of file vtkImageProperty.h.

Opacity

double vtkImageProperty::Opacity

protected

Definition at line 210 of file vtkImageProperty.h.

Ambient

double vtkImageProperty::Ambient

protected

Definition at line 211 of file vtkImageProperty.h.

Diffuse

double vtkImageProperty::Diffuse

protected

Definition at line 212 of file vtkImageProperty.h.

Checkerboard

int vtkImageProperty::Checkerboard

protected

Definition at line 213 of file vtkImageProperty.h.

CheckerboardSpacing

double vtkImageProperty::CheckerboardSpacing[2]

protected

Definition at line 214 of file vtkImageProperty.h.

CheckerboardOffset

double vtkImageProperty::CheckerboardOffset[2]

protected

Definition at line 215 of file vtkImageProperty.h.

Backing

int vtkImageProperty::Backing

protected

Definition at line 216 of file vtkImageProperty.h.

BackingColor

double vtkImageProperty::BackingColor[3]

protected

Definition at line 217 of file vtkImageProperty.h.

---

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

• dox/Rendering/Core/vtkImageProperty.h