DD4hep  1.30.0
Detector Description Toolkit for High Energy Physics
CartesianGridXY.cpp
Go to the documentation of this file.
1 //==========================================================================
2 // AIDA Detector description implementation
3 //--------------------------------------------------------------------------
4 // Copyright (C) Organisation europeenne pour la Recherche nucleaire (CERN)
5 // All rights reserved.
6 //
7 // For the licensing terms see $DD4hepINSTALL/LICENSE.
8 // For the list of contributors see $DD4hepINSTALL/doc/CREDITS.
9 //
10 // Created: Jun 28, 2013
11 // Author: Christian Grefe, CERN
12 //
13 //==========================================================================
14 
17 
18 namespace dd4hep {
19 
20  namespace DDSegmentation {
21 
23 CartesianGridXY::CartesianGridXY(const std::string& cellEncoding) :
24  CartesianGrid(cellEncoding) {
25  // define type and description
26  _type = "CartesianGridXY";
27  _description = "Cartesian segmentation in the local XY-plane";
28 
29  // register all necessary parameters
30  registerParameter("grid_size_x", "Cell size in X", _gridSizeX, 1., SegmentationParameter::LengthUnit);
31  registerParameter("grid_size_y", "Cell size in Y", _gridSizeY, 1., SegmentationParameter::LengthUnit);
32  registerParameter("offset_x", "Cell offset in X", _offsetX, 0., SegmentationParameter::LengthUnit, true);
33  registerParameter("offset_y", "Cell offset in Y", _offsetY, 0., SegmentationParameter::LengthUnit, true);
34  registerIdentifier("identifier_x", "Cell ID identifier for X", _xId, "x");
35  registerIdentifier("identifier_y", "Cell ID identifier for Y", _yId, "y");
36 }
37 
40  CartesianGrid(decode)
41 {
42  // define type and description
43  _type = "CartesianGridXY";
44  _description = "Cartesian segmentation in the local XY-plane";
45 
46  // register all necessary parameters
47  registerParameter("grid_size_x", "Cell size in X", _gridSizeX, 1., SegmentationParameter::LengthUnit);
48  registerParameter("grid_size_y", "Cell size in Y", _gridSizeY, 1., SegmentationParameter::LengthUnit);
49  registerParameter("offset_x", "Cell offset in X", _offsetX, 0., SegmentationParameter::LengthUnit, true);
50  registerParameter("offset_y", "Cell offset in Y", _offsetY, 0., SegmentationParameter::LengthUnit, true);
51  registerIdentifier("identifier_x", "Cell ID identifier for X", _xId, "x");
52  registerIdentifier("identifier_y", "Cell ID identifier for Y", _yId, "y");
53 }
54 
57 
58 }
59 
62  Vector3D cellPosition;
63  cellPosition.X = binToPosition( _decoder->get(cID,_xId ), _gridSizeX, _offsetX);
64  cellPosition.Y = binToPosition( _decoder->get(cID,_yId ), _gridSizeY, _offsetY);
65  return cellPosition;
66 }
67 
70  const Vector3D& /* globalPosition */,
71  const VolumeID& vID) const {
72  CellID cID = vID;
73  _decoder->set( cID,_xId, positionToBin(localPosition.X, _gridSizeX, _offsetX) );
74  _decoder->set( cID,_yId, positionToBin(localPosition.Y, _gridSizeY, _offsetY) );
75  return cID;
76 }
77 
78  std::vector<double> CartesianGridXY::cellDimensions(const CellID& /* cellID */) const {
79 #if __cplusplus >= 201103L
80  return {_gridSizeX, _gridSizeY};
81 #else
82  std::vector<double> cellDims(2,0.0);
83  cellDims[0] = _gridSizeX;
84  cellDims[1] = _gridSizeY;
85  return cellDims;
86 #endif
87 }
88 
89 
90 } /* namespace DDSegmentation */
91 } /* namespace dd4hep */
92 
93 // This is done DDCore/src/plugins/ReadoutSegmentations.cpp so the plugin is not part of libDDCore
94 // needs also #include <DD4hep/Factories.h>
95 // DECLARE_SEGMENTATION(CartesianGridXY,dd4hep::create_segmentation<dd4hep::DDSegmentation::CartesianGridXY>)
dd4hep::DDSegmentation::VolumeID
uint64_t VolumeID
Definition: BitFieldCoder.h:27
dd4hep::DDSegmentation::CartesianGridXY::_offsetY
double _offsetY
the coordinate offset in Y
Definition: CartesianGridXY.h:107
dd4hep::DDSegmentation::Segmentation::_decoder
const BitFieldCoder * _decoder
The cell ID encoder and decoder.
Definition: Segmentation.h:168
dd4hep::DDSegmentation::CartesianGridXY::~CartesianGridXY
virtual ~CartesianGridXY()
destructor
Definition: CartesianGridXY.cpp:56
dd4hep::DDSegmentation::CartesianGridXY::_yId
std::string _yId
the field name used for Y
Definition: CartesianGridXY.h:111
dd4hep::DDSegmentation::Vector3D
Simple container for a physics vector.
Definition: Segmentation.h:48
dd4hep::DDSegmentation::CartesianGridXY::position
virtual Vector3D position(const CellID &cellID) const
determine the position based on the cell ID
Definition: CartesianGridXY.cpp:61
dd4hep::DDSegmentation::CartesianGridXY::_gridSizeY
double _gridSizeY
the grid size in Y
Definition: CartesianGridXY.h:105
dd4hep::DDSegmentation::SegmentationParameter::LengthUnit
@ LengthUnit
Definition: SegmentationParameter.h:111
dd4hep::DDSegmentation::BitFieldCoder
Helper class for decoding and encoding a bit field of 64bits for convenient declaration.
Definition: BitFieldCoder.h:114
dd4hep::DDSegmentation::BitFieldCoder::get
FieldID get(CellID bitfield, size_t idx) const
Definition: BitFieldCoder.h:165
dd4hep::DDSegmentation::CartesianGridXY::_offsetX
double _offsetX
the coordinate offset in X
Definition: CartesianGridXY.h:103
CartesianGridXY.h
dd4hep::DDSegmentation::Segmentation::registerParameter
void registerParameter(const std::string &nam, const std::string &desc, TYPE &param, const TYPE &defaultVal, UnitType unitTyp=SegmentationParameter::NoUnit, bool isOpt=false)
Add a parameter to this segmentation. Used by derived classes to define their parameters.
Definition: Segmentation.h:138
dd4hep::DDSegmentation::Vector3D::Y
double Y
Definition: Segmentation.h:71
dd4hep::DDSegmentation::BitFieldCoder::set
void set(CellID &bitfield, size_t idx, FieldID value) const
Definition: BitFieldCoder.h:177
dd4hep::DDSegmentation::CellID
uint64_t CellID
Definition: BitFieldCoder.h:26
dd4hep::DDSegmentation::Segmentation::registerIdentifier
void registerIdentifier(const std::string &nam, const std::string &desc, std::string &ident, const std::string &defaultVal)
Add a cell identifier to this segmentation. Used by derived classes to define their required identifi...
Definition: Segmentation.cpp:135
dd4hep::DDSegmentation::Segmentation::_description
std::string _description
The description of the segmentation.
Definition: Segmentation.h:162
dd4hep::DDSegmentation::CartesianGridXY::cellDimensions
virtual std::vector< double > cellDimensions(const CellID &cellID) const
Returns a vector<double> of the cellDimensions of the given cell ID in natural order of dimensions,...
Definition: CartesianGridXY.cpp:78
dd4hep::DDSegmentation::Segmentation::positionToBin
static int positionToBin(double position, double cellSize, double offset=0.)
Helper method to convert a 1D position to a cell ID.
Definition: Segmentation.cpp:150
dd4hep::DDSegmentation::Vector3D::X
double X
Definition: Segmentation.h:71
dd4hep::DDSegmentation::Segmentation::binToPosition
static double binToPosition(FieldID bin, double cellSize, double offset=0.)
Helper method to convert a bin number to a 1D position.
Definition: Segmentation.cpp:145
dd4hep::DDSegmentation::CartesianGridXY::cellID
virtual CellID cellID(const Vector3D &localPosition, const Vector3D &globalPosition, const VolumeID &volumeID) const
determine the cell ID based on the position
Definition: CartesianGridXY.cpp:69
dd4hep
Namespace for the AIDA detector description toolkit.
Definition: AlignmentsCalib.h:28
dd4hep::DDSegmentation::Segmentation::_type
std::string _type
The segmentation type.
Definition: Segmentation.h:160
dd4hep::DDSegmentation::CartesianGridXY::_gridSizeX
double _gridSizeX
the grid size in X
Definition: CartesianGridXY.h:101
dd4hep::DDSegmentation::CartesianGridXY::CartesianGridXY
CartesianGridXY(const std::string &cellEncoding="")
Default constructor passing the encoding string.
Definition: CartesianGridXY.cpp:23
dd4hep::DDSegmentation::CartesianGridXY::_xId
std::string _xId
the field name used for X
Definition: CartesianGridXY.h:109
dd4hep::DDSegmentation::CartesianGrid
Segmentation base class describing cartesian grid segmentation.
Definition: CartesianGrid.h:28