Fiber.h

Go to the documentation of this file.

#ifndef _mdet_Fiber_h
#define _mdet_Fiber_h

#include <det/MPositionable.h>
#include <mdet/MDetectorComponent.h>

#include <det/VManager.h>
#include <det/MPositionable.h>
#include <mdet/MComponentGroup.h>
#include <mdet/MDetectorComponent.h>
#include <mdet/Scintillator.h>
#include <mdet/Fiber.h>
#include <mdet/Pixel.h>
#include <utl/Point.h>
#include <utl/CoordinateSystemPtr.h>
#include <utl/Validated.h>
#include <utl/AugerException.h>
#include <utl/ConsecutiveEnumFactory.h>


namespace mdet {

  class Module;

  class Fiber :
     public MDetectorComponent<Fiber>::Type,
     public det::MPositionable<Fiber>
  {
  public:

    static const char* const kComponentName;

    static const char* const kComponentId;
    /*
     * Possible further methods.
     *
     * bool Contains(const utl::Point& point) const;
     * bool IntersectedBy(const utl::Line& line) const;
     * utl::Vector ComputeIntersectionWith(const utl::Line& line) const;
     */
    template<class V>
    V& VisitShape(V& v) const {
      // Up to now, just a cylinder: the onManifoldLength is disregarded.
      v.Cylinder(*this, GetOnScintillatorLength(), GetRadius());
      return v;
    }

    double GetOnManifoldLength() const;
    double GetNumericalAperture() const;
    double GetRefractionIndex() const;
    double ComputeDecayDelay() const; 
    double GetDecayDelayMean() const;
    double GetDecayDelayStdDev() const;
    unsigned int ComputeSPENumber(double x, double l, double e) const;
    const Module& GetModule() const {
      return fModule;
    }
  private:
    utl::CoordinateSystemPtr GetReferenceCoordinateSystem() const;
    double GetDecayTime() const;
    double GetOnScintillatorLength() const;
    double GetRadius() const;
    enum AttenuationReference { 
      eThickness, 
      eEnergy     
    };
    AttenuationReference GetAttenuationReference() const;

    static const char * const AttenuationReferenceTags[];
    // See the following friendship: repeats class name.
    typedef utl::ConsecutiveEnumFactory<AttenuationReference, eEnergy, AttenuationReferenceTags> 
      AttenuationReferenceCreator;
    /*
     * It isn't possible to define friendship through a typedef: so we need a little verbosity here.
     * http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2005/n1791.pdf 
     */
    // See the previous typedef: repeats class name.
    friend class utl::ConsecutiveEnumFactory<AttenuationReference, eEnergy, AttenuationReferenceTags>;

    double GetAttenuationLengthA() const;
  
    double GetAttenuationLengthB() const;

    double GetAttenuationAmplitudeA() const;
  
    double GetAttenuationAmplitudeB() const;

    double GetAttenuationLengthASiPM() const;

    double GetAttenuationLengthBSiPM() const;

    double GetAttenuationAmplitudeASiPM() const;

    double GetAttenuationAmplitudeBSiPM() const;

    double GetAttenuationReferenceThickness() const;

    double GetAttenuationReferenceEnergy() const;

    Fiber(int fId, const det::VManager::IndexMap& parentMap, const Module& parent);
    ~Fiber(){ }  
    friend class det::MPositionable<Fiber>;
    friend struct det::ParentCreator;
    template<class T>
    friend void boost::checked_delete(T*) BOOST_NOEXCEPT;
    friend struct det::ComponentUpdater;

    mutable utl::Validated<double> fOnScintillatorLength;

    mutable utl::Validated<double> fOnManifoldLength;

    mutable utl::Validated<double> fNumericalAperture;

    mutable utl::Validated<double> fRadius;

    mutable utl::Validated<double> fRefractionIndex;

    mutable utl::Validated<double> fDecayTime;

    mutable utl::Validated<double> fAttenuationLengthA;
  
    mutable utl::Validated<double> fAttenuationLengthB;

    mutable utl::Validated<double> fAttenuationAmplitudeA;
  
    mutable utl::Validated<double> fAttenuationAmplitudeB;

    mutable utl::Validated<double> fAttenuationLengthASiPM;

    mutable utl::Validated<double> fAttenuationLengthBSiPM;

    mutable utl::Validated<double> fAttenuationAmplitudeASiPM;

    mutable utl::Validated<double> fAttenuationAmplitudeBSiPM;

    mutable utl::Validated<double> fAttenuationReferenceThickness;

    mutable utl::Validated<double> fAttenuationReferenceEnergy;

    typedef std::string AttenuationReferenceForConfig;

    mutable utl::Validated<AttenuationReferenceForConfig> fAttenuationReference;

    const Module& fModule; 
    
    /* 
     * Other possible further properties:
     * double GetTrappingEficiency() const;
     * double GetLightYield() const;
     */

  };

}

#endif // _mdet_Fiber_h