seqgradramp.h

/***************************************************************************
                          seqgradramp.h  -  description
                             -------------------
    begin                : Tue Aug 13 2002
    copyright            : (C) 2000-2021 by Thies H. Jochimsen
    email                : thies@jochimsen.de
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef SEQGRADRAMP_H
#define SEQGRADRAMP_H
 
#include <odinseq/seqgradwave.h>
 
 
 
 
enum rampType {linear, sinusoidal, half_sinusoidal};
 
 
 
class SeqGradRamp : public SeqGradWave {
 
 public:
 
  SeqGradRamp(const STD_string& object_label,direction gradchannel,
           float initgradstrength, float finalgradstrength, double timestep,rampType type = linear,
           float steepnessfactor=1.0, bool reverse = false);
 
  SeqGradRamp(const STD_string& object_label,direction gradchannel,double gradduration,
           float initgradstrength, float finalgradstrength, double timestep,
           rampType type = linear, bool reverse = false);
 
 
  SeqGradRamp(const SeqGradRamp& sgr);
 
  SeqGradRamp(const STD_string& object_label = "unnamedSeqGradRamp");
 
  SeqGradRamp& set_ramp(float initgradstrength, float finalgradstrength,
     double timestep,rampType type = linear,float steepnessfactor=1.0, bool reverse = false);
 
 
  SeqGradRamp& set_ramp(double gradduration,float initgradstrength,
     float finalgradstrength, double timestep,rampType type = linear, bool reverse = false);
 
  rampType get_ramptype() const {return ramptype;}
 
 
  SeqGradRamp& operator = (const SeqGradRamp& sgr);
 
 
  // helper functions
  static fvector makeGradRamp(rampType type, float beginVal, float endVal, unsigned int n_vals, bool reverseramp);
  static unsigned int npts4ramp(rampType type, float beginVal, float endVal, float maxIncrement);
  static unsigned int npts4ramp(double totaldur, double timestep);
 
 
  // overloading functions from SeqGradInterface
  SeqGradInterface& set_strength(float gradstrength);
 
 private:
  void generate_ramp();
 
  float initstrength;
  float finalstrength;
  double dt;
  float steepness;
  bool steepcontrol;
  rampType ramptype;
  bool  reverseramp;
 
};
 
#endif