triangle_gate_signal_shape.h

Go to the documentation of this file.

/* Author(s)     : Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date : 2016-09-27
 * Last modified : 2016-09-27
 *
 * Copyright (C) 2016 Francois Mauger <mauger@lpccaen.in2p3.fr>
 *
 * 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 3 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.
 *
 * Description:
 *
 *   A class representing a gate signal shape with arbitrary polarity, rise
 *   and fall times, starting time and charge. Edges have triangular shapes.
 *
 * History:
 *
 */

#ifndef MCTOOLS_SIGNAL_TRIANGLE_GATE_SIGNAL_SHAPE_H
#define MCTOOLS_SIGNAL_TRIANGLE_GATE_SIGNAL_SHAPE_H

// Third party:
// - Bayeux/datatools :
#include <datatools/i_cloneable.h>
// - Bayeux/mygsl:
#include <mygsl/i_unary_function.h>

//  This project:
#include <mctools/signal/utils.h>

namespace mctools {

  namespace signal {


    class triangle_gate_signal_shape
      : public mygsl::i_unary_function,
        public datatools::i_cloneable
    {
    public:

      bool is_valid() const;

      triangle_gate_signal_shape();

      virtual ~triangle_gate_signal_shape();

      virtual void initialize(const datatools::properties & config_,
                              const mygsl::unary_function_dict_type & functors_);

      virtual void reset();

      virtual bool is_initialized() const;

      void set_polarity(polarity_type);

      polarity_type get_polarity() const;

      void reset_polarity();

      double get_rise_time() const;

      double get_fall_time() const;

      void set_amplitude(double);

      double get_amplitude() const;

      double get_q() const;

      void set_t0(double);

      double get_t0() const;

      void set_t1(double);

      double get_t1() const;

      void set_t2(double);

      double get_t2() const;

      double get_t3() const;

      void set_t3(double);

      double get_tpeak() const;

      virtual double get_non_zero_domain_min() const;

      virtual double get_non_zero_domain_max() const;

      double get_duration() const;

      virtual void tree_dump(std::ostream & out_ = std::clog,
                             const std::string & title_  = "",
                             const std::string & indent_ = "",
                             bool inherit_ = false) const;

    protected:

      void _set_defaults();

      void _compute_parameters();

      double _eval(double t_) const;

    private:

      // Configuration:
      polarity_type _polarity_ = POLARITY_UNKNOWN; 
      double        _t0_;         
      double        _t1_;         
      double        _t2_;         
      double        _t3_;         
      double        _amplitude_;  

      // Working data:
      double _q_;      
      double _a_rise_; 
      double _b_rise_; 
      double _a_fall_; 
      double _b_fall_; 

      MYGSL_UNARY_FUNCTOR_REGISTRATION_INTERFACE(triangle_gate_signal_shape)

      
      DATATOOLS_CLONEABLE_DECLARATION(triangle_gate_signal_shape)

    };

  } // end of namespace signal

} // end of namespace mctools

#endif // MCTOOLS_SIGNAL_TRIANGLE_GATE_SIGNAL_SHAPE_H

// Local Variables: --
// mode: c++ --
// c-file-style: "gnu" --
// tab-width: 2 --
// End: --