Base_StateB.h

Go to the documentation of this file.

//  \author{Anselmo Cervera, Juan J. Gomez-Cadenas and Jose Angel Hernando}
// \date{11/01}

#ifndef StateB_h
#define StateB_h 1

#include "Kalman/Interface_IState.h"
#include "Kalman/Util_HyperVector.h"

//! General Base class for a IState
/*! A Basic implementation of a IState
*/
class StateB : public IState
{
 public:
  
  //! default constructor
  StateB(){}
  
  //! default destructor
  virtual ~StateB(){}
  
  //! copy constructor via an interface
  void copy(const IState& is);
  void copy(IState& is);


  //-------- Set and Get methods -----------------
  
  //! Returns the model name 
  virtual std::string modelName() const {return m_modelName;}
  //! Set the model name
  virtual void setModelName(std::string m) {m_modelName=m;}

  //! name of the volume in which this state is defined 
  virtual std::string volumeName() const {return m_volumeName;}
  virtual void setVolumeName(std::string name){m_volumeName = name;}    
  

  //!   Returns the state HyperVector
  //!   This is the hypervector which contains all the information (dynamic+running+static)
  virtual const HyperVector& stateHV() const {return m_stateHV;}
  //!   Set the dynamic HyperVector
  virtual void setStateHV(const HyperVector& hv);

  
  //!   Returns the dynamic HyperVector
  //!   This is the dynamic hypervector to be computed by the fitter
  virtual const HyperVector& dynamicHV() const {return m_dynamicHV;}
  //!   Set the dynamic HyperVector
  virtual void setDynamicHV(const HyperVector& hv);

  //!   Returns the fitting HyperVector
  //!   This is the fitting hypervector to be computed by the fitter
  virtual const HyperVector& fittingHV() const {return m_fittingHV;}
  //!   Set the fitting HyperVector
  virtual void setFittingHV(const HyperVector& hv);


  //!   Returns the static HyperVector
  virtual const HyperVector& staticHV() const {return m_staticHV;}
  //!   Set the static HyperVector
  virtual void setStaticHV(const HyperVector& hv);
  //!   Set a static HyperVector component
  virtual void setStaticHVComponent(const int comp, const double number, const double error2);
  

  //! Returns the running hypervector associated with the state
  virtual const HyperVector& runningHV() const {return m_runningHV;}
  //! set the running HV associated with the state
  virtual void setRunningHV(const HyperVector& hv);
  
  //!   Set the dimension of the state  Vector assigning the proper HV initialized to 0.
  virtual void setStateNdim(const int dim); 

  //!   Set the dimension of the fitting Vector assigning the proper HV initialized to 0.
  virtual void setFittingNdim(const int dim); 

  //!   Set the dimension of the dynamic Vector assigning the proper HV initialized to 0.
  virtual void setDynamicNdim(const int dim); 

  //!   Set the dimension of the static Vector assigning the proper HV initialized to 0.
  virtual void setStaticNdim(const int dim); 

  //!   Set the dimension of the running vector assigning the proper HV initialized to 0.
  virtual void setRunningNdim(const int dim); 

  //!   The transport matrix (linearized kalman filter)
  virtual const EMatrix F () const {return m_F;}
  //!   Set the transport matrix
  virtual void setF (const EMatrix value){m_F=value;}
  
  //!   The correlated random noise covariance matrix (for
  //!   example, the covariance matrix associated to the
  //!   multiple scattering between two surfaces)
  virtual const EMatrix Q () const {return m_Q;}
  //! Set the random noise covariance matrix
  virtual void setQ (const EMatrix value){m_Q=value;}

  //----------------------------------

  virtual bool convertModelSpecificHV(EMatrix& J, HyperVector& hv) 
  {
    std::cout << "StateB::convertModelSpecificHV called with: " << J << " " << hv << std::endl;
    return true;
  }  //ME added return and warning cout

  //-------- Global acctions -----------------


  //! Gives dimension and model to the state 
  virtual void dress(int dynamicNdim, std::string model);
  //! reset the state
  virtual void reset();

  //! prints state information
  virtual void info(int verb) const;      
  virtual void info() const {info(1);}
  
  
 protected:
  
  //! model
  std::string m_modelName;

  //! volume name
  std::string m_volumeName; 

  //! state Hyper Vector
  HyperVector m_stateHV;

  //! fitting hypervector - parameters that are included in the fitting procedure
  HyperVector m_fittingHV;

  //! dynamic hypervector - dynamic parameters (fitting+running)
  HyperVector m_dynamicHV;

  //! static hypervector - static parameters
  HyperVector m_staticHV;
  
  //! running hypervector - running parameters
  HyperVector m_runningHV;
  
  EMatrix m_F;
  
  EMatrix m_Q;
  
};

#endif

---