filter.h

Go to the documentation of this file.

//Copyright 2009-2011 Thomas A Caswell
//tcaswell@uchicago.edu
//http://jfi.uchicago.edu/~tcaswell
//
//This program is free software; you can redistribute it and/or modify
//it under the terms of the GNU General Public License as published by
//the Free Software Foundation; either version 3 of the License, or (at
//your option) any later version.
//
//This program is distributed in the hope that it will be useful, but
//WITHOUT ANY WARRANTY; without even the implied warranty of
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
//General Public License for more details.
//
//You should have received a copy of the GNU General Public License
//along with this program; if not, see <http://www.gnu.org/licenses>.
//
//Additional permission under GNU GPL version 3 section 7
//
//If you modify this Program, or any covered work, by linking or
//combining it with MATLAB (or a modified version of that library),
//containing parts covered by the terms of MATLAB User License, the
//licensors of this Program grant you additional permission to convey
//the resulting work.

#ifndef FILTER
#define FILTER
#include <string>
#include <vector>

namespace utilities
{
class Wrapper_in;
class Md_store;

typedef enum FILT_TYPE{
  FILT_TRIV = 0,                // trivial, always returns true
  FILT_ERS,                     // e_cut(top),rg_cut(top),shift_cut(top)
  FILT_ERSImin,                 // e_cut(top),rg_cut(top),shift_cut(top), I_cut(bottom)
} FILT_TYPE;


class Filter
{
public:
  virtual bool operator() (int index,int frame)const = 0;
  virtual void set_wrapper(const Wrapper_in * )=0;

  virtual  FILT_TYPE get_type()const = 0;
  
  virtual ~Filter(){};
  Filter(){};
};


class Filter_trivial:public Filter
{
public:
  bool operator()(int,int)const
  {
    return true;
  }
  void set_wrapper(const Wrapper_in * ){};
  FILT_TYPE get_type()const{return FILT_TRIV;};
  Filter_trivial(){};
  ~Filter_trivial(){};
};



class Filter_ers:public Filter
{
public:
  bool operator()(int ind,int frame) const;
  Filter_ers();
  void init(const Md_store & md_store);
  void set_wrapper(const Wrapper_in * w_i )
  {
    wrap_ = w_i;
  }
  FILT_TYPE get_type()const{return FILT_ERS;};
  Md_store get_parameters()const;
  
  ~Filter_ers()
  {
  }
private:
  float e_cut_;
  float rg_cut_;
  float shift_cut_;
  float shift_cut_sqr_;

  const Wrapper_in * wrap_;
};

  

class Filter_ersI:public Filter
{
public:
  bool operator()(int ind,int frame) const;
  Filter_ersI();
  void init(const Md_store & md_store);
  void set_wrapper(const Wrapper_in * w_i )
  {
    wrap_ = w_i;
  }
  FILT_TYPE get_type()const{return FILT_ERSImin;};
  Md_store get_parameters()const;
  
  ~Filter_ersI()
  {
  }
private:
  float e_cut_;
  float rg_cut_;
  float shift_cut_;
  float I_min_cut_;
  
  const Wrapper_in * wrap_;
};

  



Filter * filter_factory(const Md_store & filter_prams);

Md_store extract_prams(const std::string & fname,int comp_num, const std::vector<std::string> & pram_list);


}
#endif