SimpleITK  1.3.0.dev216
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::ScalarToRGBColormapImageFilter Class Reference

Implements pixel-wise intensity->rgb mapping operation on one image. More...

#include <sitkScalarToRGBColormapImageFilter.h>

+ Inheritance diagram for itk::simple::ScalarToRGBColormapImageFilter:
+ Collaboration diagram for itk::simple::ScalarToRGBColormapImageFilter:

Public Types

enum  ColormapType {
  Red,
  Green,
  Blue,
  Grey,
  Hot,
  Cool,
  Spring,
  Summer,
  Autumn,
  Winter,
  Copper,
  Jet,
  HSV,
  OverUnder
}
 
typedef BasicPixelIDTypeList PixelIDTypeList
 
typedef ScalarToRGBColormapImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

Image Execute (const Image &image1)
 
Image Execute (const Image &image1, ScalarToRGBColormapImageFilter::ColormapType colormap, bool useInputImageExtremaForScaling)
 
ColormapType GetColormap () const
 
std::string GetName () const
 
bool GetUseInputImageExtremaForScaling () const
 
 ScalarToRGBColormapImageFilter ()
 
SelfSetColormap (ColormapType Colormap)
 
SelfSetUseInputImageExtremaForScaling (bool UseInputImageExtremaForScaling)
 
std::string ToString () const
 
SelfUseInputImageExtremaForScalingOff ()
 
SelfUseInputImageExtremaForScalingOn ()
 
virtual ~ScalarToRGBColormapImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter< 1 >
 ImageFilter ()
 
virtual ~ImageFilter ()=0
 
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
 
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
 
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
 
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 
 ProcessObject ()
 
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
 
virtual ~ProcessObject ()
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
virtual bool GetDebug () const
 
virtual void SetDebug (bool debugFlag)
 
virtual void SetNumberOfThreads (unsigned int n)
 
virtual unsigned int GetNumberOfThreads () const
 

Private Types

typedef Image(Self::* MemberFunctionType) (const Image &image1)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image &image1)
 

Private Attributes

ColormapType m_Colormap
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
bool m_UseInputImageExtremaForScaling
 

Friends

struct detail::MemberFunctionAddressor< MemberFunctionType >
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
static bool GetGlobalDefaultDebug ()
 
static void GlobalDefaultDebugOff ()
 
static void GlobalDefaultDebugOn ()
 
static void SetGlobalDefaultDebug (bool debugFlag)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static void SetGlobalWarningDisplay (bool flag)
 
static bool GetGlobalWarningDisplay ()
 
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
 
static unsigned int GetGlobalDefaultNumberOfThreads ()
 
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
 
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
 
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
 
virtual itk::ProcessObjectGetActiveProcess ()
 
virtual void OnActiveProcessDelete ()
 
virtual void onCommandDelete (const itk::simple::Command *cmd) SITK_NOEXCEPT
 
virtual void PreUpdate (itk::ProcessObject *p)
 
virtual void RemoveITKObserver (EventCommand &e)
 
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()
 
- Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
static void FixNonZeroIndex (TImageType *img)
 
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &img)
 
template<class TImageType >
static Image CastITKToImage (TImageType *img)
 
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
 
static const itk::EventObjectGetITKEventObject (EventEnum e)
 
template<typename T >
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
 
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)
 

Detailed Description

Implements pixel-wise intensity->rgb mapping operation on one image.

This class is parameterized over the type of the input image and the type of the output image.

The input image's scalar pixel values are mapped into a color map. The color map is specified by passing the SetColormap function one of the predefined maps. The following selects the "Hot" colormap:

RGBFilterType::Pointer colormapImageFilter = RGBFilterType::New();
colormapImageFilter->SetColormap( RGBFilterType::Hot );

You can also specify a custom color map. This is done by creating a CustomColormapFunction, and then creating lists of values for the red, green, and blue channel. An example of setting the red channel of a colormap with only 2 colors is given below. The blue and green channels should be specified in the same manner.

// Create the custom colormap
typedef itk::Function::CustomColormapFunction<RealImageType::PixelType,
RGBImageType::PixelType> ColormapType;
ColormapType::Pointer colormap = ColormapType::New();
// Setup the red channel of the colormap
ColormapType::ChannelType redChannel;
redChannel.push_back(0); redChannel.push_back(255);
colormap->SetRedChannel( channel );

The range of values present in the input image is the range that is mapped to the entire range of colors.

This code was contributed in the Insight Journal paper: "Meeting Andy Warhol Somewhere Over the Rainbow: RGB Colormapping and ITK" by Tustison N., Zhang H., Lehmann G., Yushkevich P., Gee J. https://hdl.handle.net/1926/1452 http://www.insight-journal.org/browse/publication/285

See also
BinaryFunctionImageFilter TernaryFunctionImageFilter
itk::simple::ScalarToRGBColormap for the procedural interface
itk::ScalarToRGBColormapImageFilter for the Doxygen on the original ITK class.

Definition at line 76 of file sitkScalarToRGBColormapImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::ScalarToRGBColormapImageFilter::MemberFunctionType) (const Image &image1)
private

Setup for member function dispatching

Definition at line 134 of file sitkScalarToRGBColormapImageFilter.h.

Define the pixels types supported by this filter

Definition at line 88 of file sitkScalarToRGBColormapImageFilter.h.

Definition at line 78 of file sitkScalarToRGBColormapImageFilter.h.

Member Enumeration Documentation

Enumerator
Red 
Green 
Blue 
Grey 
Hot 
Cool 
Spring 
Summer 
Autumn 
Winter 
Copper 
Jet 
HSV 
OverUnder 

Definition at line 92 of file sitkScalarToRGBColormapImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::ScalarToRGBColormapImageFilter::~ScalarToRGBColormapImageFilter ( )
virtual

Destructor

itk::simple::ScalarToRGBColormapImageFilter::ScalarToRGBColormapImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::ScalarToRGBColormapImageFilter::Execute ( const Image image1)

Execute the filter on the input image

Image itk::simple::ScalarToRGBColormapImageFilter::Execute ( const Image image1,
ScalarToRGBColormapImageFilter::ColormapType  colormap,
bool  useInputImageExtremaForScaling 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::ScalarToRGBColormapImageFilter::ExecuteInternal ( const Image image1)
private
ColormapType itk::simple::ScalarToRGBColormapImageFilter::GetColormap ( ) const
inline

Set/Get the colormap object.

Definition at line 101 of file sitkScalarToRGBColormapImageFilter.h.

std::string itk::simple::ScalarToRGBColormapImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 117 of file sitkScalarToRGBColormapImageFilter.h.

bool itk::simple::ScalarToRGBColormapImageFilter::GetUseInputImageExtremaForScaling ( ) const
inline

Set/Get UseInputImageExtremaForScaling. If true, the colormap uses the min and max values from the image to scale appropriately. Otherwise, these values can be set in the colormap manually.

Definition at line 115 of file sitkScalarToRGBColormapImageFilter.h.

Self& itk::simple::ScalarToRGBColormapImageFilter::SetColormap ( ColormapType  Colormap)
inline

Definition at line 96 of file sitkScalarToRGBColormapImageFilter.h.

Self& itk::simple::ScalarToRGBColormapImageFilter::SetUseInputImageExtremaForScaling ( bool  UseInputImageExtremaForScaling)
inline

Set/Get UseInputImageExtremaForScaling. If true, the colormap uses the min and max values from the image to scale appropriately. Otherwise, these values can be set in the colormap manually.

Definition at line 106 of file sitkScalarToRGBColormapImageFilter.h.

std::string itk::simple::ScalarToRGBColormapImageFilter::ToString ( ) const
virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Self& itk::simple::ScalarToRGBColormapImageFilter::UseInputImageExtremaForScalingOff ( )
inline

Definition at line 110 of file sitkScalarToRGBColormapImageFilter.h.

Self& itk::simple::ScalarToRGBColormapImageFilter::UseInputImageExtremaForScalingOn ( )
inline

Set the value of UseInputImageExtremaForScaling to true or false respectfully.

Definition at line 109 of file sitkScalarToRGBColormapImageFilter.h.

Friends And Related Function Documentation

Definition at line 138 of file sitkScalarToRGBColormapImageFilter.h.

Member Data Documentation

ColormapType itk::simple::ScalarToRGBColormapImageFilter::m_Colormap
private

Definition at line 143 of file sitkScalarToRGBColormapImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::ScalarToRGBColormapImageFilter::m_MemberFactory
private

Definition at line 140 of file sitkScalarToRGBColormapImageFilter.h.

bool itk::simple::ScalarToRGBColormapImageFilter::m_UseInputImageExtremaForScaling
private

Definition at line 144 of file sitkScalarToRGBColormapImageFilter.h.


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