indii/fmri/neural/ConstantNeuralFunction.hpp

00001 #ifndef INDII_FMRI_NEURAL_CONSTANTNEURALFUNCTION_HPP
00002 #define INDII_FMRI_NEURAL_CONSTANTNEURALFUNCTION_HPP
00003 
00004 #include "indii/ml/ode/FunctionModel.hpp"
00005 
00006 namespace indii {
00007   namespace fmri {
00008     namespace neural {
00009 
00010 /**
00011  * Function representing constant %neural activity.
00012  *
00013  * @author Lawrence Murray <lawrence@indii.org>
00014  * @version $Rev: 285 $
00015  * @date $Date: 2007-07-20 17:25:40 +0100 (Fri, 20 Jul 2007) $
00016  */
00017 class ConstantNeuralFunction : public indii::ml::ode::FunctionModel {
00018 public:
00019   /**
00020    * Constructor.
00021    *
00022    * @param z \f$z\f$; the level of %neural activity.
00023    */
00024   ConstantNeuralFunction(double z);
00025 
00026   /**
00027    * Destructor.
00028    */
00029   virtual ~ConstantNeuralFunction();
00030 
00031   /**
00032    * Evaluate the function.
00033    *
00034    * @return \f$z\f$; the constant level of %neural activity.
00035    *
00036    * @see indii::ml::ode::FunctionModel
00037    */
00038   virtual double evaluate(double t, const double y[]);
00039 
00040 private:
00041   /**
00042    * Level of neural activity.
00043    */
00044   const double z;
00045 
00046 };
00047 
00048     }
00049   }
00050 }
00051 
00052 #endif

Generated on Tue Oct 9 22:02:07 2007 for fmrii fMRI Modelling Library by  doxygen 1.5.2