Belle2::geometry Namespace Reference

Common code concerning the geometry representation of the detector. More...

Classes
class	CreatorBase
	Pure virtual base class for all geometry creators. More...
struct	CreatorFactory
	Very simple class to provide an easy way to register creators with the CreatorManager. More...
class	CreatorManager
	Class to manage all creators and provide factory access. More...
class	GeometryManager
	Class to manage the creation and conversion of the geometry. More...
class	Materials
	Thin wrapper around the Geant4 Material system. More...

Enumerations
enum	GeometryTypes {   FullGeometry ,   TrackingGeometry ,   DisplayGeometry }
	Flag indicating the type of geometry to be used. More...

Functions
void	setColor (G4LogicalVolume &volume, const std::string &color)
	Set the color of a logical volume.
void	setVisibility (G4LogicalVolume &volume, bool visible)
	Helper function to quickly set the visibility of a given volume.
G4Polycone *	createPolyCone (const std::string &name, const GearDir &params, double &minZ, double &maxZ)
	Create Polycone Shape from XML Parameters.
G4Polycone *	createRotationSolid (const std::string &name, const GearDir &params, double &minZ, double &maxZ)
	Create a solid by rotating two polylines around the Z-Axis.
G4Polycone *	createRotationSolid (const std::string &name, std::list< std::pair< double, double > > innerPoints, std::list< std::pair< double, double > > outerPoints, double minPhi, double maxPhi, double &minZ, double &maxZ)
	Create a solid by rotating two polylines around the Z-Axis.
G4Colour	parseColor (std::string colorString)
	Parse a color string of the form "#rgb", "#rrggbb", "#rgba", "#rrggbbaa" or "rgb(r, g, b)" and return a corresponding G4Colour.

Detailed Description

Common code concerning the geometry representation of the detector.

Enumeration Type Documentation

GeometryTypes

enum GeometryTypes

Flag indicating the type of geometry to be used.

Enumerator
FullGeometry	Full geometry for simulation.
TrackingGeometry	Simplified geometry for tracking purposes.
DisplayGeometry	Simplified geometry for display purposes.

Definition at line 36 of file GeometryManager.h.

                       {
      FullGeometry,     
      TrackingGeometry, 
      DisplayGeometry   
    };

Function Documentation

createPolyCone()

G4Polycone * createPolyCone	(	const std::string &	name,
		const GearDir &	params,
		double &	minZ,
		double &	maxZ )

Create Polycone Shape from XML Parameters.

This function will create a polycone shape directly from Gearbox Parameters of the form

<minPhi unit="deg">  0</minPhi>
<maxPhi unit="deg">360</maxPhi>
<Plane>
  <posZ unit="mm">-10.0</posZ>
  <innerRadius unit="mm"> 20.000</innerRadius>
  <outerRadius unit="mm"> 20.000</outerRadius>
</Plane>
...
<Plane>
  <posZ unit="mm">10.0</posZ>
  <innerRadius unit="mm"> 15.000</innerRadius>
  <outerRadius unit="mm"> 30.000</outerRadius>
</Plane>

There must be at least two Plane definitions, minPhi and maxPhi can be omitted. minZ and maxZ will return the extents of the Polycone along z

Parameters

	name	Name of the shape to create
	params	GearDir pointing to the parameters
[out]	minZ	will contain the minimal z coordinate of the polycone
[out]	maxZ	will contain the maximal z coordinate of the polycone

Definition at line 116 of file utilities.cc.

    {
      if (!params) return nullptr;
 
      double minPhi = params.getAngle("minPhi", 0);
      double dPhi   = params.getAngle("maxPhi", 2 * M_PI) - minPhi;
      const std::vector<GearDir> planes = params.getNodes("Plane");
      int nPlanes = planes.size();
      if (nPlanes < 2) {
        B2ERROR("Polycone needs at least two planes");
        return nullptr;
      }
      std::vector<double> z(nPlanes, 0);
      std::vector<double> rMin(nPlanes, 0);
      std::vector<double> rMax(nPlanes, 0);
      int index(0);
      minZ = std::numeric_limits<double>::infinity();
      maxZ = -std::numeric_limits<double>::infinity();
      for (const GearDir& plane : planes) {
        z[index]    = plane.getLength("posZ") / Unit::mm;
        minZ = std::min(minZ, z[index]);
        maxZ = std::max(maxZ, z[index]);
        rMin[index] = plane.getLength("innerRadius") / Unit::mm;
        rMax[index] = plane.getLength("outerRadius") / Unit::mm;
        ++index;
      }
      G4Polycone* polycone = new G4Polycone(name, minPhi, dPhi, nPlanes, z.data(), rMin.data(), rMax.data());
      return polycone;
    }

createRotationSolid() [1/2]

G4Polycone * createRotationSolid	(	const std::string &	name,
		const GearDir &	params,
		double &	minZ,
		double &	maxZ )

Create a solid by rotating two polylines around the Z-Axis.

This function will create a polycone shape directly from Gearbox Parameters describing the inner and the outer envelope of the polycone. The XML Parameters should be of the form

<minPhi unit="deg">  0</minPhi>
<maxPhi unit="deg">360</maxPhi>
<OuterPoints>
  <point><z unit="mm">-393.000</z><x unit="mm">100.000</x></point>
  <point><z unit="mm">-337.000</z><x unit="mm"> 85.500</x></point>
  ...
  <point><z unit="mm">-138.000</z><x unit="mm"> 35.000</x></point>
</OuterPoints>
<InnerPoints>
  <point><z unit="mm">-393.000</z><x unit="mm"> 97.934</x></point>
  <point><z unit="mm">-339.000</z><x unit="mm"> 83.952</x></point>
  ...
  <point><z unit="mm">-138.000</z><x unit="mm"> 33.000</x></point>
</InnerPoints>

Where OuterPoints and InnerPoints specify a polyline which is the outer respective inner envelope of the Polycone. The number of points doe s not have to be the same for Outer- and InnerPoints. Needed positions will be interpolated when creating the Polycone.

The Positions for Outer- and InnerPoints have to be in ascending Z coordinates. The first and last point of OuterPoints will be connected to the first respective last point of InnerPoints. The resulting shape will be rotated around the z axis to create the polycone.

Parameters

	name	Name of the Solid
	params	Parameters to use for the Solid
[out]	minZ	will contain the minimal z coordinate of the polycone
[out]	maxZ	will contain the maximal z coordinate of the polycone

Definition at line 203 of file utilities.cc.

    {
 
      //Make a list of all the points (ZX coordinates)
      PointList innerPoints;
      PointList outerPoints;
      for (const GearDir& point : params.getNodes("InnerPoints/point")) {
        innerPoints.push_back(ZXPoint(point.getLength("z") / Unit::mm, point.getLength("x") / Unit::mm));
      }
      for (const GearDir& point : params.getNodes("OuterPoints/point")) {
        outerPoints.push_back(ZXPoint(point.getLength("z") / Unit::mm, point.getLength("x") / Unit::mm));
      }
      //Subdivide the segments to have an x position for each z specified for
      //either inner or outer boundary
      subdivideSegments(innerPoints, outerPoints);
      subdivideSegments(outerPoints, innerPoints);
      minZ = innerPoints.front().first;
      maxZ = outerPoints.front().first;
 
      //Now we create the array of planes needed for the polycone
      std::vector<double> z;
      std::vector<double> rMin;
      std::vector<double> rMax;
 
      double innerZ{0};
      double innerX{0};
      double outerZ{0};
      double outerX{0};
      //We go through both lists until both are empty
      while (!(innerPoints.empty() && outerPoints.empty())) {
        bool popInner = false;
        //We could have more than one point at the same z position for segments
        //going directly along x. because of that we check that the z
        //coordinates for inner and outer line are always the same, reusing one
        //point if necessary
        if (!innerPoints.empty() && innerPoints.front().first <= outerPoints.front().first) {
          boost::tie(innerZ, innerX) = innerPoints.front();
          popInner = true;
        }
        if (!outerPoints.empty() && outerPoints.front().first <= innerPoints.front().first) {
          boost::tie(outerZ, outerX) = outerPoints.front();
          outerPoints.pop_front();
        }
        if (popInner) innerPoints.pop_front();
        if (innerZ != outerZ) {
          B2ERROR("createRotationSolid: Something is wrong, z values should be identical");
          return nullptr;
        }
        z.push_back(innerZ);
        rMin.push_back(innerX);
        rMax.push_back(outerX);
      }
 
      //Finally create the Polycone
      int nPlanes = z.size();
      double minPhi = params.getAngle("minPhi", 0);
      double dPhi   = params.getAngle("maxPhi", 2 * M_PI) - minPhi;
      return new G4Polycone(name, minPhi, dPhi, nPlanes, &z.front(), &rMin.front(), &rMax.front());
    }

createRotationSolid() [2/2]

G4Polycone * createRotationSolid	(	const std::string &	name,
		std::list< std::pair< double, double > >	innerPoints,
		std::list< std::pair< double, double > >	outerPoints,
		double	minPhi,
		double	maxPhi,
		double &	minZ,
		double &	maxZ )

Create a solid by rotating two polylines around the Z-Axis.

This function will create a polycone shape. The InnerPoints and OuterPoints are passed directly as stl::lists to avoid dependence on gearbox.

Where OuterPoints and InnerPoints specify a polyline which is the outer respective inner envelope of the Polycone. The number of points does not have to be the same for Outer- and InnerPoints. Needed positions will be interpolated when creating the Polycone.

The Positions for Outer- and InnerPoints have to be in ascending Z coordinates. The first and last point of OuterPoints will be connected to the first respective last point of InnerPoints. The resulting shape will be rotated around the z axis to create the polycone.

Parameters

[in]	name	Name of the solid.
[in]	innerPoints	List of inner points.
[in]	outerPoints	List of outer points.
[in]	minPhi	Minimum phi angle.
[in]	maxPhi	Maximum phi angle.
[out]	minZ	Minimum z coordinate.
[out]	maxZ	Maximum z coordinate.

Definition at line 263 of file utilities.cc.

    {
      //Subdivide the segments to have an x position for each z specified for
      //either inner or outer boundary
      subdivideSegments(innerPoints, outerPoints);
      subdivideSegments(outerPoints, innerPoints);
      minZ = innerPoints.front().first;
      maxZ = outerPoints.front().first;
 
      //Now we create the array of planes needed for the polycone
      std::vector<double> z;
      std::vector<double> rMin;
      std::vector<double> rMax;
 
      double innerZ{0};
      double innerX{0};
      double outerZ{0};
      double outerX{0};
      //We go through both lists until both are empty
      while (!(innerPoints.empty() && outerPoints.empty())) {
        bool popInner = false;
        //We could have more than one point at the same z position for segments
        //going directly along x. because of that we check that the z
        //coordinates for inner and outer line are always the same, reusing one
        //point if necessary
        // cppcheck-suppress knownConditionTrueFalse
        if (!innerPoints.empty() && innerPoints.front().first <= outerPoints.front().first) {
          boost::tie(innerZ, innerX) = innerPoints.front();
          popInner = true;
        }
        if (!outerPoints.empty() && outerPoints.front().first <= innerPoints.front().first) {
          boost::tie(outerZ, outerX) = outerPoints.front();
          outerPoints.pop_front();
        }
        if (popInner) innerPoints.pop_front();
        if (innerZ != outerZ) {
          B2ERROR("createRotationSolid: Something is wrong, z values should be identical");
          return nullptr;
        }
        z.push_back(innerZ / Unit::mm);
        rMin.push_back(innerX / Unit::mm);
        rMax.push_back(outerX / Unit::mm);
      }
 
      //Finally create the Polycone
      int nPlanes = z.size();
      double dPhi = maxPhi - minPhi;
      return new G4Polycone(name, minPhi, dPhi, nPlanes, &z.front(), &rMin.front(), &rMax.front());
 
    }

parseColor()

G4Colour parseColor

(

std::string

colorString

)

Parse a color string of the form "#rgb", "#rrggbb", "#rgba", "#rrggbbaa" or "rgb(r, g, b)" and return a corresponding G4Colour.

For "#rgb" and "#rgba" the color for red, green, blue (and optionally alpha) is each represented by one hexadecimal digit, "#rrggbb" and "#rrggbbaa" is the same with two digits per colour.

"rgb(r, g, b)" expects the fraction of red, green and blue as float between 0 and 1.

Definition at line 44 of file utilities.cc.

    {
      boost::to_lower(colorString);
      double red(0), green(0), blue(0), alpha(0);
      if (colorString[0] == '#') {
        size_t size = colorString.size();
        unsigned int colorValue;
        std::stringstream in(colorString);
        in.get();
        in >> std::hex >> colorValue;
        if (in.fail()) size = 0;
        switch (size) {
          case 4: //#rgb, add alpha since none was specified
            colorValue = (colorValue << 4) + 15;
            // and then continue with rgba case
            [[fallthrough]];
          case 5: //#rgba
            red   = ((colorValue & 0xf000) >> 12) / 15.;
            green = ((colorValue & 0x0f00) >>  8) / 15.;
            blue  = ((colorValue & 0x00f0) >>  4) / 15.;
            alpha = ((colorValue & 0x000f) >>  0) / 15.;
            break;
          case 7: //#rrggbb, add alpha since none was specified
            colorValue = (colorValue << 8) + 255;
            // and then continue with #rrggbbaa case
            [[fallthrough]];
          case 9: //#rrggbbaa
            red   = ((colorValue & 0xff000000) >> 24) / 255.;
            green = ((colorValue & 0x00ff0000) >> 16) / 255.;
            blue  = ((colorValue & 0x0000ff00) >>  8) / 255.;
            alpha = ((colorValue & 0x000000ff) >>  0) / 255.;
            break;
          default:
            B2WARNING("Could not parse color string '" + colorString + "'");
        }
      } else if (colorString.substr(0, 3) == "rgb") {
        //Parse value of the type rgb(1.0,1.0,1.0)
        size_t startPos = colorString.find('(');
        size_t stopPos = colorString.find(')');
        std::string ws(" \t\r\n,");
        std::stringstream in(colorString.substr(startPos + 1, stopPos - startPos - 1));
        in >> red;
        while (ws.find(in.peek()) != std::string::npos) in.get();
        in >> green;
        while (ws.find(in.peek()) != std::string::npos) in.get();
        in >> blue;
        while (ws.find(in.peek()) != std::string::npos) in.get();
        in >> alpha;
        red   = std::min(1.0, std::max(0.0, red));
        green = std::min(1.0, std::max(0.0, green));
        blue  = std::min(1.0, std::max(0.0, blue));
        alpha = std::min(1.0, std::max(0.0, alpha));
      }
      return G4Colour(red, green, blue, alpha);
    }

setColor()

void setColor	(	G4LogicalVolume &	volume,
		const std::string &	color )

Set the color of a logical volume.

This function will set the visualization color of a logical volume from a string representation of the color. Recognized formats for the color are:

• "#rgb" where r,g,b are hexadecimal values from 0 to f representing the color values for red, green and blue respectively
• "#rgba" where r,g,b,a are hexadecimal values from 0 to f and a represents the alpha value
• "#rrggbb" where rr,gg,bb are hexadecimal values from 00 to ff representing the color values for red, green and blue respectively
• "#rrggbbaa" where rr,gg,bb,aa are hexadecimal values from 00 to ff and aa represents the alpha value
• "rgb(r,g,b)" where r,g,b are float values between 0.0 and 1.0 representing the color values for red, green and blue respectively
• "rgb(r,g,b,a)" where r,g,b,a are float values between 0.0 and 1.0 representing the color values for red, green, blue and alpha respectively

Parameters

volume	Volume for which to set the color
color	String representation of the color

Definition at line 100 of file utilities.cc.

    {
      auto* attr = const_cast<G4VisAttributes*>(volume.GetVisAttributes());
      if (!attr) attr = GeometryManager::getInstance().newVisAttributes();
      attr->SetColor(parseColor(color));
      volume.SetVisAttributes(attr);
    }

setVisibility()

void setVisibility	(	G4LogicalVolume &	volume,
		bool	visible )

Helper function to quickly set the visibility of a given volume.

Parameters

volume	Volume for which to set the visibility
visible	true if the volume should be visible, false otherwise

Definition at line 108 of file utilities.cc.

    {
      auto* attr = const_cast<G4VisAttributes*>(volume.GetVisAttributes());
      if (!attr) attr = GeometryManager::getInstance().newVisAttributes();
      attr->SetVisibility(visible);
      volume.SetVisAttributes(attr);
    }