itkColorTable.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkColorTable_h
#define itkColorTable_h
 
#include "itkObject.h"
#include "itkRGBPixel.h"
#include "itkObjectFactory.h"
 
#include <string>
#include <vector>
namespace itk
{
template <typename TComponent>
class ITK_TEMPLATE_EXPORT ColorTable : public Object
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ColorTable);
 
  using Self = ColorTable;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkNewMacro(Self);
 
  itkOverrideGetNameOfClassMacro(ColorTable);
 
  void
  UseDiscreteColors();
 
  void
  UseGrayColors(unsigned int n = 256);
 
  void
  UseHeatColors(unsigned int n = 256);
 
  void
  UseRandomColors(unsigned int n = 256);
 
  itkGetConstMacro(NumberOfColors, unsigned int);
 
  RGBPixel<TComponent>
  GetColor(unsigned int c);
 
  bool
  SetColor(unsigned int c, TComponent r, TComponent g, TComponent b, const char * name = "UserDefined");
  bool
  SetColor(unsigned int c, RGBPixel<TComponent> pixel, const char * name = "UserDefined");
  TComponent
  GetColorComponent(unsigned int c, char rgb);
 
  std::string
  GetColorName(unsigned int c);
 
  unsigned int
  GetClosestColorTableId(TComponent r, TComponent g, TComponent b);
 
protected:
  ColorTable() = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  using ColorNameVectorType = std::vector<std::string>;
  using ColorVectorType = std::vector<RGBPixel<TComponent>>;
 
  void
  DeleteColors();
 
  unsigned int m_NumberOfColors{ 0 };
 
  ColorNameVectorType m_ColorName{};
  ColorVectorType     m_Color{};
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkColorTable.hxx"
#endif
 
#endif