filter.h

Go to the documentation of this file.

// $Id: filter.h 29830 2009-01-14 15:10:41Z kgadeyne $
// Copyright (C) 2002 Klaas Gadeyne <first dot last at gmail dot com>
//
 /***************************************************************************
 *   This library 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;                 *
 *   version 2 of the License.                                             *
 *                                                                         *
 *   As a special exception, you may use this file as part of a free       *
 *   software library without restriction.  Specifically, if other files   *
 *   instantiate templates or use macros or inline functions from this     *
 *   file, or you compile this file and link it with other files to        *
 *   produce an executable, this file does not by itself cause the         *
 *   resulting executable to be covered by the GNU General Public          *
 *   License.  This exception does not however invalidate any other        *
 *   reasons why the executable file might be covered by the GNU General   *
 *   Public License.                                                       *
 *                                                                         *
 *   This library 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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU General Public             *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 59 Temple Place,                                    *
 *   Suite 330, Boston, MA  02111-1307  USA                                *
 *                                                                         *
 ***************************************************************************/

#ifndef __FILTER__
#define __FILTER__

#include "../model/systemmodel.h"
#include "../model/measurementmodel.h"
#include "../pdf/pdf.h"

namespace BFL
{
  using namespace std;


  template <typename StateVar, typename MeasVar> class Filter
    {
    protected:

      Pdf<StateVar> * _prior;


      Pdf<StateVar> * _post;


      int _timestep;


      virtual bool UpdateInternal(SystemModel<StateVar>* const sysmodel,
                                  const StateVar& u,
                                  MeasurementModel<MeasVar,StateVar>* const measmodel,
                                  const MeasVar& z,
                                  const StateVar& s)=0;

    public:

      Filter(Pdf<StateVar> * prior);


      Filter(const Filter<StateVar,MeasVar>& filt);

      virtual ~Filter();

      virtual void Reset(Pdf<StateVar> * prior);


      virtual bool Update(SystemModel<StateVar>* const sysmodel,
                          const StateVar& u,
                          MeasurementModel<MeasVar,StateVar>* const measmodel,
                          const MeasVar& z,
                          const StateVar& s);


      virtual bool Update(SystemModel<StateVar>* const sysmodel,
                          MeasurementModel<MeasVar,StateVar>* const measmodel,
                          const MeasVar& z,
                          const StateVar& s);

      virtual bool Update(SystemModel<StateVar>* const sysmodel,
                          MeasurementModel<MeasVar,StateVar>* const measmodel,
                          const MeasVar& z);

      virtual bool Update(SystemModel<StateVar>* const sysmodel,
                          const StateVar& u,
                          MeasurementModel<MeasVar,StateVar>* const measmodel,
                          const MeasVar& z);


      virtual bool Update(SystemModel<StateVar>* const sysmodel,
                          const StateVar& u);

      virtual bool Update(SystemModel<StateVar>* const sysmodel);


      virtual bool Update(MeasurementModel<MeasVar,StateVar>* const measmodel,
                          const MeasVar& z,
                          const StateVar& s);

      virtual bool Update(MeasurementModel<MeasVar,StateVar>* const measmodel,
                          const MeasVar& z);


      virtual Pdf<StateVar> * PostGet();


      int TimeStepGet() const;
    };

  // For template instantiation
#include "filter.cpp"

} // End namespace BFL

#endif // __FILTER__