Surface.h

Go to the documentation of this file.

//==========================================================================
//  AIDA Detector description implementation 
//--------------------------------------------------------------------------
// Copyright (C) Organisation europeenne pour la Recherche nucleaire (CERN)
// All rights reserved.
//
// For the licensing terms see $DD4hepINSTALL/LICENSE.
// For the list of contributors see $DD4hepINSTALL/doc/CREDITS.
//
// Author     : F.Gaede
//
//==========================================================================
#ifndef DDREC_SURFACE_H
#define DDREC_SURFACE_H

#include "DD4hep/Objects.h"
#include "DD4hep/Volumes.h"
#include "DD4hep/DetElement.h"

#include "DDRec/ISurface.h"
#include "DDRec/Material.h"

#include <list>
#include <memory>

class TGeoMatrix ;

namespace dd4hep {
  namespace rec {
  
    //-------------------------------------------------------------------------------------------

    class VolSurface  ;

    class VolSurfaceBase : public ISurface {
      
      friend class VolSurface ;

    protected:
      SurfaceType _type {};
      Vector3D _u {};
      Vector3D _v {};
      Vector3D _n {};
      Vector3D _o {};
      double _th_i {0};
      double _th_o {0};
      MaterialData _innerMat {};
      MaterialData _outerMat {};    
      Volume _vol {};
      long64 _id {0};
      unsigned _refCount {0};

      virtual void setU(const Vector3D& u) ;
      virtual void setV(const Vector3D& v) ;
      virtual void setNormal(const Vector3D& n) ;
      virtual void setOrigin(const Vector3D& o) ;

    public:
    
      virtual ~VolSurfaceBase() = default;


      VolSurfaceBase() = default;
      
      VolSurfaceBase( SurfaceType typ, 
                      double thickness_inner ,double thickness_outer, 
                      Vector3D u_val ,Vector3D v_val ,
                      Vector3D n ,Vector3D o, Volume vol,int identifier ) : 
        _type(typ ) ,
        _u( u_val ) ,
        _v( v_val ) ,
        _n( n ) ,
        _o( o ),
        _th_i( thickness_inner ),
        _th_o( thickness_outer ),  
        _vol(vol) ,
        _id( identifier ) {
      }
      
      
      VolSurfaceBase(const VolSurfaceBase& c) 
        : _type(c._type), _u(c._u), _v(c._v), _n(c._n), _o(c._o),
          _th_i(c._th_i), _th_o(c._th_o), _innerMat(c._innerMat),
          _outerMat(c._innerMat), _vol(c._vol), _id(c._id)
      {
      }

      Volume volume() const { return _vol ; }

      virtual long64 id() const  ;

      virtual const SurfaceType& type() const ;
    
      //==== geometry ====
      
      virtual Vector3D u( const Vector3D& point = Vector3D() ) const ;
    
      virtual Vector3D v(const Vector3D& point = Vector3D() ) const ;
    
      virtual Vector3D normal(const Vector3D& point = Vector3D() ) const ;
    
      virtual const Vector3D& origin() const ;
      
      virtual Vector2D globalToLocal( const Vector3D& point) const ;
      
      virtual Vector3D localToGlobal( const Vector2D& point) const ;
      
      virtual const IMaterial& innerMaterial() const ;

      virtual const IMaterial& outerMaterial() const ;
    
      virtual double innerThickness() const ;

      virtual double outerThickness() const ;


      virtual double length_along_u() const ;

      virtual double length_along_v() const ;


      virtual double distance(const Vector3D& point ) const ;
      
      virtual bool insideBounds(const Vector3D& point, double epsilon=1e-4 ) const ;


      virtual std::vector< std::pair<Vector3D, Vector3D> > getLines(unsigned nMax=100) ;
 
      void setInnerMaterial( const IMaterial& mat ){ _innerMat = mat ; }

      void setOuterMaterial( const IMaterial& mat ){ _outerMat = mat ; }

    };

    //---------------------------------------------------------------------------------------------
    class VolSurface : public ISurface {
    
    protected:

      VolSurfaceBase* _surf ;

    public:
    
      virtual ~VolSurface(){
        if( _surf ) {
          -- _surf->_refCount ;
          if(  _surf->_refCount == 0 ) delete _surf ;
        }
      } 
      VolSurface() : _surf(0) { }

      VolSurface(VolSurfaceBase* p) : _surf( p ) { ++ _surf->_refCount ; }

      VolSurface(const VolSurface& vsurf) : _surf( vsurf._surf ) {
        ++ _surf->_refCount ;
      }
      
      VolSurface& operator=(const VolSurface& vsurf) {
        _surf = vsurf._surf ;
        ++ _surf->_refCount ;
        return *this ;
      }
      

      Volume volume() const { return _surf->volume() ; }

      VolSurfaceBase* ptr() const { return _surf ; }    
      
      virtual long64 id() const  ;

      virtual const SurfaceType& type() const ;
    
      //==== geometry ====
      
      virtual Vector3D u( const Vector3D& point = Vector3D() ) const ;
    
      virtual Vector3D v(const Vector3D& point = Vector3D() ) const ;
    
      virtual Vector3D normal(const Vector3D& point = Vector3D() ) const ;
    
      virtual const Vector3D& origin() const ;
      
      virtual Vector2D globalToLocal( const Vector3D& point) const ;
      
      virtual Vector3D localToGlobal( const Vector2D& point) const ;
      
      virtual const IMaterial& innerMaterial() const ;

      virtual const IMaterial& outerMaterial() const ;
    
      virtual double innerThickness() const ;

      virtual double outerThickness() const ;


      virtual double length_along_u() const ;

      virtual double length_along_v() const ;

      virtual double distance(const Vector3D& point ) const ;
      
      virtual bool insideBounds(const Vector3D& point, double epsilon=1e-4 ) const ;

      virtual std::vector< std::pair<Vector3D, Vector3D> > getLines(unsigned nMax=100) ;
 
      void setInnerMaterial( const IMaterial& mat ){ _surf->setInnerMaterial( mat ) ; }

      void setOuterMaterial( const IMaterial& mat ){  _surf->setOuterMaterial( mat ) ; }

    };

    //======================================================================================================


    struct VolSurfaceList ;
    VolSurfaceList* volSurfaceList( DetElement& det) ;

    struct VolSurfaceList : std::list< VolSurface > {
    
      VolSurfaceList() {}

      // required c'tor for extension mechanism
      VolSurfaceList(DetElement& det){

        VolSurfaceList* sL = volSurfaceList( det ) ; 

        std::copy( this->end() , sL->begin() , sL->end() ) ;
      }


      // required c'tor for extension mechanism
      VolSurfaceList(const VolSurfaceList& vsl, DetElement& /*det*/ ){
    
        this->insert( this->end() , vsl.begin() , vsl.end() ) ;
      }
    
      virtual ~VolSurfaceList() ;

    } ;
  

    //======================================================================================================

    class VolPlaneImpl : public VolSurfaceBase {
      
    public:
      
      VolPlaneImpl() : VolSurfaceBase() { }

      VolPlaneImpl( SurfaceType typ, double thickness_inner ,double thickness_outer, 
                    Vector3D u_val ,Vector3D v_val ,Vector3D n_val , Vector3D o_val, Volume vol, int id_val  ) :
    
        VolSurfaceBase( typ, thickness_inner, thickness_outer, u_val,v_val, n_val, o_val, vol, id_val ) {
    
        _type.setProperty( SurfaceType::Plane    , true ) ;
        _type.setProperty( SurfaceType::Cylinder , false ) ;
        _type.setProperty( SurfaceType::Cone     , false ) ;
        _type.checkParallelToZ( *this ) ;
        _type.checkOrthogonalToZ( *this ) ;
      }      
      
      virtual double distance(const Vector3D& point ) const  ;
    } ;

    //======================================================================================================
    class VolCylinderImpl : public VolSurfaceBase {
      
    public:
      
      VolCylinderImpl() : VolSurfaceBase() { }

      
      VolCylinderImpl( Volume vol, SurfaceType type, double thickness_inner ,double thickness_outer,  Vector3D origin ) ;

      virtual Vector3D u( const Vector3D& point = Vector3D() ) const ;
      
      virtual Vector3D normal(const Vector3D& point = Vector3D() ) const ;

      virtual double distance(const Vector3D& point ) const  ;
      
      virtual Vector2D globalToLocal( const Vector3D& point) const ;
      
      virtual Vector3D localToGlobal( const Vector2D& point) const ;
    } ;

    //======================================================================================================
    class VolConeImpl : public VolSurfaceBase {
      
      //internal helper variables
      double _ztip ;     // z position of the tip in the volume coordinate system
      double _zt0 ;      // z distance of the front face from the tip
      double _zt1 ;      // z distance of the back face from the tip
      double _tanTheta ; // tan of half the openeing angle 

    public:
      
      VolConeImpl() : VolSurfaceBase() { }
      
      
      VolConeImpl( Volume vol, SurfaceType type, double thickness_inner ,double thickness_outer,
                   Vector3D v, Vector3D origin ) ;
      
      virtual Vector3D u( const Vector3D& point = Vector3D() ) const ;

      virtual Vector3D v( const Vector3D& point = Vector3D() ) const ;
      
      virtual Vector3D normal(const Vector3D& point = Vector3D() ) const ;

      virtual double distance(const Vector3D& point ) const  ;
      
      virtual Vector2D globalToLocal( const Vector3D& point) const ;
      
      virtual Vector3D localToGlobal( const Vector2D& point) const ;

      virtual std::vector< std::pair<Vector3D, Vector3D> > getLines(unsigned nMax=100) ;
    } ;



    //======================================================================================================
    
    template <class T>
    class VolSurfaceHandle : public VolSurface {
      
    public:
      VolSurfaceHandle( Volume vol, SurfaceType typ, double thickness_inner ,double thickness_outer, 
                        Vector3D u_val ,Vector3D v_val ,Vector3D n_val , Vector3D o_val = Vector3D(0.,0.,0.) ) :
    
        VolSurface(  new T( typ, thickness_inner, thickness_outer, u_val, v_val, n_val, o_val, vol , 0 )  ){
      }
      
      T* operator->() { return static_cast<T*>( _surf ) ; }
    } ;

    //---------------------------------------------------------------------------------------------
    typedef VolSurfaceHandle< VolPlaneImpl > VolPlane ;
    //---------------------------------------------------------------------------------------------

    class VolCylinder : public VolSurface{
    public:
      VolCylinder( Volume vol, SurfaceType typ_val, double thickness_inner ,double thickness_outer,  Vector3D origin_val ) :
        VolSurface( new VolCylinderImpl( vol,  typ_val,  thickness_inner , thickness_outer, origin_val ) ) {}
    } ;

    class VolCone : public VolSurface{
    public:
      VolCone( Volume vol, SurfaceType typ_val, double thickness_inner ,double thickness_outer, Vector3D v_val, Vector3D origin_val ) :
        VolSurface( new VolConeImpl( vol,  typ_val,  thickness_inner , thickness_outer, v_val,  origin_val ) ) {}
    } ;

    //======================================================================================================
    
    class Surface:  public ISurface {
      
    protected:
      
      DetElement _det ;
      mutable VolSurface _volSurf ;
      std::unique_ptr<TGeoMatrix> _wtM ; // matrix for world transformation of surface
      
      long64 _id {0};
      
      SurfaceType _type {};
      Vector3D _u {};
      Vector3D _v {};
      Vector3D _n {};
      Vector3D _o {};

      Surface() = delete;
      Surface( Surface const& ) = delete;
      Surface& operator=( Surface const& ) = delete;

    public:
    
      virtual ~Surface() {} 

      Surface( DetElement det, VolSurface volSurf ) ;      
    
      virtual long64 id() const ;

      virtual const SurfaceType& type() const ;
    
      Volume volume() const { return _volSurf.volume()  ; }

      VolSurface volSurface() const { return _volSurf ; }

      DetElement detElement() const { return _det; }


      //==== geometry ====
      
      virtual Vector3D u( const Vector3D& point = Vector3D() ) const ;
    
      virtual Vector3D v(const Vector3D& point = Vector3D() ) const ;
    
      virtual  Vector3D normal(const Vector3D& point = Vector3D() ) const ;
    
      virtual const Vector3D& origin() const ;

      virtual Vector2D globalToLocal( const Vector3D& point) const ;
      
      virtual Vector3D localToGlobal( const Vector2D& point) const ;

      virtual double innerThickness() const ;

      virtual double outerThickness() const ;

      virtual const IMaterial& innerMaterial() const ;
     
      virtual const IMaterial& outerMaterial() const ;
          
      virtual double distance(const Vector3D& point ) const  ;
      
      virtual bool insideBounds(const Vector3D& point, double epsilon=1.e-4) const ;

      virtual Vector3D volumeOrigin() const  ; 

      virtual double length_along_u() const ;

      virtual double length_along_v() const ;

      virtual std::vector< std::pair< Vector3D, Vector3D> > getLines(unsigned nMax=100) ;

    protected:
      void initialize() ;

    };

    //======================================================================================================

    class CylinderSurface:  public Surface, public ICylinder {

    public:

      CylinderSurface( DetElement det, VolSurface volSurf ) : Surface( det, volSurf ) { }      
      
      virtual Vector3D u( const Vector3D& point = Vector3D() ) const ;
    
      virtual Vector3D v(const Vector3D& point = Vector3D() ) const ;
    
      virtual Vector3D normal(const Vector3D& point = Vector3D() ) const ;
 
      virtual Vector2D globalToLocal( const Vector3D& point) const ;
      
      virtual Vector3D localToGlobal( const Vector2D& point) const ;

      virtual double radius() const ;

      virtual Vector3D center() const ;

    } ;
    //======================================================================================================

    class ConeSurface : public CylinderSurface, public ICone {
    public:      
      ConeSurface( DetElement det, VolSurface volSurf ) : CylinderSurface( det, volSurf ) { }      
      
      virtual double radius0() const ;
      
      virtual double radius1() const ;

      virtual double z0() const ;
      
      virtual double z1() const ;
      
      virtual Vector3D center() const ;
     
    };
    //======================================================================================================
    class SurfaceList : public std::list< ISurface* > {
    
    protected:
      bool _isOwner {false};

    public:
      SurfaceList() = default;
      SurfaceList(bool isOwner ) : _isOwner( isOwner )  {}
      SurfaceList(const SurfaceList& other ) = default;
      SurfaceList(const DetElement& ) {}
      SurfaceList(const SurfaceList& ,const DetElement& ) {}    
      virtual ~SurfaceList();
    };
  
    //    SurfaceList* surfaceList( DetElement& det ) ;

    //======================================================================================================

  
  } /* namespace */
} /* namespace */



#endif // DDREC_SURFACE_H