HueShadeColorMap.h

 
#pragma once

 
#if defined(HueShadeColorMap_RECURSES)
#error Recursive header files inclusion detected in HueShadeColorMap.h
#else // defined(HueShadeColorMap_RECURSES)
#define HueShadeColorMap_RECURSES
 
#if !defined HueShadeColorMap_h
#define HueShadeColorMap_h

// Inclusions
#include <iostream>
#include "DGtal/base/Common.h"
#include "Board/Board.h"
#include "DGtal/io/Color.h"

 
namespace DGtal
{

  // template class HueShadeColorMap
  template <typename PValue, int DefaultCycles = 1 >
    class HueShadeColorMap
    {
 
    public:
    
    typedef PValue Value;
 
    // ----------------------- Standard services ------------------------------
    public:

    HueShadeColorMap( const PValue & min,
          const PValue & max,
          const unsigned int cycles = DefaultCycles );
    
    Color operator()( const PValue & value ) const;
      
    ~HueShadeColorMap();

    HueShadeColorMap ( const HueShadeColorMap & other );

    HueShadeColorMap & operator= ( const HueShadeColorMap & other );
 
    // ----------------------- Interface --------------------------------------
    public:

    void selfDisplay ( std::ostream & out ) const;

    bool isValid() const;

    const PValue & min() const;

    const PValue & max() const;
 

    void setCycles( int cycles );
 
    // ----------------------- Static methods ---------------------------------
 

    static Color getColor( const unsigned int cycles,
             const PValue & min,
             const PValue & max,
             const PValue & value );
    
    // ------------------------- Protected Datas ------------------------------
    private:
 
    // ------------------------- Private Datas --------------------------------
    private:
 
    // ------------------------- Hidden services ------------------------------
    protected:
 
    PValue myMin;    
    PValue myMax;           
    unsigned int myCycles;  
    
    HueShadeColorMap();
 
    // ------------------------- Internals ------------------------------------
    private:
 
 
 
    }; // end of class HueShadeColorMap
 

  template <typename PValue, int DefaultCycles >
    std::ostream&
    operator<< ( std::ostream & out, const HueShadeColorMap<PValue,DefaultCycles> & object );
  
} // namespace DGtal
 

// Includes inline functions.
#include "DGtal/io/colormaps/HueShadeColorMap.ih"
 
//                                                                           //
 
#endif // !defined HueShadeColorMap_h
 
#undef HueShadeColorMap_RECURSES
#endif // else defined(HueShadeColorMap_RECURSES)