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

This class exists to provide a segmenation when it is need but doesn't exist. More...

#include <NoSegmentation.h>

Inheritance diagram for dd4hep::DDSegmentation::NoSegmentation:
dd4hep::DDSegmentation::Segmentation

Public Member Functions

virtual ~NoSegmentation ()
 
 NoSegmentation (const std::string &cellEncoding="")
 
 NoSegmentation (const BitFieldCoder *decoder)
 
virtual Vector3D position (const CellID &cellID) const
 Determine the local 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...
 
- 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...
 
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...
 

Additional Inherited Members

- 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...
 
- 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...
 

Detailed Description

This class exists to provide a segmenation when it is need but doesn't exist.

Definition at line 28 of file NoSegmentation.h.

Constructor & Destructor Documentation

◆ ~NoSegmentation()

dd4hep::DDSegmentation::NoSegmentation::~NoSegmentation ( )
virtual

Definition at line 36 of file NoSegmentation.cpp.

◆ NoSegmentation() [1/2]

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

Definition at line 23 of file NoSegmentation.cpp.

◆ NoSegmentation() [2/2]

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

Definition at line 30 of file NoSegmentation.cpp.

Member Function Documentation

◆ cellID()

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

Determine the cell ID based on the position.

Implements dd4hep::DDSegmentation::Segmentation.

Definition at line 45 of file NoSegmentation.cpp.

◆ position()

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

Determine the local position based on the cell ID.

Implements dd4hep::DDSegmentation::Segmentation.

Definition at line 39 of file NoSegmentation.cpp.


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