simple_linear_adc.h

Go to the documentation of this file.

/* Author(s)     : Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date : 2016-10-01
 * Last modified : 2016-10-02
 *
 * 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:
 *
 *   Simple linear ADC (Analog/Digital Converter).
 *
 */

#ifndef MCTOOLS_DIGITIZATION_SIMPLE_LINEAR_ADC_H
#define MCTOOLS_DIGITIZATION_SIMPLE_LINEAR_ADC_H

// Standard library:
#include <limits>

// Third party:
// - Bayeux/datatools:
#include <datatools/properties.h>
#include <datatools/i_tree_dump.h>

// This project:
#include <mctools/digitization/i_adc.h>

namespace mctools {

  namespace digitization {

    class simple_linear_adc
      : public i_adc
      , public datatools::i_tree_dumpable
    {
    public:

      static const int32_t INVALID_CHANNEL = std::numeric_limits<int32_t>::min();

      simple_linear_adc();

      virtual ~simple_linear_adc();

      void set_v_ref_low(const double);

      double get_v_ref_low() const;

      void set_v_ref_high(const double);

      double get_v_ref_high() const;

      void set_nbits(const uint16_t);

      uint16_t get_nbits()const;

      void set_signed(bool);

      void set_no_underflow(bool n_);

      bool is_no_underflow() const;

      void set_no_overflow(bool n_);

      bool is_no_overflow() const;

      void set_underflow_channel(int32_t);

      int32_t get_underflow_channel() const;

      void set_overflow_channel(int32_t);

      int32_t get_overflow_channel() const;

      bool is_signed() const;

      bool is_initialized() const;

      void initialize_simple();

      void initialize(const datatools::properties & config_);

      void reset();

      double compute_sampled_voltage(int32_t channel_, bool ignore_out_ = false) const;

      virtual int32_t quantize(const double vinput_) const;

      int32_t get_min_channel() const;

      int32_t get_max_channel() const;

      uint32_t get_number_of_voltage_intervals() const;

      double get_voltage_resolution() const;

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

      DR_CLASS_RTTI()

    protected:

      void _set_defaults();

      void _compute_working_data();

    private:

      // Management
      bool _initialized_ = false;

      // Configuration parameters:
      double   _v_ref_low_;         
      double   _v_ref_high_;        
      uint16_t _nbits_ = 0;         
      bool     _signed_ = false;    
      bool     _no_underflow_ = false; 
      bool     _no_overflow_ = false; 
      int32_t  _underflow_channel_; 
      int32_t  _overflow_channel_;  

      // Working data:
      int32_t _min_channel_; 
      int32_t _max_channel_; 
      uint32_t _number_of_voltage_intervals_; 
      double _efsr_;  
      double _q_;     
      double _v0_;    

    };

  } // end of namespace digitization

} // end of namespace mctools

// Activate reflection layer :
DR_CLASS_INIT(::mctools::digitization::simple_linear_adc)

#endif // MCTOOLS_DIGITIZATION_SIMPLE_LINEAR_ADC_H

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