GrayscaleColorMap.h

Go to the documentation of this file.

#pragma once

#if defined(GrayscaleColorMap_RECURSES)
#error Recursive header files inclusion detected in GrayscaleColorMap.h
#else // defined(GrayscaleColorMap_RECURSES)

#define GrayscaleColorMap_RECURSES

#if !defined GrayscaleColorMap_h

#define GrayscaleColorMap_h

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

namespace DGtal
{

  // template class GrayscaleColorMap
  template <typename PValueType>
  class GrayscaleColorMap
  {
    
  public:
    
    typedef PValueType ValueType;

    // ----------------------- Standard services ------------------------------
  public:

    GrayscaleColorMap( const PValueType & min,
                       const PValueType & max );


    LibBoard::Color operator()( const PValueType & value ) const;
      
    ~GrayscaleColorMap();

    GrayscaleColorMap ( const GrayscaleColorMap & other );

    GrayscaleColorMap & operator= ( const GrayscaleColorMap & other );

    // ----------------------- Interface --------------------------------------
  public:

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

    bool isValid() const;

    const PValueType & min() const;

    const PValueType & max() const;

    // ----------------------- Static methods ---------------------------------


    static LibBoard::Color getColor( const PValueType & min,
                                     const PValueType & max,
                                     const PValueType & value );
    
    // ------------------------- Protected Datas ------------------------------
  private:

    // ------------------------- Private Datas --------------------------------
  private:

    // ------------------------- Hidden services ------------------------------
  protected:

    PValueType myMin;           
    PValueType myMax;            
    GrayscaleColorMap();

    // ------------------------- Internals ------------------------------------
  private:

  }; // end of class GrayscaleColorMap


  template <typename PValueType>
  std::ostream&
  operator<< ( std::ostream & out, const GrayscaleColorMap<PValueType> & object );
  
} // namespace DGtal


// Includes inline functions.
#include "DGtal/io/colormaps/GrayscaleColorMap.ih"

//                                                                           //

#endif // !defined GrayscaleColorMap_h

#undef GrayscaleColorMap_RECURSES
#endif // else defined(GrayscaleColorMap_RECURSES)