ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage > Class Template Reference
Intensity Image Filters | MultiThreaded Filters | Module ITKColormap

#include <itkScalarToRGBColormapImageFilter.h>

+ Inheritance diagram for itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types

enum  ColormapEnumType {
  Red,
  Green,
  Blue,
  Grey,
  Hot,
  Cool,
  Spring,
  Summer,
  Autumn,
  Winter,
  Copper,
  Jet,
  HSV,
  OverUnder
}
typedef
Function::ColormapFunction
< InputImagePixelType,
OutputImagePixelType > 		ColormapType
typedef SmartPointer< const Self > ConstPointer
typedef InputImageType::PixelType InputImagePixelType
typedef
InputImageType::ConstPointer 		InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef TInputImage InputImageType
typedef OutputImageType::PixelType OutputImagePixelType
typedef OutputImageType::Pointer OutputImagePointer
typedef OutputImageType::RegionType OutputImageRegionType
typedef TOutputImage OutputImageType
typedef SmartPointer< Self > Pointer
typedef
ScalarToRGBColormapImageFilter 		Self
typedef ImageToImageFilter
< TInputImage, TOutputImage > 		Superclass
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef
InputImageType::ConstPointer 		InputImageConstPointer
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef
Superclass::DataObjectIdentifierType 		DataObjectIdentifierType
typedef DataObject::Pointer DataObjectPointer
typedef
Superclass::DataObjectPointerArraySizeType 		DataObjectPointerArraySizeType
- Public Types inherited from itk::ProcessObject
typedef std::vector
< DataObjectPointer > 		DataObjectPointerArray
typedef std::vector
< DataObjectIdentifierType > 		NameArray
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
void SetColormap (ColormapEnumType)
virtual void SetColormap (ColormapType *_arg)
virtual ColormapType * GetColormap ()
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType * GetInput (void) const
const InputImageType * GetInput (unsigned int idx) const
virtual void PopBackInput ()
virtual void PopFrontInput ()
virtual void PushBackInput (const InputImageType *image)
virtual void PushFrontInput (const InputImageType *image)
virtual void SetInput (const InputImageType *image)
virtual void SetInput (unsigned int, const TInputImage *image)
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType * GetOutput (unsigned int idx)
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
virtual void GraftOutput (DataObject *output)
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType * GetOutput (void)
const OutputImageType * GetOutput (void) const
virtual
ProcessObject::DataObjectPointer 		MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
virtual void AbortGenerateDataOn ()
virtual void EnlargeOutputRequestedRegion (DataObject *)
virtual const bool & GetAbortGenerateData ()
NameArray GetInputNames () const
MultiThreader * GetMultiThreader () const
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType GetNumberOfInputs () const
DataObjectPointerArraySizeType GetNumberOfOutputs () const
virtual
DataObjectPointerArraySizeType 		GetNumberOfValidRequiredInputs () const
NameArray GetOutputNames () const
virtual const float & GetProgress ()
NameArray GetRequiredInputNames () const
bool HasInput (const DataObjectIdentifierType &key) const
bool HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
virtual void PrepareOutputs ()
virtual void PropagateRequestedRegion (DataObject *output)
virtual void ResetPipeline ()
virtual void SetAbortGenerateData (bool _arg)
virtual void SetProgress (float _arg)
virtual void Update ()
virtual void UpdateLargestPossibleRegion ()
virtual void UpdateOutputData (DataObject *output)
virtual void UpdateOutputInformation ()
void UpdateProgress (float amount)
DataObjectPointerArray GetInputs ()
DataObjectPointerArray GetOutputs ()
DataObjectPointerArray GetIndexedInputs ()
DataObjectPointerArray GetIndexedOutputs ()
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
virtual void SetReleaseDataFlag (bool flag)
virtual bool GetReleaseDataFlag () const
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool & GetReleaseDataBeforeUpdateFlag ()
virtual void ReleaseDataBeforeUpdateFlagOn ()
virtual void ReleaseDataBeforeUpdateFlagOff ()
virtual void SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType & GetNumberOfThreads ()
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) const
virtual void DebugOff () const
virtual void DebugOn () const
Command * GetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionary & GetMetaDataDictionary (void)
const MetaDataDictionary & GetMetaDataDictionary (void) const
virtual unsigned long GetMTime () const
virtual const TimeStamp & GetTimeStamp () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
virtual void Modified () const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () const
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
virtual int GetReferenceCount () const
 itkCloneMacro (Self)
void Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions

static Pointer New ()

Protected Member Functions

void BeforeThreadedGenerateData ()
virtual void GenerateOutputInformation ()
void PrintSelf (std::ostream &os, Indent indent) const
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
virtual void GenerateInputRequestedRegion ()
 ImageToImageFilter ()
virtual void VerifyInputInformation ()
 ~ImageToImageFilter ()
void PushBackInput (const DataObject *input)
void PushFrontInput (const DataObject *input)
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
virtual void AllocateOutputs ()
virtual void GenerateData ()
 ImageSource ()
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual ~ImageSource ()
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
virtual void AddOutput (DataObject *output)
bool AddRequiredInputName (const DataObjectIdentifierType &)
virtual void CacheInputReleaseDataFlags ()
virtual void GenerateOutputRequestedRegion (DataObject *output)
virtual const
DataObjectPointerArraySizeType & 		GetNumberOfRequiredInputs ()
virtual const
DataObjectPointerArraySizeType & 		GetNumberOfRequiredOutputs ()
bool IsIndexedName (const DataObjectIdentifierType &) const
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType MakeNameFromIndex (DataObjectPointerArraySizeType) const
 ProcessObject ()
virtual void PropagateResetPipeline ()
virtual void ReleaseInputs ()
virtual void RemoveInput (const DataObjectIdentifierType &key)
virtual void RemoveInput (DataObjectPointerArraySizeType)
virtual void RemoveOutput (const DataObjectIdentifierType &key)
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void RestoreInputReleaseDataFlags ()
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void SetPrimaryInput (DataObject *input)
virtual void SetPrimaryOutput (DataObject *output)
void SetRequiredInputNames (const NameArray &)
virtual void VerifyPreconditions ()
 ~ProcessObject ()
DataObject * GetInput (const DataObjectIdentifierType &key)
const DataObject * GetInput (const DataObjectIdentifierType &key) const
DataObject * GetInput (DataObjectPointerArraySizeType)
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
DataObject * GetPrimaryInput ()
const DataObject * GetPrimaryInput () const
DataObject * GetOutput (const DataObjectIdentifierType &key)
const DataObject * GetOutput (const DataObjectIdentifierType &key) const
DataObject * GetOutput (DataObjectPointerArraySizeType idx)
const DataObject * GetOutput (DataObjectPointerArraySizeType idx) const
DataObject * GetPrimaryOutput ()
const DataObject * GetPrimaryOutput () const
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
virtual ~Object ()
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 LightObject ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual ~LightObject ()

Private Member Functions

void operator= (const Self &)
 ScalarToRGBColormapImageFilter (const Self &)

Private Attributes

ColormapType::Pointer m_Colormap
bool m_UseInputImageExtremaForScaling
virtual void SetUseInputImageExtremaForScaling (bool _arg)
virtual bool GetUseInputImageExtremaForScaling () const
virtual void UseInputImageExtremaForScalingOn ()
virtual void UseInputImageExtremaForScalingOff ()
 ScalarToRGBColormapImageFilter ()
virtual ~ScalarToRGBColormapImageFilter ()

Additional Inherited Members

- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static const unsigned int InputImageDimension = TInputImage::ImageDimension
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 		InputToOutputRegionCopierType
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 		OutputToInputRegionCopierType

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >

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. http://hdl.handle.net/1926/1452 http://www.insight-journal.org/browse/publication/285

See also:
BinaryFunctionImageFilter TernaryFunctionImageFilter 


Wiki Examples:





Definition at line 77 of file itkScalarToRGBColormapImageFilter.h.


Member Typedef Documentation








template<class TInputImage , class TOutputImage > 

      

        

          typedef Function::ColormapFunction< InputImagePixelType, OutputImagePixelType > itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::ColormapType
        

      





Definition at line 104 of file itkScalarToRGBColormapImageFilter.h.













template<class TInputImage , class TOutputImage > 

      

        

          typedef SmartPointer< const Self > itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::ConstPointer
        

      





Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.



Definition at line 85 of file itkScalarToRGBColormapImageFilter.h.













template<class TInputImage , class TOutputImage > 

      

        

          typedef InputImageType::PixelType itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::InputImagePixelType
        

      





Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.



Definition at line 97 of file itkScalarToRGBColormapImageFilter.h.













template<class TInputImage , class TOutputImage > 

      

        

          typedef InputImageType::ConstPointer itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::InputImagePointer
        

      





Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.



Definition at line 95 of file itkScalarToRGBColormapImageFilter.h.













template<class TInputImage , class TOutputImage > 

      

        

          typedef InputImageType::RegionType itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::InputImageRegionType
        

      





Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.



Definition at line 96 of file itkScalarToRGBColormapImageFilter.h.













template<class TInputImage , class TOutputImage > 

      

        

          typedef TInputImage itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::InputImageType
        

      




Some typedefs. 



Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.



Definition at line 91 of file itkScalarToRGBColormapImageFilter.h.













template<class TInputImage , class TOutputImage > 

      

        

          typedef OutputImageType::PixelType itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::OutputImagePixelType
        

      





Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.



Definition at line 101 of file itkScalarToRGBColormapImageFilter.h.













template<class TInputImage , class TOutputImage > 

      

        

          typedef OutputImageType::Pointer itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::OutputImagePointer
        

      





Reimplemented from itk::ImageSource< TOutputImage >.



Definition at line 99 of file itkScalarToRGBColormapImageFilter.h.













template<class TInputImage , class TOutputImage > 

      

        

          typedef OutputImageType::RegionType itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::OutputImageRegionType
        

      




Superclass typedefs. 



Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.



Definition at line 100 of file itkScalarToRGBColormapImageFilter.h.













template<class TInputImage , class TOutputImage > 

      

        

          typedef TOutputImage itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::OutputImageType
        

      




Some convenient typedefs. 



Reimplemented from itk::ImageSource< TOutputImage >.



Definition at line 98 of file itkScalarToRGBColormapImageFilter.h.













template<class TInputImage , class TOutputImage > 

      

        

          typedef SmartPointer< Self > itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::Pointer
        

      





Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.



Definition at line 84 of file itkScalarToRGBColormapImageFilter.h.













template<class TInputImage , class TOutputImage > 

      

        

          typedef ScalarToRGBColormapImageFilter itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::Self
        

      




Standard class typedefs. 



Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.



Definition at line 82 of file itkScalarToRGBColormapImageFilter.h.













template<class TInputImage , class TOutputImage > 

      

        

          typedef ImageToImageFilter< TInputImage, TOutputImage > itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::Superclass
        

      





Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.



Definition at line 83 of file itkScalarToRGBColormapImageFilter.h.







Member Enumeration Documentation








template<class TInputImage , class TOutputImage > 

      

        

          enum itk::ScalarToRGBColormapImageFilter::ColormapEnumType
        

      




Enum type that provides for an easy interface to existing colormaps. 


Enumerator: 


Red 



Green 



Blue 



Grey 



Hot 



Cool 



Spring 



Summer 



Autumn 



Winter 



Copper 



Jet 



HSV 



OverUnder 










Definition at line 116 of file itkScalarToRGBColormapImageFilter.h.







Constructor & Destructor Documentation








template<class TInputImage , class TOutputImage > 



  

  
      

        

          itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::ScalarToRGBColormapImageFilter 
          (
          )
          
        

      

  		
  
protected  
  






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. 













template<class TInputImage , class TOutputImage > 



  

  
      

        

          virtual itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::~ScalarToRGBColormapImageFilter 
          (
          )
          
        

      

  		
  
inlineprotectedvirtual  
  






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 131 of file itkScalarToRGBColormapImageFilter.h.













template<class TInputImage , class TOutputImage > 



  

  
      

        

          itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::ScalarToRGBColormapImageFilter 
          (
          const Self & 
          )
          
        

      

  		
  
private  
  











Member Function Documentation








template<class TInputImage , class TOutputImage > 



  

  
      

        

          void itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData 
          (
          )
          
        

      

  		
  
protectedvirtual  
  






Process to execute before entering the multithreaded section 



Reimplemented from itk::ImageSource< TOutputImage >.













template<class TInputImage , class TOutputImage > 



  

  
      

        

          virtual::itk::LightObject::Pointer itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::CreateAnother 
          (
          void 
          )
           const
        

      

  		
  
virtual  
  






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::Object.













template<class TInputImage , class TOutputImage > 



  

  
      

        

          virtual void itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation 
          (
          )
          
        

      

  		
  
inlineprotectedvirtual  
  






Generate the information describing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information. 



Reimplemented from itk::ProcessObject.



Definition at line 136 of file itkScalarToRGBColormapImageFilter.h.













template<class TInputImage , class TOutputImage > 



  

  
      

        

          virtual ColormapType* itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::GetColormap 
          (
          )
          
        

      

  		
  
virtual  
  






Set/Get the colormap object. 













template<class TInputImage , class TOutputImage > 



  

  
      

        

          virtual const char* itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::GetNameOfClass 
          (
          )
           const
        

      

  		
  
virtual  
  






Run-time type information (and related methods). 



Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.













template<class TInputImage , class TOutputImage > 



  

  
      

        

          virtual bool itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::GetUseInputImageExtremaForScaling 
          (
          )
           const
        

      

  		
  
virtual  
  






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. 













template<class TInputImage , class TOutputImage > 



  

  
      

        

          static Pointer itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::New 
          (
          )
          
        

      

  		
  
static  
  






Method for creation through the object factory. 



Reimplemented from itk::Object.













template<class TInputImage , class TOutputImage > 



  

  
      

        

          void itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::operator= 
          (
          const Self & 
          )
          
        

      

  		
  
private  
  






PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass. 



Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.













template<class TInputImage , class TOutputImage > 



  

  
      

        

          void itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::PrintSelf 
          (
          std::ostream & 
          os, 
        

        

          
          
          Indent 
          indent 
        

        

          
          )
           const
        

      

  		
  
protectedvirtual  
  






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::ImageToImageFilter< TInputImage, TOutputImage >.













template<class TInputImage , class TOutputImage > 



  

  
      

        

          virtual void itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::SetColormap 
          (
          ColormapType * 
          _arg)
          
        

      

  		
  
virtual  
  






Set/Get the colormap object. 













template<class TInputImage , class TOutputImage > 

      

        

          void itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::SetColormap 
          (
          ColormapEnumType 
          )
          
        

      















template<class TInputImage , class TOutputImage > 



  

  
      

        

          virtual void itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::SetUseInputImageExtremaForScaling 
          (
          bool 
          _arg)
          
        

      

  		
  
virtual  
  






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. 













template<class TInputImage , class TOutputImage > 



  

  
      

        

          void itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData 
          (
          const OutputImageRegionType & 
          outputRegionForThread, 
        

        

          
          
          ThreadIdType 
          threadId 
        

        

          
          )
          
        

      

  		
  
protectedvirtual  
  






ScalarToRGBColormapImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"


See also:
ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData() 



Reimplemented from itk::ImageSource< TOutputImage >.













template<class TInputImage , class TOutputImage > 



  

  
      

        

          virtual void itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::UseInputImageExtremaForScalingOff 
          (
          )
          
        

      

  		
  
virtual  
  






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. 













template<class TInputImage , class TOutputImage > 



  

  
      

        

          virtual void itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::UseInputImageExtremaForScalingOn 
          (
          )
          
        

      

  		
  
virtual  
  






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. 







Member Data Documentation








template<class TInputImage , class TOutputImage > 



  

  
      

        

          ColormapType::Pointer itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::m_Colormap
        

      

  		
  
private  
  







Definition at line 175 of file itkScalarToRGBColormapImageFilter.h.













template<class TInputImage , class TOutputImage > 



  

  
      

        

          bool itk::ScalarToRGBColormapImageFilter< TInputImage, TOutputImage >::m_UseInputImageExtremaForScaling
        

      

  		
  
private  
  







Definition at line 177 of file itkScalarToRGBColormapImageFilter.h.







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







  Tarballs of the nightly generated Doxygen documentation are available
    for the
    html,
    xml, and
    tag file.
  




  Generated on Wed Jul 11 2012 00:23:40 for ITK by doxygen 1.8.1