fluence_step_hit_processor.h

Go to the documentation of this file.

/* Author(s) :   Arnaud Chapon <chapon@lpccaen.in2p3.fr>
 * Creation date: 2014-10-09
 * Last modified: 2014-10-20
 *
 * License:
 *
 * Description:
 *
 *  A basic processor of simulated step hits through a detector surface.
 *
 *  This algorithm clusterizes step fluence hits (from a
 *  simulation program) and save only boundary ones. It records the particle
 *  type, geometry ID, entrance momentum and energy, ...)
 *
 *  CAUTION: this processor can manage only one geometry mapping category
 *  so care should be taken to attach only one geometry model (with the proper
 *  mapping category) to this processor.
 *
 */

#ifndef MCTOOLS_FLUENCE_STEP_HIT_PROCESSOR_H
#define MCTOOLS_FLUENCE_STEP_HIT_PROCESSOR_H 1

// Standard library:
#include <string>

// Third party:
// - Boost:
#include <boost/cstdint.hpp>
// - Bayeux/datatools:
#include <datatools/ioutils.h>
// - Bayeux/geomtools:
#include <geomtools/i_shape_3d.h>
#include <geomtools/smart_id_locator.h>
#include <geomtools/box.h>
#include <geomtools/sphere.h>
#include <geomtools/placement.h>

// This project:
#include <mctools/base_step_hit_processor.h>

namespace mctools {

  class fluence_step_hit_processor
    : public base_step_hit_processor
  {
  public:

    virtual bool locate_fluence_volume(const geomtools::vector_3d & position_,
                                       geomtools::geom_id & gid_) const;

    const std::string & get_mapping_category() const;

    void set_mapping_category(const std::string & sc_);

    const std::vector<int> & get_mapping_category_any_addresses() const;

    fluence_step_hit_processor();

    virtual ~fluence_step_hit_processor();

    virtual void initialize(const ::datatools::properties & config_,
                            ::datatools::service_manager & service_mgr_);

    virtual void process(const ::mctools::base_step_hit_processor::step_hit_ptr_collection_type & base_step_hits_,
                         ::mctools::simulated_data::hit_handle_collection_type & handle_hits_);

    virtual void process(const ::mctools::base_step_hit_processor::step_hit_ptr_collection_type & base_step_hits_,
                         ::mctools::simulated_data::hit_collection_type & plain_hits_);

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

    static void init_ocd(datatools::object_configuration_description &);

  protected:

    void _init(const ::datatools::properties & config_,
               ::datatools::service_manager & service_mgr_);

    void _process(const base_step_hit_processor::step_hit_ptr_collection_type & base_step_hits_,
                  simulated_data::hit_handle_collection_type * fluence_hits_,
                  simulated_data::hit_collection_type * plain_fluence_hits_);

  private:

    std::string _mapping_category_; 
    std::vector<int> _mapping_category_any_addresses_; 
    // internals:
    const geomtools::mapping * _mapping_; 

    const geomtools::id_mgr::categories_by_name_col_type * _categories_; 

    uint32_t _fluence_volume_type_; 

    geomtools::smart_id_locator _fluence_volume_locator_;

    // Registration macro :
    MCTOOLS_STEP_HIT_PROCESSOR_REGISTRATION_INTERFACE(fluence_step_hit_processor)

  };

} // end of namespace mctools

#include <datatools/ocd_macros.h>
DOCD_CLASS_DECLARATION(mctools::fluence_step_hit_processor)

#endif // MCTOOLS_FLUENCE_STEP_HIT_PROCESSOR_H

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