GradPulse.h

Go to the documentation of this file.

 
/*
 *  JEMRIS Copyright (C) 
 *                        2006-2025  Tony Stoecker
 *                        2007-2018  Kaveh Vahedipour
 *                        2009-2019  Daniel Pflugfelder
 *                                  
 *
 *  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 2 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, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef _GRADPULSE_H_
#define _GRADPULSE_H_
 
#include "Pulse.h"
 
//forward declaration of EddyPulse (which itself is a GradPulse)
class EddyPulse;
 
class GradPulse : public Pulse {
 
 public:
 
    GradPulse          ();
 
    virtual ~GradPulse ();
 
    GradPulse (const GradPulse&);
 
    // @brief see Module::GetValue()
    virtual void GetValue (double * dAllVal, double const time);
 
    virtual double GetGradient (double const time) = 0;
 
    // @brief see Module::Prepare
    virtual bool Prepare  (PrepareMode mode);
 
    virtual bool PrepareNLGfield  (PrepareMode mode);
 
    virtual bool PrepareEddyCurrents (PrepareMode mode, int steps = 5000);
 
    double GetAreaNumeric (int steps);
 
    void SetArea (double val);
 
    void SetNonLinGradField(double const time);
 
    bool          HasNonLinGrad(){return m_non_lin_grad; };
 
    virtual void GenerateEvents(std::vector<Event*> &events);
 
  protected:
    virtual string          GetInfo        ();
 
   double m_slew_rate;       
   double m_max_ampl;        
   double m_rise_time;       
   double m_area;            
   bool   m_non_lin_grad;    
   double m_nlg_field;       
   double m_nlg_px;          
   double m_nlg_py;          
   double m_nlg_pz;          
   double m_nlg_val;         
   bool              m_eddy_currents; 
   double                        m_eddy_time;     
   double                    m_eddy_val;      
   double                        m_ec_area;               
   int                           m_ec_length;     
   EddyPulse*            m_eddy_pulse;    
   bool   m_hide;            
};
 
#endif