libigl_Martin/include/igl/colormap.h

// This file is part of libigl, a simple c++ geometry processing library.
// 
// Copyright (C) 2017 Joe Graus <jgraus@gmu.edu>, Alec Jacobson <alecjacobson@gmail.com>
// 
// This Source Code Form is subject to the terms of the Mozilla Public License 
// v. 2.0. If a copy of the MPL was not distributed with this file, You can 
// obtain one at http://mozilla.org/MPL/2.0/.

#ifndef IGL_COLORMAP_H
#define IGL_COLORMAP_H
#include "igl_inline.h"

#include <Eigen/Dense>

namespace igl {

  enum ColorMapType
  {
    COLOR_MAP_TYPE_INFERNO = 0,
    COLOR_MAP_TYPE_JET = 1,
    COLOR_MAP_TYPE_MAGMA = 2,
    COLOR_MAP_TYPE_PARULA = 3,
    COLOR_MAP_TYPE_PLASMA = 4,
    COLOR_MAP_TYPE_VIRIDIS = 5,
    NUM_COLOR_MAP_TYPES = 6
  };
  // Comput [r,g,b] values of the selected colormap for
  // a given factor f between 0 and 1
  //
  // Inputs:
  //   c  colormap enum
  //   f  factor determining color value as if 0 was min and 1 was max
  // Outputs:
  //   rgb  red, green, blue value
  template <typename T>
  IGL_INLINE void colormap(const ColorMapType cm, const T f, T * rgb);
  // Outputs:
  //   r  red value
  //   g  green value
  //   b  blue value
  template <typename T>
  IGL_INLINE void colormap(const ColorMapType cm, const T f, T & r, T & g, T & b);
  // Inputs:
  //    palette  256 by 3 array of color values
  template <typename T>
  IGL_INLINE void colormap(
    const double palette[256][3], const T x_in, T & r, T & g, T & b);
  // Inputs:
  //   cm selected colormap palette to interpolate from
  //   Z  #Z list of factors
  //   normalize  whether to normalize Z to be tightly between [0,1]
  // Outputs:
  //   C  #C by 3 list of rgb colors
  template <typename DerivedZ, typename DerivedC>
  IGL_INLINE void colormap(
    const ColorMapType cm,
    const Eigen::MatrixBase<DerivedZ> & Z,
    const bool normalize,
    Eigen::PlainObjectBase<DerivedC> & C);
  // Inputs:
  //   min_z  value at "0"
  //   max_z  value at "1"
  template <typename DerivedZ, typename DerivedC>
  IGL_INLINE void colormap(
    const ColorMapType cm,
    const Eigen::MatrixBase<DerivedZ> & Z,
    const double min_Z,
    const double max_Z,
    Eigen::PlainObjectBase<DerivedC> & C);
};

#ifndef IGL_STATIC_LIBRARY
#  include "colormap.cpp"
#endif

#endif