cmtkColormap.h

Go to the documentation of this file.

/*
//
//  Copyright 1997-2009 Torsten Rohlfing
//
//  Copyright 2004-2011 SRI International
//
//  This file is part of the Computational Morphometry Toolkit.
//
//  http://www.nitrc.org/projects/cmtk/
//
//  The Computational Morphometry Toolkit is free software: you can
//  redistribute it and/or modify it under the terms of the GNU General Public
//  License as published by the Free Software Foundation, either version 3 of
//  the License, or (at your option) any later version.
//
//  The Computational Morphometry Toolkit is distributed in the hope that it
//  will be useful, but WITHOUT ANY WARRANTY; without even the implied
//  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License along
//  with the Computational Morphometry Toolkit.  If not, see
//  <http://www.gnu.org/licenses/>.
//
//  $Revision: 2752 $
//
//  $LastChangedDate: 2011-01-17 11:33:31 -0800 (Mon, 17 Jan 2011) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkColormap_h_included_
#define __cmtkColormap_h_included_

#include <cmtkconfig.h>

#include <Pipeline/cmtkPipelineObject.h>
#include <Pipeline/cmtkRGB.h>

#include <Base/cmtkTypedArray.h>

#include <IO/cmtkStudy.h>

#include <vector>

namespace
cmtk
{


class Colormap : 
  public PipelineObject 
{
public:
  static Colormap* New() { return new Colormap(); }

  igsClassParameter(bool,HaveUserMap);

  igsClassParameter2Array(Types::DataItem,HueRange);

  igsClassParameter2Array(cmtk::Types::DataItem,SaturationRange);

  igsClassParameter2Array(cmtk::Types::DataItem,ValueRange);

  // Gamma correction coefficient.
  igsClassParameter(cmtk::Types::DataItem,Gamma);

  igsClassParameter(int,TableEntries);

  igsClassParameter2Array(cmtk::Types::DataItem,DataRange);

  igsClassParameter(bool,Reverse);

  void SetStandardColormap( const int index );

  static const char *StandardColormaps[];

  void Apply( void *const outPtr, const TypedArray* inPtr, const bool generateAlpha = false );

  void SetFromStudy( const Study* study );

  static void HSV2RGB( RGB& rgb, Types::DataItem H, Types::DataItem S, Types::DataItem V );

protected:
  Colormap();

  virtual ~Colormap() {}
  
  virtual void Execute();

private:
  std::vector<RGB> LookupTable;

  Types::DataItem InvDataRangeWidth;

  template<class T>
  void ApplyPrimitive( RGB *const outPtr, const T* inPtr, const unsigned int count, const bool paddingFlag, const T paddingData ) const;

  template<class T>
  void ApplyPrimitive( RGBA *const outPtr, const T* inPtr, const unsigned int count, const bool paddingFlag, const T paddingData ) const;

  SegmentationLabelMap LabelColorMap;
};


} // namespace cmtk

#endif // #ifndef __cmtkColormap_h_included_