coltab.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Bert
 Date:          Sep 2007
________________________________________________________________________

-*/


#include "generalmod.h"
#include "color.h"
#include "typeset.h"
#include "samplingdata.h"


namespace ColTab
{

typedef float                           ValueType;
typedef float                           PosType;
typedef SamplingData<ValueType>         SamplingType;
typedef std::pair<float,float>          ClipRatePair;
enum SeqUseMode
{
    UnflippedSingle, UnflippedCyclic, FlippedSingle, FlippedCyclic
};
inline PosType getLimitedRelPos( PosType relpos )
{
    return getLimited( relpos, 0.f, 1.f );
}

mGlobal(General) bool                   isFlipped(SeqUseMode);
mGlobal(General) bool                   isCyclic(SeqUseMode);
mGlobal(General) SeqUseMode             getSeqUseMode(bool flipped,bool cyclic);
mGlobal(General) BufferString           toString(SeqUseMode);
mGlobal(General) void                   toPar(SeqUseMode,IOPar&);
mGlobal(General) bool                   fromPar(const IOPar&,SeqUseMode&);
mGlobal(General) void                   convToPerc(ClipRatePair&);
mGlobal(General) void                   convFromPerc(ClipRatePair&);
mGlobal(General) inline const char*     sKeySeqUseMode()
                                        { return "Color Table Use Mode"; }

mGlobal(General) const char*            defSeqName();
mGlobal(General) ClipRatePair           defClipRate();
mGlobal(General) ValueType              defSymMidval();
mGlobal(General) bool                   defAutoSymmetry();
mGlobal(General) bool                   defHistEq();
mGlobal(General) void                   setMapperDefaults(ClipRatePair,
                                                ValueType simmid,bool autosym,
                                                bool histeq);


class Mapper;
class Sequence;
class TableFiller;
class IndexTableFiller;

mExpClass(General) Table
{
public:

    typedef TypeSet<Color>      SetType;

                        Table(const Sequence&,int sz,SeqUseMode);
                        Table(const Sequence&,int sz,const Mapper&);
                        Table(const SetType&,SamplingType);

    int                 size() const            { return cols_.size(); }
    Color               color( int idx ) const  { return cols_[idx]; }
    SamplingType        sampling() const        { return sampling_; }

    int                 indexFor(ValueType) const; 
    Color               colorAt(ValueType) const; 

    inline Color        snappedColorAt( ValueType val ) const
                        { return cols_[ indexFor(val) ]; }

protected:

    SetType             cols_;
    SamplingType        sampling_;

    friend class        TableFiller;
    void                setColor(const Sequence&,const Mapper&,int);

private:

    void                createTable(const Sequence& seq,const Mapper&,int);

};


mExpClass(General) IndexTable
{
public:

    typedef TypeSet<int> SetType;

                        IndexTable(int sz,SeqUseMode);
                        IndexTable(int sz,const Mapper&);
                        IndexTable(const SetType&,SamplingType);

    int                 size() const                    { return idxs_.size(); }
    int                 colIndex( int idx ) const       { return idxs_[idx]; }
    SamplingType        sampling() const                { return sampling_; }

    int                 indexFor(ValueType) const; 

protected:

    SetType             idxs_;
    SamplingType        sampling_;

    void                setIndex(const Mapper&,int);
    friend class        IndexTableFiller;

private:

    void                createTable(const Mapper&,int);

};


} // namespace ColTab