VTK  9.0.20201125
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkImageProperty Class Reference

image display properties More...

#include <vtkImageProperty.h>

Inheritance diagram for vtkImageProperty:
[legend]
Collaboration diagram for vtkImageProperty:
[legend]

Public Types

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...
 
vtkImagePropertyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 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 vtkScalarsToColorsGetLookupTable ()
 
virtual void SetUseLookupTableScalarRange (vtkTypeBool)
 Use the range that is set in the lookup table, instead of setting the range from the Window/Level settings. More...
 
virtual vtkTypeBool 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: VTK_LINEAR_INTERPOLATION). 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 (vtkTypeBool)
 Make a checkerboard pattern where the black squares are transparent. More...
 
virtual void CheckerboardOn ()
 
virtual void CheckerboardOff ()
 
virtual vtkTypeBool 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 (vtkTypeBool)
 Use an opaque backing polygon, which will be visible where the image is translucent. More...
 
virtual void BackingOn ()
 
virtual void BackingOff ()
 
virtual vtkTypeBool 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 () override
 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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 vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and 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 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImagePropertySafeDownCast (vtkObjectBase *o)
 
static vtkImagePropertyNew ()
 Construct a property with no lookup table. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImageProperty ()
 
 ~vtkImageProperty () override
 
- 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkScalarsToColorsLookupTable
 
double ColorWindow
 
double ColorLevel
 
vtkTypeBool UseLookupTableScalarRange
 
int InterpolationType
 
int LayerNumber
 
double Opacity
 
double Ambient
 
double Diffuse
 
vtkTypeBool Checkerboard
 
double CheckerboardSpacing [2]
 
double CheckerboardOffset [2]
 
vtkTypeBool Backing
 
double BackingColor [3]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

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

Definition at line 36 of file vtkImageProperty.h.

Member Typedef Documentation

◆ Superclass

Definition at line 39 of file vtkImageProperty.h.

Constructor & Destructor Documentation

◆ vtkImageProperty()

vtkImageProperty::vtkImageProperty ( )
protected

◆ ~vtkImageProperty()

vtkImageProperty::~vtkImageProperty ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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 
)
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 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 ( vtkTypeBool  )
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 vtkTypeBool 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. The default is 1.0.

◆ 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: VTK_LINEAR_INTERPOLATION).

◆ GetInterpolationType()

virtual int vtkImageProperty::GetInterpolationType ( )
virtual

◆ SetInterpolationTypeToNearest()

void vtkImageProperty::SetInterpolationTypeToNearest ( )
inline

Definition at line 122 of file vtkImageProperty.h.

◆ SetInterpolationTypeToLinear()

void vtkImageProperty::SetInterpolationTypeToLinear ( )
inline

Definition at line 123 of file vtkImageProperty.h.

◆ SetInterpolationTypeToCubic()

void vtkImageProperty::SetInterpolationTypeToCubic ( )
inline

Definition at line 124 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 134 of file vtkImageProperty.h.

◆ SetCheckerboard()

virtual void vtkImageProperty::SetCheckerboard ( vtkTypeBool  )
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 vtkTypeBool 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 ( vtkTypeBool  )
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 vtkTypeBool 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 ( )
overridevirtual

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

◆ ColorWindow

double vtkImageProperty::ColorWindow
protected

Definition at line 195 of file vtkImageProperty.h.

◆ ColorLevel

double vtkImageProperty::ColorLevel
protected

Definition at line 196 of file vtkImageProperty.h.

◆ UseLookupTableScalarRange

vtkTypeBool vtkImageProperty::UseLookupTableScalarRange
protected

Definition at line 197 of file vtkImageProperty.h.

◆ InterpolationType

int vtkImageProperty::InterpolationType
protected

Definition at line 198 of file vtkImageProperty.h.

◆ LayerNumber

int vtkImageProperty::LayerNumber
protected

Definition at line 199 of file vtkImageProperty.h.

◆ Opacity

double vtkImageProperty::Opacity
protected

Definition at line 200 of file vtkImageProperty.h.

◆ Ambient

double vtkImageProperty::Ambient
protected

Definition at line 201 of file vtkImageProperty.h.

◆ Diffuse

double vtkImageProperty::Diffuse
protected

Definition at line 202 of file vtkImageProperty.h.

◆ Checkerboard

vtkTypeBool vtkImageProperty::Checkerboard
protected

Definition at line 203 of file vtkImageProperty.h.

◆ CheckerboardSpacing

double vtkImageProperty::CheckerboardSpacing[2]
protected

Definition at line 204 of file vtkImageProperty.h.

◆ CheckerboardOffset

double vtkImageProperty::CheckerboardOffset[2]
protected

Definition at line 205 of file vtkImageProperty.h.

◆ Backing

vtkTypeBool vtkImageProperty::Backing
protected

Definition at line 206 of file vtkImageProperty.h.

◆ BackingColor

double vtkImageProperty::BackingColor[3]
protected

Definition at line 207 of file vtkImageProperty.h.


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