include/DD4hep/CartesianGridYZ.h

0001 //==========================================================================
0002 //  AIDA Detector description implementation
0003 //--------------------------------------------------------------------------
0004 // Copyright (C) Organisation europeenne pour la Recherche nucleaire (CERN)
0005 // All rights reserved.
0006 //
0007 // For the licensing terms see $DD4hepINSTALL/LICENSE.
0008 // For the list of contributors see $DD4hepINSTALL/doc/CREDITS.
0009 //
0010 //  \author   Markus Frank
0011 //  \date     2016-10-18
0012 //  \version  1.0
0013 //
0014 //==========================================================================
0015 #ifndef DD4HEP_CARTESIANGRIDYZ_H
0016 #define DD4HEP_CARTESIANGRIDYZ_H 1
0017
0018 // Framework include files
0019 #include <DD4hep/Segmentations.h>
0020
0021 /// Namespace for the AIDA detector description toolkit
0022 namespace dd4hep {
0023
0024   /// Namespace for base segmentations
0025   namespace DDSegmentation  {    class CartesianGridYZ;  }
0026
0027   /// We need some abbreviation to make the code more readable.
0028   typedef Handle<SegmentationWrapper<DDSegmentation::CartesianGridYZ> > CartesianGridYZHandle;
0029
0030   /// Implementation class for the grid YZ segmentation.
0031   /**
0032    *  Concrete user handle to serve specific needs of client code
0033    *  which requires access to the base functionality not served
0034    *  by the super-class Segmentation.
0035    *
0036    *  Note:
0037    *  We only check the validity of the underlying handle.
0038    *  If for whatever reason the implementation object is not valid
0039    *  This is not checked.
0040    *  In principle this CANNOT happen unless some brain-dead has
0041    *  fiddled with the handled object directly.....
0042    *
0043    *  Note:
0044    *  The handle base corresponding to this object in for
0045    *  conveniance reasons instantiated in dd4hep/src/Segmentations.cpp.
0046    *
0047    *  \author  M.Frank
0048    *  \version 1.0
0049    *  \ingroup DD4HEP_CORE
0050    */
0051   class CartesianGridYZ : public CartesianGridYZHandle  {
0052   public:
0053     /// Default constructor
0054     CartesianGridYZ() = default;
0055     /// Copy constructor
0056     CartesianGridYZ(const CartesianGridYZ& e) = default;
0057     /// Copy Constructor from segmentation base object
0058     CartesianGridYZ(const Segmentation& e) : Handle<Object>(e) {}
0059     /// Copy constructor from handle
0060     CartesianGridYZ(const Handle<Object>& e) : Handle<Object>(e) {}
0061     /// Copy constructor from other polymorph/equivalent handle
0062     template <typename Q>
0063     CartesianGridYZ(const Handle<Q>& e) : Handle<Object>(e) { }
0064     /// Assignment operator
0065     CartesianGridYZ& operator=(const CartesianGridYZ& seg) = default;
0066     /// Equality operator
0067     bool operator==(const CartesianGridYZ& seg) const
0068     {  return m_element == seg.m_element;        }
0069     /// determine the position based on the cell ID
0070     Position position(const CellID& cellID) const;
0071     /// determine the cell ID based on the position
0072     CellID cellID(const Position& local, const Position& global, const VolumeID& volID) const;
0073     /// access the grid size in Y
0074     double gridSizeY() const;
0075     /// access the grid size in Z
0076     double gridSizeZ() const;
0077     /// set the grid size in Y
0078     void setGridSizeY(double cellSize) const;
0079     /// set the grid size in Z
0080     void setGridSizeZ(double cellSize) const;
0081     /// access the coordinate offset in Y
0082     double offsetY() const;
0083     /// access the coordinate offset in Z
0084     double offsetZ() const;
0085     /// set the coordinate offset in Y
0086     void setOffsetY(double offset) const;
0087     /// set the coordinate offset in Z
0088     void setOffsetZ(double offset) const;
0089     /// access the field name used for X
0090     const std::string& fieldNameX() const;
0091     /// access the field name used for Y
0092     const std::string& fieldNameY() const;
0093     /// access the field name used for Z
0094     const std::string& fieldNameZ() const;
0095     /** \brief Returns a vector<double> of the cellDimensions of the given cell ID
0096      *  in natural order of dimensions, e.g., dx/dy/dz, or dr/r*dPhi
0097      *
0098      *  Returns a vector of the cellDimensions of the given cell ID
0099      *  \param cellID is ignored as all cells have the same dimension
0100      *  \return std::vector<double> size 2:
0101      *  -# size in y
0102      *  -# size in z
0103      */
0104     std::vector<double> cellDimensions(const CellID& cellID) const;
0105   };
0106 }       /* End namespace dd4hep                */
0107 #endif // DD4HEP_CARTESIANGRIDYZ_H