|| ||           || Doxygen's  

---

HxIndxHisto.h

/*
 *  Copyright (c) 2000, University of Amsterdam, The Netherlands.
 *  All rights reserved.
 *
 *  Author(s):
 *  Jan-Mark Geusebroek (mark@wins.uva.nl)
 *
 */

/*
 *  JV, 06Mar03: added at+get+getKey+listAt functions for access to histograms
 *  JV, 06Mar03: added reconstruction information to header
 *  JV, 06Mar03: added dimensionSize+dimensionality inquiry
 *  JV, 06Mar03: added support for varying datatype histograms (long or float)
 */

#ifndef HxIndxHisto_H
#define HxIndxHisto_H

#include "HxIndxArray.h"
#include "HxHistoList.h"

template<class ArrayT> ArrayT* getData(HxHistoList);
template long* getData(HxHistoList);
template float* getData(HxHistoList);

template<class HeaderT>
class IndxHistHeaderT {
    public:
        friend STD_OSTREAM& operator<<(STD_OSTREAM& os,
            const IndxHistHeaderT& l)
                {return os << l.bins << " bins, " << l.chans <<
                    ((l.chans == 1) ?  HxString(" channel") :
                        HxString(" channels"));}
                        
    int     dimensionality() const
            {   if (dimensionSize(3)>1)
                    return 3;
                else
                    if (dimensionSize(2)>1)
                        return 2;
                return 1;
            }
            
    int     dimensionSize(int d) const
            { return dim[d-1]; }
            
    double          lowBin(int d) const
            { return low[d-1]; }
            
    double          highBin(int d) const
            { return high[d-1]; }
            
    HxValueType     dataType() const
            { return _dataType;}

    int         bins; /* Redundant, but kept for backwards compatibility. */
    int         chans;
    HeaderT     header; /* Contains application-dependent info. */
    
    int         dim[3];
    double      low[3];
    double      high[3];
    HxValueType _dataType;        
};

/* ArrayT is histogram type (long or double), HeaderT is the comment type */
template<class ArrayT, class HeaderT>
class indexedHisto : public indexedArray<ArrayT, IndxHistHeaderT<HeaderT> >  {
public:
    void        create(HxString indexFile, HeaderT header);
    void        add(HxString& key, HxHistoList& l); 
    void        search(HxHistoList& target, int n = 10, int refine = 0);

                /* Header information about the histograms. */
    int         bins() const;
    int         chans() const;
    HeaderT     header() const;    
    int         dimensionSize(int d) const;
    int         dimensionality() const;             
    HxValueType dataType() const;   
    double      lowBin(int d) const;
    double      highBin(int d) const;

    friend STD_OSTREAM& operator<<(STD_OSTREAM& os,
        const indexedHisto& l)
            {return l.put(os);}

    int         arraySize(const IndxHistHeaderT<HeaderT>& header) const
                    {return header.bins*header.chans;}

    virtual double      compare(ArrayT *e1, ArrayT *e2,
                    const IndxHistHeaderT<HeaderT>& header) const;

                /* Returns data for the ndx-th element in the c-th channel. */
    HxHistogram at(int ndx, int c=0) const;
                    
                /* Returns the data for the ndx-th element */
    HxHistoList listAt(int ndx) const;

                /* Returns the data for given key. */
    HxHistogram get(HxString key, int c=0) const;

                /* Returns the key of the ndx-th element. */
    HxString    getKey(int ndx) const       
                {return indexedArray<ArrayT, IndxHistHeaderT<HeaderT> >
                    ::getKey(ndx);}

private:
                /* Converts the data to histogram. */
    HxHistogram makeHistogram(ArrayT* arr, int c=0) const;
    
    int         _create;
    HeaderT     _header;
};


#ifdef INC_TEMPLATE_SRC
#include "HxIndxHisto.c"
#endif

#endif

---