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

map scalar values into colors or colors to scalars; generate color table More...

#include <vtkWindowLevelLookupTable.h>

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

Public Types

typedef vtkLookupTable Superclass
 
- Public Types inherited from vtkLookupTable
typedef vtkScalarsToColors Superclass
 
- Public Types inherited from vtkScalarsToColors
enum  VectorModes { MAGNITUDE =0, COMPONENT =1 }
 
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void Build ()
 
void SetWindow (double window)
 
virtual double GetWindow ()
 
void SetLevel (double level)
 
virtual double GetLevel ()
 
void SetInverseVideo (int iv)
 
virtual int GetInverseVideo ()
 
virtual void InverseVideoOn ()
 
virtual void InverseVideoOff ()
 
virtual void SetMinimumTableValue (double, double, double, double)
 
virtual void SetMinimumTableValue (double[4])
 
virtual double * GetMinimumTableValue ()
 
virtual void GetMinimumTableValue (double &, double &, double &, double &)
 
virtual void GetMinimumTableValue (double[4])
 
virtual void SetMaximumTableValue (double, double, double, double)
 
virtual void SetMaximumTableValue (double[4])
 
virtual double * GetMaximumTableValue ()
 
virtual void GetMaximumTableValue (double &, double &, double &, double &)
 
virtual void GetMaximumTableValue (double[4])
 
void SetMinimumColor (int r, int g, int b, int a)
 
void SetMinimumColor (const unsigned char rgba[4])
 
void GetMinimumColor (unsigned char rgba[4])
 
unsigned char * GetMinimumColor ()
 
void SetMaximumColor (int r, int g, int b, int a)
 
void SetMaximumColor (const unsigned char rgba[4])
 
void GetMaximumColor (unsigned char rgba[4])
 
unsigned char * GetMaximumColor ()
 
- Public Member Functions inherited from vtkLookupTable
virtual int IsOpaque ()
 
int Allocate (int sz=256, int ext=256)
 
virtual void ForceBuild ()
 
unsigned char * MapValue (double v)
 
void GetColor (double x, double rgb[3])
 
double GetOpacity (double v)
 
virtual vtkIdType GetIndex (double v)
 
void SetTableValue (vtkIdType indx, double rgba[4])
 
void SetTableValue (vtkIdType indx, double r, double g, double b, double a=1.0)
 
double * GetTableValue (vtkIdType id)
 
void GetTableValue (vtkIdType id, double rgba[4])
 
unsigned char * WritePointer (const vtkIdType id, const int number)
 
void DeepCopy (vtkLookupTable *lut)
 
virtual vtkIdType GetNumberOfAvailableColors ()
 
virtual void SetRamp (int)
 
void SetRampToLinear ()
 
void SetRampToSCurve ()
 
void SetRampToSQRT ()
 
virtual int GetRamp ()
 
void SetScale (int scale)
 
void SetScaleToLinear ()
 
void SetScaleToLog10 ()
 
virtual int GetScale ()
 
void SetTableRange (double r[2])
 
virtual void SetTableRange (double min, double max)
 
virtual double * GetTableRange ()
 
virtual void GetTableRange (double data[2])
 
virtual void SetHueRange (double, double)
 
void SetHueRange (double[2])
 
virtual double * GetHueRange ()
 
virtual void GetHueRange (double &, double &)
 
virtual void GetHueRange (double[2])
 
virtual void SetSaturationRange (double, double)
 
void SetSaturationRange (double[2])
 
virtual double * GetSaturationRange ()
 
virtual void GetSaturationRange (double &, double &)
 
virtual void GetSaturationRange (double[2])
 
virtual void SetValueRange (double, double)
 
void SetValueRange (double[2])
 
virtual double * GetValueRange ()
 
virtual void GetValueRange (double &, double &)
 
virtual void GetValueRange (double[2])
 
virtual void SetAlphaRange (double, double)
 
void SetAlphaRange (double[2])
 
virtual double * GetAlphaRange ()
 
virtual void GetAlphaRange (double &, double &)
 
virtual void GetAlphaRange (double[2])
 
virtual void SetNanColor (double, double, double, double)
 
virtual void SetNanColor (double[4])
 
virtual double * GetNanColor ()
 
virtual void GetNanColor (double &, double &, double &, double &)
 
virtual void GetNanColor (double[4])
 
void SetNumberOfTableValues (vtkIdType number)
 
vtkIdType GetNumberOfTableValues ()
 
unsigned char * GetPointer (const vtkIdType id)
 
double * GetRange ()
 
void SetRange (double min, double max)
 
void SetRange (double rng[2])
 
virtual void SetNumberOfColors (vtkIdType)
 
virtual vtkIdType GetNumberOfColors ()
 
void SetTable (vtkUnsignedCharArray *)
 
virtual vtkUnsignedCharArrayGetTable ()
 
void MapScalarsThroughTable2 (void *input, unsigned char *output, int inputDataType, int numberOfValues, int inputIncrement, int outputIncrement)
 
virtual int UsingLogScale ()
 
- Public Member Functions inherited from vtkScalarsToColors
void SetRange (double rng[2])
 
double * GetColor (double v)
 
virtual double GetOpacity (double vtkNotUsed(v))
 
double GetLuminance (double x)
 
virtual void SetAlpha (double alpha)
 
virtual double GetAlpha ()
 
virtual vtkUnsignedCharArrayMapScalars (vtkDataArray *scalars, int colorMode, int component)
 
virtual void SetVectorMode (int)
 
virtual int GetVectorMode ()
 
void SetVectorModeToMagnitude ()
 
void SetVectorModeToComponent ()
 
virtual void SetVectorComponent (int)
 
virtual int GetVectorComponent ()
 
void MapScalarsThroughTable (vtkDataArray *scalars, unsigned char *output, int outputFormat)
 
void MapScalarsThroughTable (vtkDataArray *scalars, unsigned char *output)
 
virtual vtkUnsignedCharArrayConvertUnsignedCharToRGBA (vtkUnsignedCharArray *colors, int numComp, int numTuples)
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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 *)
 
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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
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
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkWindowLevelLookupTableNew ()
 
static int IsTypeOf (const char *type)
 
static vtkWindowLevelLookupTableSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkLookupTable
static vtkLookupTableNew ()
 
static int IsTypeOf (const char *type)
 
static vtkLookupTableSafeDownCast (vtkObject *o)
 
static void GetLogRange (const double range[2], double log_range[2])
 
static double ApplyLogScale (double v, const double range[2], const double log_range[2])
 
- Static Public Member Functions inherited from vtkScalarsToColors
static int IsTypeOf (const char *type)
 
static vtkScalarsToColorsSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkWindowLevelLookupTable (int sze=256, int ext=256)
 
 ~vtkWindowLevelLookupTable ()
 
- Protected Member Functions inherited from vtkLookupTable
 vtkLookupTable (int sze=256, int ext=256)
 
 ~vtkLookupTable ()
 
- Protected Member Functions inherited from vtkScalarsToColors
 vtkScalarsToColors ()
 
 ~vtkScalarsToColors ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &os)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double Window
 
double Level
 
int InverseVideo
 
double MaximumTableValue [4]
 
double MinimumTableValue [4]
 
- Protected Attributes inherited from vtkLookupTable
vtkIdType NumberOfColors
 
vtkUnsignedCharArrayTable
 
double TableRange [2]
 
double HueRange [2]
 
double SaturationRange [2]
 
double ValueRange [2]
 
double AlphaRange [2]
 
double NanColor [4]
 
int Scale
 
int Ramp
 
vtkTimeStamp InsertTime
 
vtkTimeStamp BuildTime
 
double RGBA [4]
 
int OpaqueFlag
 
vtkTimeStamp OpaqueFlagBuildTime
 
- Protected Attributes inherited from vtkScalarsToColors
double Alpha
 
int VectorMode
 
int UseMagnitude
 
int VectorComponent
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

map scalar values into colors or colors to scalars; generate color table

vtkWindowLevelLookupTable is an object that is used by mapper objects to map scalar values into rgba (red-green-blue-alpha transparency) color specification, or rgba into scalar values. The color table can be created by direct insertion of color values, or by specifying a window and level. Window / Level is used in medical imaging to specify a linear greyscale ramp. The Level is the center of the ramp. The Window is the width of the ramp.

Warning
vtkWindowLevelLookupTable is a reference counted object. Therefore, you should always use operator "new" to construct new objects. This procedure will avoid memory problems (see text).
See Also
vtkLogLookupTable

Definition at line 40 of file vtkWindowLevelLookupTable.h.

Member Typedef Documentation

Definition at line 44 of file vtkWindowLevelLookupTable.h.

Constructor & Destructor Documentation

vtkWindowLevelLookupTable::vtkWindowLevelLookupTable ( int  sze = 256,
int  ext = 256 
)
protected
vtkWindowLevelLookupTable::~vtkWindowLevelLookupTable ( )
inlineprotected

Definition at line 116 of file vtkWindowLevelLookupTable.h.

Member Function Documentation

static vtkWindowLevelLookupTable* vtkWindowLevelLookupTable::New ( )
static
virtual const char* vtkWindowLevelLookupTable::GetClassName ( )
virtual

Reimplemented from vtkLookupTable.

static int vtkWindowLevelLookupTable::IsTypeOf ( const char *  type)
static
virtual int vtkWindowLevelLookupTable::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 vtkLookupTable.

static vtkWindowLevelLookupTable* vtkWindowLevelLookupTable::SafeDownCast ( vtkObject o)
static
void vtkWindowLevelLookupTable::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 vtkLookupTable.

void vtkWindowLevelLookupTable::Build ( )
virtual

Generate lookup table as a linear ramp between MinimumTableValue and MaximumTableValue.

Reimplemented from vtkLookupTable.

void vtkWindowLevelLookupTable::SetWindow ( double  window)
inline

Set the window for the lookup table. The window is the difference between TableRange[0] and TableRange[1].

Definition at line 54 of file vtkWindowLevelLookupTable.h.

virtual double vtkWindowLevelLookupTable::GetWindow ( )
virtual

Set the window for the lookup table. The window is the difference between TableRange[0] and TableRange[1].

void vtkWindowLevelLookupTable::SetLevel ( double  level)
inline

Set the Level for the lookup table. The level is the average of TableRange[0] and TableRange[1].

Definition at line 65 of file vtkWindowLevelLookupTable.h.

virtual double vtkWindowLevelLookupTable::GetLevel ( )
virtual

Set the Level for the lookup table. The level is the average of TableRange[0] and TableRange[1].

void vtkWindowLevelLookupTable::SetInverseVideo ( int  iv)

Set inverse video on or off. You can achieve the same effect by switching the MinimumTableValue and the MaximumTableValue.

virtual int vtkWindowLevelLookupTable::GetInverseVideo ( )
virtual

Set inverse video on or off. You can achieve the same effect by switching the MinimumTableValue and the MaximumTableValue.

virtual void vtkWindowLevelLookupTable::InverseVideoOn ( )
virtual

Set inverse video on or off. You can achieve the same effect by switching the MinimumTableValue and the MaximumTableValue.

virtual void vtkWindowLevelLookupTable::InverseVideoOff ( )
virtual

Set inverse video on or off. You can achieve the same effect by switching the MinimumTableValue and the MaximumTableValue.

virtual void vtkWindowLevelLookupTable::SetMinimumTableValue ( double  ,
double  ,
double  ,
double   
)
virtual

Set the minimum table value. All lookup table entries below the start of the ramp will be set to this color. After you change this value, you must re-build the lookup table.

virtual void vtkWindowLevelLookupTable::SetMinimumTableValue ( double  [4])
virtual

Set the minimum table value. All lookup table entries below the start of the ramp will be set to this color. After you change this value, you must re-build the lookup table.

virtual double* vtkWindowLevelLookupTable::GetMinimumTableValue ( )
virtual

Set the minimum table value. All lookup table entries below the start of the ramp will be set to this color. After you change this value, you must re-build the lookup table.

virtual void vtkWindowLevelLookupTable::GetMinimumTableValue ( double &  ,
double &  ,
double &  ,
double &   
)
virtual

Set the minimum table value. All lookup table entries below the start of the ramp will be set to this color. After you change this value, you must re-build the lookup table.

virtual void vtkWindowLevelLookupTable::GetMinimumTableValue ( double  [4])
virtual

Set the minimum table value. All lookup table entries below the start of the ramp will be set to this color. After you change this value, you must re-build the lookup table.

virtual void vtkWindowLevelLookupTable::SetMaximumTableValue ( double  ,
double  ,
double  ,
double   
)
virtual

Set the maximum table value. All lookup table entries above the end of the ramp will be set to this color. After you change this value, you must re-build the lookup table.

virtual void vtkWindowLevelLookupTable::SetMaximumTableValue ( double  [4])
virtual

Set the maximum table value. All lookup table entries above the end of the ramp will be set to this color. After you change this value, you must re-build the lookup table.

virtual double* vtkWindowLevelLookupTable::GetMaximumTableValue ( )
virtual

Set the maximum table value. All lookup table entries above the end of the ramp will be set to this color. After you change this value, you must re-build the lookup table.

virtual void vtkWindowLevelLookupTable::GetMaximumTableValue ( double &  ,
double &  ,
double &  ,
double &   
)
virtual

Set the maximum table value. All lookup table entries above the end of the ramp will be set to this color. After you change this value, you must re-build the lookup table.

virtual void vtkWindowLevelLookupTable::GetMaximumTableValue ( double  [4])
virtual

Set the maximum table value. All lookup table entries above the end of the ramp will be set to this color. After you change this value, you must re-build the lookup table.

void vtkWindowLevelLookupTable::SetMinimumColor ( int  r,
int  g,
int  b,
int  a 
)
Deprecated:
For backwards compatibility: specify the color using integers in the range [0,255].
void vtkWindowLevelLookupTable::SetMinimumColor ( const unsigned char  rgba[4])
Deprecated:
For backwards compatibility: specify the color using integers in the range [0,255].
void vtkWindowLevelLookupTable::GetMinimumColor ( unsigned char  rgba[4])
Deprecated:
For backwards compatibility: specify the color using integers in the range [0,255].
unsigned char* vtkWindowLevelLookupTable::GetMinimumColor ( )
Deprecated:
For backwards compatibility: specify the color using integers in the range [0,255].
void vtkWindowLevelLookupTable::SetMaximumColor ( int  r,
int  g,
int  b,
int  a 
)
Deprecated:
For backwards compatibility: specify the color using integers in the range [0,255].
void vtkWindowLevelLookupTable::SetMaximumColor ( const unsigned char  rgba[4])
Deprecated:
For backwards compatibility: specify the color using integers in the range [0,255].
void vtkWindowLevelLookupTable::GetMaximumColor ( unsigned char  rgba[4])
Deprecated:
For backwards compatibility: specify the color using integers in the range [0,255].
unsigned char* vtkWindowLevelLookupTable::GetMaximumColor ( )
Deprecated:
For backwards compatibility: specify the color using integers in the range [0,255].

Member Data Documentation

double vtkWindowLevelLookupTable::Window
protected

Definition at line 116 of file vtkWindowLevelLookupTable.h.

double vtkWindowLevelLookupTable::Level
protected

Definition at line 119 of file vtkWindowLevelLookupTable.h.

int vtkWindowLevelLookupTable::InverseVideo
protected

Definition at line 120 of file vtkWindowLevelLookupTable.h.

double vtkWindowLevelLookupTable::MaximumTableValue[4]
protected

Definition at line 121 of file vtkWindowLevelLookupTable.h.

double vtkWindowLevelLookupTable::MinimumTableValue[4]
protected

Definition at line 122 of file vtkWindowLevelLookupTable.h.


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