drwnSegImagePixelFeatures.h

/*****************************************************************************
** DARWIN: A FRAMEWORK FOR MACHINE LEARNING RESEARCH AND DEVELOPMENT
** Distributed under the terms of the BSD license (see the LICENSE file)
** Copyright (c) 2007-2017, Stephen Gould
** All rights reserved.
**
******************************************************************************
** FILENAME:    drwnSegImagePixelFeatures.h
** AUTHOR(S):   Stephen Gould <stephen.gould@anu.edu.au>
**
*****************************************************************************/

#pragma once

#include <cstdlib>
#include <cassert>
#include <vector>
#include <list>

#include "Eigen/Core"

#include "drwnBase.h"
#include "drwnIO.h"
#include "drwnML.h"

#include "drwnFilterBankResponse.h"

using namespace std;
using namespace Eigen;

// forward declarations ----------------------------------------------------

class drwnSegImageInstance;

// drwnSegImagePixelFeatures class -----------------------------------------

class drwnSegImagePixelFeatures : public drwnCloneable {
 protected:
    string _instanceName; 
    int _instanceWidth;   
    int _instanceHeight;  

 public:
    drwnSegImagePixelFeatures() : _instanceWidth(0), _instanceHeight(0)
        { /* do nothing */ }
    drwnSegImagePixelFeatures(const drwnSegImagePixelFeatures& pf) :
        _instanceName(pf._instanceName), _instanceWidth(pf._instanceWidth),
        _instanceHeight(pf._instanceHeight) { /* do nothing */ }
    virtual ~drwnSegImagePixelFeatures() { /* do nothing */ }

    drwnSegImagePixelFeatures *clone() const = 0;

    virtual int numFeatures() const = 0;

    virtual void cacheInstanceData(const drwnSegImageInstance& instance);
    virtual void clearInstanceData();

    virtual void appendPixelFeatures(int x, int y, vector<double>& phi) const = 0;
    virtual void appendAllPixelFeatures(vector<vector<double> >& phi) const;
};

// drwnSegImageStdPixelFeatures class --------------------------------------

class drwnSegImageStdPixelFeatures : public drwnSegImagePixelFeatures {
 public:
    // configurable feature options
    static double FILTER_BANDWIDTH;        
    static int FEATURE_GRID_SPACING;       
    static bool INCLUDE_RGB;               
    static bool INCLUDE_HOG;               
    static bool INCLUDE_LBP;               
    static bool INCLUDE_ROWCOLAGG;         
    static bool INCLUDE_LOCATION;          
    static string AUX_FEATURE_DIR;         
    static vector<string> AUX_FEATURE_EXT; 

 protected:
    drwnFilterBankResponse _filters;       
    vector<vector<double> > _auxFeatures;  

 public:
    drwnSegImageStdPixelFeatures() { /* do nothing */ }
    drwnSegImageStdPixelFeatures(const drwnSegImageStdPixelFeatures& pf);
    virtual ~drwnSegImageStdPixelFeatures() { /* do nothing */ }

    drwnSegImageStdPixelFeatures *clone() const {
        return new drwnSegImageStdPixelFeatures(*this);
    }

    // data caching
    void cacheInstanceData(const drwnSegImageInstance& instance);
    void clearInstanceData();

    // feature computation
    int numFeatures() const;
    void appendPixelFeatures(int x, int y, vector<double>& phi) const;
};

// drwnSegImageFilePixelFeatures class -------------------------------------

class drwnSegImageFilePixelFeatures : public drwnSegImagePixelFeatures {
 public:
    string featuresDir;          
    list<string> featuresExt;    

 protected:
    vector<vector<double> > _features;  

 public:
    drwnSegImageFilePixelFeatures() { /* do nothing */ }
    drwnSegImageFilePixelFeatures(const drwnSegImageFilePixelFeatures& pf);
    virtual ~drwnSegImageFilePixelFeatures() { /* do nothing */ }

    drwnSegImageFilePixelFeatures *clone() const {
        return new drwnSegImageFilePixelFeatures(*this);
    }

    // data caching
    void cacheInstanceData(const drwnSegImageInstance& instance);
    void clearInstanceData();

    // feature computation
    int numFeatures() const;
    void appendPixelFeatures(int x, int y, vector<double>& phi) const;
};

// drwnSegImageCompositePixelFeatures class --------------------------------

class drwnSegImageCompositePixelFeatures : public drwnSegImagePixelFeatures {
 protected:
    int _numFeatures;
    std::list<drwnSegImagePixelFeatures *> _featureGenerators;

 public:
    drwnSegImageCompositePixelFeatures() : _numFeatures(0) { /* do nothing */ }
    drwnSegImageCompositePixelFeatures(const drwnSegImageCompositePixelFeatures& pf);
    ~drwnSegImageCompositePixelFeatures();

    drwnSegImageCompositePixelFeatures *clone() const {
        return new drwnSegImageCompositePixelFeatures(*this);
    }

    // data caching
    void cacheInstanceData(const drwnSegImageInstance& instance);
    void clearInstanceData();

    // feature computation
    int numFeatures() const { return _numFeatures; }
    void appendPixelFeatures(int x, int y, vector<double>& phi) const;
    void appendAllPixelFeatures(vector<vector<double> >& phi) const;

    void clearFeatureGenerators();
    void addFeatureGenerator(drwnSegImagePixelFeatures *generator);
    void copyFeatureGenerator(const drwnSegImagePixelFeatures *generator) {
        DRWN_ASSERT(generator != NULL);
        addFeatureGenerator(generator->clone());
    }
};