multi_signal_shape.h

Go to the documentation of this file.

/* Author(s)     : Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date : 2016-11-30
 * Last modified : 2016-11-30
 *
 * 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 signal shape made of the superposition of
 *   other signal shapes, arbitrarily scaled and shifted.
 *
 */

#ifndef MCTOOLS_SIGNAL_MULTI_SIGNAL_SHAPE_H
#define MCTOOLS_SIGNAL_MULTI_SIGNAL_SHAPE_H

// Standard library:
#include <vector>

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

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

namespace mctools {

  namespace signal {

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

      multi_signal_shape();

      virtual ~multi_signal_shape();

      bool is_valid() const;

      virtual bool is_initialized() const;

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

      virtual void reset();

      void remove(const std::size_t index_);

      std::size_t add(const std::string & key_,
                      const mygsl::const_unary_function_handle_type & shape_,
                      double time_shift_ = 0.0,
                      double scaling_ = 1.0);

      std::size_t add(const std::string & key_,
                      const mygsl::i_unary_function & shape_,
                      double time_shift_ = 0.0,
                      double scaling_ = 1.0);

      std::size_t get_number_of_components() const;

      virtual bool has_explicit_domain_of_definition() const;

      virtual bool is_in_domain_of_definition(double x_) const;

      virtual double get_non_zero_domain_min() const;

      virtual double get_non_zero_domain_max() 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();

      double _eval(double x_) const;

    private:

      void _init_();

      void _reset_();

      void _recompute_();

    private:

      // Management:
      bool _initialized_ = false; 

      // Working data:
      bool _explicit_domain_of_definition_ = false;
      double _non_zero_domain_min_; 
      double _non_zero_domain_max_; 

      struct component_record;
      std::vector<component_record> _components_; 

      MYGSL_UNARY_FUNCTOR_REGISTRATION_INTERFACE(multi_signal_shape)

      
      DATATOOLS_CLONEABLE_DECLARATION(multi_signal_shape)

    };

  } // end of namespace signal

} // end of namespace mctools

#endif // MCTOOLS_SIGNAL_MULTI_SIGNAL_SHAPE_H

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