itk::ColorTable< TPixel > Class Template Reference
[Data Representation Objects]

#include <itkColorTable.h>

Inheritance diagram for itk::ColorTable< TPixel >:

[legend]Collaboration diagram for itk::ColorTable< TPixel >:

[legend]List of all members.

---

Detailed Description

template<class TPixel>
class itk::ColorTable< TPixel >

itkColorTable Class define a Color table for image visualisation

Definition at line 33 of file itkColorTable.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef ColorTable	Self
typedef Object	Superclass
Public Member Functions
TPixel	color (unsigned int c, char rgb)
RGBPixel< TPixel > *	color (unsigned int c)
char *	colorName (unsigned int c)
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
unsigned int	GetClosestColorTableId (TPixel r, TPixel g, TPixel b)
RGBPixel< TPixel > *	GetColor (unsigned int colorId)
Given the position in the table and the color *returns the value todo Needs renaming *TPixel	GetColorComponent (unsigned int colorId, char rgb)
char *	GetColorName (unsigned int colorId)
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual unsigned int	GetNumberOfColors ()
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
Generate a lookuptable of n grayscale values A ramp is *generated from	NonpositiveMin () to max() of the pixel type.*/void UseGrayColors(unsigned int n
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
bool	SetColor (unsigned int c, TPixel r, TPixel g, TPixel b, const char *name="UserDefined")
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
unsigned int	size (void)
virtual void	UnRegister () const
Badly named methods that require renaming and documentation *void	useDiscrete (void)
void	UseDiscreteColors (void)
void	useGray (unsigned int n=256)
void	useHeat (unsigned int n=256)
void	UseHeatColors (unsigned int n=256)
void	UseRandomColors (unsigned int n=256)
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Member Functions
	ColorTable ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~ColorTable ()
Protected Attributes
RGBPixel< TPixel > *	m_Color
char **	m_ColorName
unsigned int	m_NumberOfColors
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Methods invoked by virtual 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.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

Member Typedef Documentation

template<class TPixel> typedef SmartPointer<const Self> itk::ColorTable< TPixel >::ConstPointer

Reimplemented from itk::Object. Definition at line 40 of file itkColorTable.h.

template<class TPixel> typedef SmartPointer<Self> itk::ColorTable< TPixel >::Pointer

Reimplemented from itk::Object. Definition at line 39 of file itkColorTable.h.

template<class TPixel> typedef ColorTable itk::ColorTable< TPixel >::Self

Standard class typedefs. Reimplemented from itk::Object. Definition at line 37 of file itkColorTable.h.

template<class TPixel> typedef Object itk::ColorTable< TPixel >::Superclass

Reimplemented from itk::Object. Definition at line 38 of file itkColorTable.h.

---

Constructor & Destructor Documentation

template<class TPixel> itk::ColorTable< TPixel >::ColorTable (   )  [protected]

template<class TPixel> virtual itk::ColorTable< TPixel >::~ColorTable (   )  [protected, virtual]

---

Member Function Documentation

static void itk::LightObject::BreakOnError (   )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

template<class TPixel> TPixel itk::ColorTable< TPixel >::color (  unsigned int  c, char  rgb )

template<class TPixel> RGBPixel<TPixel>* itk::ColorTable< TPixel >::color (  unsigned int  c  )

template<class TPixel> char* itk::ColorTable< TPixel >::colorName (  unsigned int  c  )

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class. Reimplemented from itk::LightObject.

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

template<class TPixel> unsigned int itk::ColorTable< TPixel >::GetClosestColorTableId (  TPixel  r, TPixel  g, TPixel  b )

template<class TPixel> RGBPixel<TPixel>* itk::ColorTable< TPixel >::GetColor (  unsigned int  colorId  )

template<class TPixel> Given the position in the table and the color* returns the value todo Needs renaming* TPixel itk::ColorTable< TPixel >::GetColorComponent (  unsigned int  colorId, char  rgb )

template<class TPixel> char* itk::ColorTable< TPixel >::GetColorName (  unsigned int  colorId  )

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug (   )  const [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

template<class TPixel> virtual const char* itk::ColorTable< TPixel >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Object.

template<class TPixel> virtual unsigned int itk::ColorTable< TPixel >::GetNumberOfColors (   )  [virtual]

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified (   )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TPixel> static Pointer itk::ColorTable< TPixel >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TPixel> Generate a lookuptable of n grayscale values A ramp is* generated from itk::ColorTable< TPixel >::NonpositiveMin (   )

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

template<class TPixel> void itk::ColorTable< TPixel >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, 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 itk::Object.

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

virtual void itk::Object::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

template<class TPixel> bool itk::ColorTable< TPixel >::SetColor (  unsigned int  c, TPixel  r, TPixel  g, TPixel  b, const char *  name = "UserDefined" )

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

template<class TPixel> unsigned int itk::ColorTable< TPixel >::size (  void   )

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

template<class TPixel> Badly named methods that require renaming and documentation* void itk::ColorTable< TPixel >::useDiscrete (  void   )  [inline]

Definition at line 62 of file itkColorTable.h.

template<class TPixel> void itk::ColorTable< TPixel >::UseDiscreteColors (  void   )

Generate a lookup table of 8 discrete colors. The colors are Red, Purple, Aqua, Yellow, Green, Blue, Grey0.70, White.

template<class TPixel> void itk::ColorTable< TPixel >::useGray (  unsigned int  n = 256  )  [inline]

Definition at line 63 of file itkColorTable.h.

template<class TPixel> void itk::ColorTable< TPixel >::useHeat (  unsigned int  n = 256  )  [inline]

Definition at line 64 of file itkColorTable.h.

template<class TPixel> void itk::ColorTable< TPixel >::UseHeatColors (  unsigned int  n = 256  )

template<class TPixel> void itk::ColorTable< TPixel >::UseRandomColors (  unsigned int  n = 256  )

---

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

template<class TPixel> RGBPixel<TPixel>* itk::ColorTable< TPixel >::m_Color [protected]

Definition at line 92 of file itkColorTable.h.

template<class TPixel> char** itk::ColorTable< TPixel >::m_ColorName [protected]

Definition at line 93 of file itkColorTable.h.

template<class TPixel> unsigned int itk::ColorTable< TPixel >::m_NumberOfColors [protected]

Definition at line 91 of file itkColorTable.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkColorTable.h

---