VTK
9.1.0
|
image display properties More...
#include <vtkImageProperty.h>
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. | |
vtkImageProperty * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | DeepCopy (vtkImageProperty *p) |
Assign one property to another. | |
vtkMTimeType | GetMTime () override |
Get the MTime for this property. | |
virtual void | SetColorWindow (double) |
The window value for window/level. | |
virtual double | GetColorWindow () |
The window value for window/level. | |
virtual void | SetColorLevel (double) |
The level value for window/level. | |
virtual double | GetColorLevel () |
The level value for window/level. | |
virtual void | SetLookupTable (vtkScalarsToColors *lut) |
Specify a lookup table for the data. | |
virtual vtkScalarsToColors * | GetLookupTable () |
Specify a lookup table for the data. | |
virtual void | SetUseLookupTableScalarRange (vtkTypeBool) |
Use the range that is set in the lookup table, instead of setting the range from the Window/Level settings. | |
virtual vtkTypeBool | GetUseLookupTableScalarRange () |
Use the range that is set in the lookup table, instead of setting the range from the Window/Level settings. | |
virtual void | UseLookupTableScalarRangeOn () |
Use the range that is set in the lookup table, instead of setting the range from the Window/Level settings. | |
virtual void | UseLookupTableScalarRangeOff () |
Use the range that is set in the lookup table, instead of setting the range from the Window/Level settings. | |
virtual void | SetOpacity (double) |
The opacity of the image, where 1.0 is opaque and 0.0 is transparent. | |
virtual double | GetOpacity () |
The opacity of the image, where 1.0 is opaque and 0.0 is transparent. | |
virtual void | SetAmbient (double) |
The ambient lighting coefficient. | |
virtual double | GetAmbient () |
The ambient lighting coefficient. | |
virtual void | SetDiffuse (double) |
The diffuse lighting coefficient. | |
virtual double | GetDiffuse () |
The diffuse lighting coefficient. | |
virtual void | SetInterpolationType (int) |
The interpolation type (default: VTK_LINEAR_INTERPOLATION). | |
virtual int | GetInterpolationType () |
The interpolation type (default: VTK_LINEAR_INTERPOLATION). | |
void | SetInterpolationTypeToNearest () |
The interpolation type (default: VTK_LINEAR_INTERPOLATION). | |
void | SetInterpolationTypeToLinear () |
The interpolation type (default: VTK_LINEAR_INTERPOLATION). | |
void | SetInterpolationTypeToCubic () |
The interpolation type (default: VTK_LINEAR_INTERPOLATION). | |
virtual const char * | GetInterpolationTypeAsString () |
The interpolation type (default: VTK_LINEAR_INTERPOLATION). | |
virtual void | SetLayerNumber (int) |
Set the layer number. | |
int | GetLayerNumber () |
Set the layer number. | |
virtual void | SetCheckerboard (vtkTypeBool) |
Make a checkerboard pattern where the black squares are transparent. | |
virtual void | CheckerboardOn () |
Make a checkerboard pattern where the black squares are transparent. | |
virtual void | CheckerboardOff () |
Make a checkerboard pattern where the black squares are transparent. | |
virtual vtkTypeBool | GetCheckerboard () |
Make a checkerboard pattern where the black squares are transparent. | |
virtual void | SetCheckerboardSpacing (double, double) |
The spacing for checkerboarding. | |
void | SetCheckerboardSpacing (double[2]) |
The spacing for checkerboarding. | |
virtual double * | GetCheckerboardSpacing () |
The spacing for checkerboarding. | |
virtual void | GetCheckerboardSpacing (double &, double &) |
The spacing for checkerboarding. | |
virtual void | GetCheckerboardSpacing (double[2]) |
The spacing for checkerboarding. | |
virtual void | SetCheckerboardOffset (double, double) |
The phase offset for checkerboarding, in units of spacing. | |
void | SetCheckerboardOffset (double[2]) |
The phase offset for checkerboarding, in units of spacing. | |
virtual double * | GetCheckerboardOffset () |
The phase offset for checkerboarding, in units of spacing. | |
virtual void | GetCheckerboardOffset (double &, double &) |
The phase offset for checkerboarding, in units of spacing. | |
virtual void | GetCheckerboardOffset (double[2]) |
The phase offset for checkerboarding, in units of spacing. | |
virtual void | SetBacking (vtkTypeBool) |
Use an opaque backing polygon, which will be visible where the image is translucent. | |
virtual void | BackingOn () |
Use an opaque backing polygon, which will be visible where the image is translucent. | |
virtual void | BackingOff () |
Use an opaque backing polygon, which will be visible where the image is translucent. | |
virtual vtkTypeBool | GetBacking () |
Use an opaque backing polygon, which will be visible where the image is translucent. | |
virtual void | SetBackingColor (double, double, double) |
Set the color of the backing polygon. | |
virtual void | SetBackingColor (double[3]) |
Set the color of the backing polygon. | |
virtual double * | GetBackingColor () |
Set the color of the backing polygon. | |
virtual void | GetBackingColor (double &, double &, double &) |
Set the color of the backing polygon. | |
virtual void | GetBackingColor (double[3]) |
Set the color of the backing polygon. | |
Public Member Functions inherited from vtkObject | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. | |
virtual void | DebugOff () |
Turn debugging output off. | |
bool | GetDebug () |
Get the value of the debug flag. | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. | |
virtual void | Modified () |
Update the modification time for this object. | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
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) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
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. | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. | |
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. | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
int | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
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). | |
virtual void | Delete () |
Delete a VTK object. | |
virtual void | FastDelete () |
Delete a reference to this object. | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. | |
virtual void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). | |
int | GetReferenceCount () |
Return the current reference count of this object. | |
void | SetReferenceCount (int) |
Sets the reference count. | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkImageProperty * | SafeDownCast (vtkObjectBase *o) |
static vtkImageProperty * | New () |
Construct a property with no lookup table. | |
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. | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static int | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
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. | |
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). | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. | |
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. | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () 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. | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. | |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
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 |
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 () |
image display properties
vtkImageProperty is an object that allows control of the display of an image slice.
Definition at line 145 of file vtkImageProperty.h.
Definition at line 148 of file vtkImageProperty.h.
|
protected |
|
overrideprotected |
|
static |
|
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.
|
static |
|
protectedvirtual |
vtkImageProperty * vtkImageProperty::NewInstance | ( | ) | const |
|
overridevirtual |
|
static |
Construct a property with no lookup table.
void vtkImageProperty::DeepCopy | ( | vtkImageProperty * | p | ) |
Assign one property to another.
|
virtual |
The window value for window/level.
|
virtual |
The window value for window/level.
|
virtual |
The level value for window/level.
|
virtual |
The level value for window/level.
|
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 |
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 |
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 |
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 |
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 |
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 |
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.
|
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.
|
virtual |
The ambient lighting coefficient.
The default is 1.0.
|
virtual |
The ambient lighting coefficient.
The default is 1.0.
|
virtual |
The diffuse lighting coefficient.
The default is 0.0.
|
virtual |
The diffuse lighting coefficient.
The default is 0.0.
|
virtual |
The interpolation type (default: VTK_LINEAR_INTERPOLATION).
|
virtual |
The interpolation type (default: VTK_LINEAR_INTERPOLATION).
|
inline |
The interpolation type (default: VTK_LINEAR_INTERPOLATION).
Definition at line 231 of file vtkImageProperty.h.
|
inline |
The interpolation type (default: VTK_LINEAR_INTERPOLATION).
Definition at line 232 of file vtkImageProperty.h.
|
inline |
The interpolation type (default: VTK_LINEAR_INTERPOLATION).
Definition at line 233 of file vtkImageProperty.h.
|
virtual |
The interpolation type (default: VTK_LINEAR_INTERPOLATION).
|
virtual |
Set the layer number.
This is ignored unless the image is part of a vtkImageStack. The default layer number is zero.
|
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 243 of file vtkImageProperty.h.
|
virtual |
Make a checkerboard pattern where the black squares are transparent.
The pattern is aligned with the camera, and centered by default.
|
virtual |
Make a checkerboard pattern where the black squares are transparent.
The pattern is aligned with the camera, and centered by default.
|
virtual |
Make a checkerboard pattern where the black squares are transparent.
The pattern is aligned with the camera, and centered by default.
|
virtual |
Make a checkerboard pattern where the black squares are transparent.
The pattern is aligned with the camera, and centered by default.
|
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 |
The spacing for checkerboarding.
This is in real units, not pixels.
|
virtual |
The spacing for checkerboarding.
This is in real units, not pixels.
|
virtual |
The spacing for checkerboarding.
This is in real units, not pixels.
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Set the color of the backing polygon.
The default color is black.
|
virtual |
Set the color of the backing polygon.
The default color is black.
|
virtual |
Set the color of the backing polygon.
The default color is black.
|
virtual |
Set the color of the backing polygon.
The default color is black.
|
virtual |
Set the color of the backing polygon.
The default color is black.
|
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.
|
protected |
Definition at line 303 of file vtkImageProperty.h.
|
protected |
Definition at line 304 of file vtkImageProperty.h.
|
protected |
Definition at line 305 of file vtkImageProperty.h.
|
protected |
Definition at line 306 of file vtkImageProperty.h.
|
protected |
Definition at line 307 of file vtkImageProperty.h.
|
protected |
Definition at line 308 of file vtkImageProperty.h.
|
protected |
Definition at line 309 of file vtkImageProperty.h.
|
protected |
Definition at line 310 of file vtkImageProperty.h.
|
protected |
Definition at line 311 of file vtkImageProperty.h.
|
protected |
Definition at line 312 of file vtkImageProperty.h.
|
protected |
Definition at line 313 of file vtkImageProperty.h.
|
protected |
Definition at line 314 of file vtkImageProperty.h.
|
protected |
Definition at line 315 of file vtkImageProperty.h.
|
protected |
Definition at line 316 of file vtkImageProperty.h.