DD4hep  1.30.0
Detector Description Toolkit for High Energy Physics
Public Member Functions | Protected Attributes | List of all members
dd4hep::DDSegmentation::CartesianGridXY Class Reference

Segmentation base class describing cartesian grid segmentation in the X-Y plane. More...

#include <CartesianGridXY.h>

Inheritance diagram for dd4hep::DDSegmentation::CartesianGridXY:
dd4hep::DDSegmentation::CartesianGrid dd4hep::DDSegmentation::Segmentation dd4hep::DDSegmentation::CartesianGridXYZ

Public Member Functions

 CartesianGridXY (const std::string &cellEncoding="")
 Default constructor passing the encoding string. More...
 
 CartesianGridXY (const BitFieldCoder *decoder)
 Default constructor used by derived classes passing an existing decoder. More...
 
virtual ~CartesianGridXY ()
 destructor More...
 
virtual Vector3D position (const CellID &cellID) const
 determine the position based on the cell ID More...
 
virtual CellID cellID (const Vector3D &localPosition, const Vector3D &globalPosition, const VolumeID &volumeID) const
 determine the cell ID based on the position More...
 
double gridSizeX () const
 access the grid size in X More...
 
double gridSizeY () const
 access the grid size in Y More...
 
double offsetX () const
 access the coordinate offset in X More...
 
double offsetY () const
 access the coordinate offset in Y More...
 
const std::string & fieldNameX () const
 access the field name used for X More...
 
const std::string & fieldNameY () const
 access the field name used for Y More...
 
void setGridSizeX (double cellSize)
 set the grid size in X More...
 
void setGridSizeY (double cellSize)
 set the grid size in Y More...
 
void setOffsetX (double offset)
 set the coordinate offset in X More...
 
void setOffsetY (double offset)
 set the coordinate offset in Y More...
 
void setFieldNameX (const std::string &fieldName)
 set the field name used for X More...
 
void setFieldNameY (const std::string &fieldName)
 set the field name used for Y More...
 
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, e.g., dx/dy/dz, or dr/r*dPhi. More...
 
- Public Member Functions inherited from dd4hep::DDSegmentation::CartesianGrid
virtual ~CartesianGrid ()
 Destructor. More...
 
- Public Member Functions inherited from dd4hep::DDSegmentation::Segmentation
virtual ~Segmentation ()
 Destructor. More...
 
virtual void addSubsegmentation (long key_min, long key_max, Segmentation *entry)
 Add subsegmentation. Call only valid for Multi-segmentations. Default implementation throws an exception. More...
 
virtual VolumeID volumeID (const CellID &cellID) const
 Determine the volume ID from the full cell ID by removing all local fields. More...
 
virtual void neighbours (const CellID &cellID, std::set< CellID > &neighbours) const
 Calculates the neighbours of the given cell ID and adds them to the list of neighbours. More...
 
virtual std::string fieldDescription () const
 Access the encoding string. More...
 
virtual const std::string & name () const
 Access the segmentation name. More...
 
virtual void setName (const std::string &value)
 Set the segmentation name. More...
 
virtual const std::string & type () const
 Access the segmentation type. More...
 
virtual const std::string & description () const
 Access the description of the segmentation. More...
 
virtual const BitFieldCoderdecoder () const
 Access the underlying decoder. More...
 
virtual void setDecoder (const BitFieldCoder *decoder)
 Set the underlying decoder. More...
 
virtual Parameter parameter (const std::string &parameterName) const
 Access to parameter by name. More...
 
virtual Parameters parameters () const
 Access to all parameters. More...
 
virtual void setParameters (const Parameters &parameters)
 Set all parameters from an existing set of parameters. More...
 

Protected Attributes

double _gridSizeX
 the grid size in X More...
 
double _offsetX
 the coordinate offset in X More...
 
double _gridSizeY
 the grid size in Y More...
 
double _offsetY
 the coordinate offset in Y More...
 
std::string _xId
 the field name used for X More...
 
std::string _yId
 the field name used for Y More...
 
- Protected Attributes inherited from dd4hep::DDSegmentation::Segmentation
std::string _name
 The segmentation name. More...
 
std::string _type
 The segmentation type. More...
 
std::string _description
 The description of the segmentation. More...
 
std::map< std::string, Parameter_parameters
 The parameters for this segmentation. More...
 
std::map< std::string, StringParameter_indexIdentifiers
 The indices used for the encoding. More...
 
const BitFieldCoder_decoder = 0
 The cell ID encoder and decoder. More...
 
bool _ownsDecoder = false
 Keeps track of the decoder ownership. More...
 

Additional Inherited Members

- Protected Member Functions inherited from dd4hep::DDSegmentation::CartesianGrid
 CartesianGrid (const std::string &cellEncoding="")
 Default constructor used by derived classes passing the encoding string. More...
 
 CartesianGrid (const BitFieldCoder *decoder)
 Default constructor used by derived classes passing an existing decoder. More...
 
- Protected Member Functions inherited from dd4hep::DDSegmentation::Segmentation
 Segmentation (const std::string &cellEncoding="")
 Default constructor used by derived classes passing the encoding string. More...
 
 Segmentation (const BitFieldCoder *decoder)
 Default constructor used by derived classes passing an existing decoder. More...
 
template<typename TYPE >
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. More...
 
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 identifiers. More...
 
- Static Protected Member Functions inherited from dd4hep::DDSegmentation::Segmentation
static double binToPosition (FieldID bin, double cellSize, double offset=0.)
 Helper method to convert a bin number to a 1D position. More...
 
static int positionToBin (double position, double cellSize, double offset=0.)
 Helper method to convert a 1D position to a cell ID. More...
 
static double binToPosition (FieldID bin, std::vector< double > const &cellBoundaries, double offset=0.)
 Helper method to convert a bin number to a 1D position given a vector of binBoundaries. More...
 
static int positionToBin (double position, std::vector< double > const &cellBoundaries, double offset=0.)
 Helper method to convert a 1D position to a cell ID given a vector of binBoundaries. More...
 

Detailed Description

Segmentation base class describing cartesian grid segmentation in the X-Y plane.

Definition at line 27 of file CartesianGridXY.h.

Constructor & Destructor Documentation

◆ CartesianGridXY() [1/2]

dd4hep::DDSegmentation::CartesianGridXY::CartesianGridXY ( const std::string &  cellEncoding = "")

Default constructor passing the encoding string.

default constructor using an encoding string

Definition at line 23 of file CartesianGridXY.cpp.

◆ CartesianGridXY() [2/2]

dd4hep::DDSegmentation::CartesianGridXY::CartesianGridXY ( const BitFieldCoder decoder)

Default constructor used by derived classes passing an existing decoder.

Definition at line 39 of file CartesianGridXY.cpp.

◆ ~CartesianGridXY()

dd4hep::DDSegmentation::CartesianGridXY::~CartesianGridXY ( )
virtual

destructor

Definition at line 56 of file CartesianGridXY.cpp.

Member Function Documentation

◆ cellDimensions()

std::vector< double > dd4hep::DDSegmentation::CartesianGridXY::cellDimensions ( const CellID cellID) const
virtual

Returns a vector<double> of the cellDimensions of the given cell ID in natural order of dimensions, e.g., dx/dy/dz, or dr/r*dPhi.

Returns a vector of the cellDimensions of the given cell ID

Parameters
cellIDis ignored as all cells have the same dimension
Returns
std::vector<double> size 2:
  1. size in x
  2. size in y

Reimplemented from dd4hep::DDSegmentation::Segmentation.

Reimplemented in dd4hep::DDSegmentation::CartesianGridXYZ.

Definition at line 78 of file CartesianGridXY.cpp.

◆ cellID()

CellID dd4hep::DDSegmentation::CartesianGridXY::cellID ( const Vector3D localPosition,
const Vector3D globalPosition,
const VolumeID volumeID 
) const
virtual

determine the cell ID based on the position

Implements dd4hep::DDSegmentation::Segmentation.

Reimplemented in dd4hep::DDSegmentation::CartesianGridXYZ.

Definition at line 69 of file CartesianGridXY.cpp.

◆ fieldNameX()

const std::string& dd4hep::DDSegmentation::CartesianGridXY::fieldNameX ( ) const
inline

access the field name used for X

Definition at line 57 of file CartesianGridXY.h.

◆ fieldNameY()

const std::string& dd4hep::DDSegmentation::CartesianGridXY::fieldNameY ( ) const
inline

access the field name used for Y

Definition at line 61 of file CartesianGridXY.h.

◆ gridSizeX()

double dd4hep::DDSegmentation::CartesianGridXY::gridSizeX ( ) const
inline

access the grid size in X

Definition at line 41 of file CartesianGridXY.h.

◆ gridSizeY()

double dd4hep::DDSegmentation::CartesianGridXY::gridSizeY ( ) const
inline

access the grid size in Y

Definition at line 45 of file CartesianGridXY.h.

◆ offsetX()

double dd4hep::DDSegmentation::CartesianGridXY::offsetX ( ) const
inline

access the coordinate offset in X

Definition at line 49 of file CartesianGridXY.h.

◆ offsetY()

double dd4hep::DDSegmentation::CartesianGridXY::offsetY ( ) const
inline

access the coordinate offset in Y

Definition at line 53 of file CartesianGridXY.h.

◆ position()

Vector3D dd4hep::DDSegmentation::CartesianGridXY::position ( const CellID cellID) const
virtual

determine the position based on the cell ID

Implements dd4hep::DDSegmentation::Segmentation.

Reimplemented in dd4hep::DDSegmentation::CartesianGridXYZ.

Definition at line 61 of file CartesianGridXY.cpp.

◆ setFieldNameX()

void dd4hep::DDSegmentation::CartesianGridXY::setFieldNameX ( const std::string &  fieldName)
inline

set the field name used for X

Definition at line 81 of file CartesianGridXY.h.

◆ setFieldNameY()

void dd4hep::DDSegmentation::CartesianGridXY::setFieldNameY ( const std::string &  fieldName)
inline

set the field name used for Y

Definition at line 85 of file CartesianGridXY.h.

◆ setGridSizeX()

void dd4hep::DDSegmentation::CartesianGridXY::setGridSizeX ( double  cellSize)
inline

set the grid size in X

Definition at line 65 of file CartesianGridXY.h.

◆ setGridSizeY()

void dd4hep::DDSegmentation::CartesianGridXY::setGridSizeY ( double  cellSize)
inline

set the grid size in Y

Definition at line 69 of file CartesianGridXY.h.

◆ setOffsetX()

void dd4hep::DDSegmentation::CartesianGridXY::setOffsetX ( double  offset)
inline

set the coordinate offset in X

Definition at line 73 of file CartesianGridXY.h.

◆ setOffsetY()

void dd4hep::DDSegmentation::CartesianGridXY::setOffsetY ( double  offset)
inline

set the coordinate offset in Y

Definition at line 77 of file CartesianGridXY.h.

Member Data Documentation

◆ _gridSizeX

double dd4hep::DDSegmentation::CartesianGridXY::_gridSizeX
protected

the grid size in X

Definition at line 101 of file CartesianGridXY.h.

◆ _gridSizeY

double dd4hep::DDSegmentation::CartesianGridXY::_gridSizeY
protected

the grid size in Y

Definition at line 105 of file CartesianGridXY.h.

◆ _offsetX

double dd4hep::DDSegmentation::CartesianGridXY::_offsetX
protected

the coordinate offset in X

Definition at line 103 of file CartesianGridXY.h.

◆ _offsetY

double dd4hep::DDSegmentation::CartesianGridXY::_offsetY
protected

the coordinate offset in Y

Definition at line 107 of file CartesianGridXY.h.

◆ _xId

std::string dd4hep::DDSegmentation::CartesianGridXY::_xId
protected

the field name used for X

Definition at line 109 of file CartesianGridXY.h.

◆ _yId

std::string dd4hep::DDSegmentation::CartesianGridXY::_yId
protected

the field name used for Y

Definition at line 111 of file CartesianGridXY.h.


The documentation for this class was generated from the following files: