magneticfield::volumeHandle Class Reference

#include <DD4hep_volumeHandle.h>

Inheritance diagram for magneticfield::volumeHandle:

Public Member Functions
volumeHandle	operator= (const volumeHandle &v)=delete
DDSolidShape	shape () const override
	Shape of the solid. More...
std::vector< VolumeSide >	sides () const override
	The surfaces and they orientation, as required to build a MagVolume. More...
	volumeHandle (const cms::DDFilteredView &fv, bool expand2Pi=false, bool debugVal=false)
	volumeHandle (const volumeHandle &v)=delete
Public Member Functions inherited from magneticfield::BaseVolumeHandle
	BaseVolumeHandle (bool expand2Pi=false, bool debugVal=false)
	BaseVolumeHandle (const BaseVolumeHandle &v)=delete
const GlobalPoint &	center () const
	Return the center of the volume. More...
bool	isIron () const
	Temporary hack to pass information on material. Will eventually be replaced! More...
bool	isPlaneMatched (int which_side) const
	if the specified surface has been matched. More...
Geom::Phi< float >	maxPhi () const
	Maximum value of phi covered by the volume. More...
double	maxZ () const
Geom::Phi< float >	minPhi () const
	Minimum value of phi covered by the volume. More...
double	minR () const
	Minimum R for any point within the volume. More...
double	minZ () const
	Z limits. More...
const GloballyPositioned< float > *	placement () const
	Position and rotation. More...
int	references (int which_side) const
const double	RN () const
	Distance of (x,y) plane from origin. More...
bool	sameSurface (const Surface &s1, Sides which_side, float tolerance=0.01)
	Find out if two surfaces are the same physical surface. More...
bool	setSurface (const Surface &s1, Sides which_side)
	Assign a shared surface perorming sanity checks. More...
const Surface &	surface (int which_side) const
	Get the current surface on specified side. More...
const Surface &	surface (Sides which_side) const
bool	toExpand () const
virtual	~BaseVolumeHandle ()

Private Member Functions
void	buildBox (double halfX, double halfY, double halfZ)
void	buildCons (double zhalf, double rInMinusZ, double rOutMinusZ, double rInPlusZ, double rOutPlusZ, double startPhi, double deltaPhi)
void	buildPseudoTrap (double x1, double x2, double y1, double y2, double halfZ, double radius, bool atMinusZ)
void	buildTrap (double x1, double x2, double x3, double x4, double y1, double y2, double theta, double phi, double halfZ, double alpha1, double alpha2)
void	buildTruncTubs (double zhalf, double rIn, double rOut, double startPhi, double deltaPhi, double cutAtStart, double cutAtDelta, bool cutInside)
void	buildTubs (double zhalf, double rIn, double rOut, double startPhi, double deltaPhi)
void	referencePlane (const cms::DDFilteredView &fv)

Private Attributes
const cms::DDFilteredView &	solid
const DDSolidShape	theShape

Additional Inherited Members
Public Types inherited from magneticfield::BaseVolumeHandle
typedef Surface::GlobalPoint	GlobalPoint
typedef Surface::LocalPoint	LocalPoint
typedef Surface::LocalVector	LocalVector
typedef SurfaceOrientation::GlobalFace	Sides
Public Attributes inherited from magneticfield::BaseVolumeHandle
unsigned short	copyno
	copy number More...
std::string	magFile
	Name of magnetic field table file. More...
MagVolume6Faces *	magVolume
	Pointer to the final MagVolume (must be set from outside) More...
int	masterSector
	The sector for which an interpolator for this class of volumes should be built. More...
std::string	name
	Name of the volume. More...
unsigned short	volumeno
	volume number More...
Protected Types inherited from magneticfield::BaseVolumeHandle
typedef ConstReferenceCountingPointer< Surface >	RCPS
Protected Member Functions inherited from magneticfield::BaseVolumeHandle
void	buildPhiZSurf (double startPhi, double deltaPhi, double zhalf, double rCentr)
Protected Attributes inherited from magneticfield::BaseVolumeHandle
GlobalPoint	center_
const bool	debug
bool	expand
bool	isAssigned [6]
bool	isIronFlag
GloballyPositioned< float > *	refPlane
RCPS	surfaces [6]
Geom::Phi< float >	thePhiMin
double	theRMax
double	theRMin
double	theRN

Detailed Description

Definition at line 23 of file DD4hep_volumeHandle.h.

Constructor & Destructor Documentation

volumeHandle() [1/2]

volumeHandle::volumeHandle	(	const cms::DDFilteredView &	fv,
		bool	expand2Pi = false,
		bool	debugVal = false
	)

Definition at line 33 of file DD4hep_volumeHandle.cc.

References buildBox(), buildCons(), buildPseudoTrap(), buildTrap(), buildTruncTubs(), buildTubs(), magneticfield::BaseVolumeHandle::center(), magneticfield::BaseVolumeHandle::center_, magneticfield::BaseVolumeHandle::copyno, cms::DDFilteredView::copyNum(), ztail::d, ddbox, ddcons, ddpseudotrap, ddtrap, ddtrunctubs, ddtubs, magneticfield::BaseVolumeHandle::debug, reco::deltaPhi(), srCondWrite_cfg::deltaPhi, mps_fire::i, magneticfield::BaseVolumeHandle::isAssigned, magneticfield::BaseVolumeHandle::isIronFlag, LogTrace, magneticfield::BaseVolumeHandle::magFile, magneticfield::BaseVolumeHandle::masterSector, cms::DDFilteredView::materialName(), magneticfield::BaseVolumeHandle::name, cms::DDFilteredView::name(), magneticfield::newln, cms::DDFilteredView::parameters(), PV3DBase< T, PVType, FrameType >::perp(), PV3DBase< T, PVType, FrameType >::phi(), referencePlane(), solid, cms::DDFilteredView::solid(), DDTruncTubs::startPhi(), DDTubs::startPhi(), AlCaHLTBitMon_QueryRunRegistry::string, magneticfield::BaseVolumeHandle::surfaces, magneticfield::BaseVolumeHandle::theRMax, magneticfield::BaseVolumeHandle::theRMin, magneticfield::BaseVolumeHandle::theRN, theShape, tauSpinnerTable_cfi::theta, cms::DDFilteredView::trans(), HcalDetIdTransform::transform(), heppy_batch::val, cms::DDFilteredView::volume(), magneticfield::BaseVolumeHandle::volumeno, testProducerWithPsetDescEmpty_cfi::y1, and testProducerWithPsetDescEmpty_cfi::y2.

    : BaseVolumeHandle(expand2Pi, debugVal), theShape(fv.legacyShape(fv.shape())), solid(fv) {
  name = fv.name();
  copyno = fv.copyNum();
  const auto *const transArray = fv.trans();

  // Convert from DD4hep units to cm
  center_ = GlobalPoint(transArray[0] / dd4hep::cm, transArray[1] / dd4hep::cm, transArray[2] / dd4hep::cm);

  // ASSUMPTION: volume names ends with "_NUM" where NUM is the volume number
  string volName = name;
  volName.erase(0, volName.rfind('_') + 1);
  volumeno = static_cast<unsigned short>(std::atoi(volName.c_str()));

  for (int i = 0; i < 6; ++i) {
    isAssigned[i] = false;
  }
  referencePlane(fv);
  switch (theShape) {
    case DDSolidShape::ddbox: {
      DDBox box(solid.solid());
      // Convert from DD4hep units to cm
      double halfX = box.x() / dd4hep::cm;
      double halfY = box.y() / dd4hep::cm;
      double halfZ = box.z() / dd4hep::cm;
      buildBox(halfX, halfY, halfZ);
    } break;
    case DDSolidShape::ddtrap: {
      DDTrap trap(solid.solid());
      double x1 = trap.bottomLow1() / dd4hep::cm;
      double x2 = trap.topLow1() / dd4hep::cm;
      double x3 = trap.bottomLow2() / dd4hep::cm;
      double x4 = trap.topLow2() / dd4hep::cm;
      double y1 = trap.high1() / dd4hep::cm;
      double y2 = trap.high2() / dd4hep::cm;
      double theta = trap.theta();
      double phi = trap.phi();
      double halfZ = trap.dZ() / dd4hep::cm;
      double alpha1 = trap.alpha1();
      double alpha2 = trap.alpha2();
      buildTrap(x1, x2, x3, x4, y1, y2, theta, phi, halfZ, alpha1, alpha2);
    } break;

    case DDSolidShape::ddcons: {
      DDCons cons(solid.solid());
      double zhalf = cons.dZ() / dd4hep::cm;
      double rInMinusZ = cons.rMin1() / dd4hep::cm;
      double rOutMinusZ = cons.rMax1() / dd4hep::cm;
      double rInPlusZ = cons.rMin2() / dd4hep::cm;
      double rOutPlusZ = cons.rMax2() / dd4hep::cm;
      double startPhi = cons.startPhi();
      double deltaPhi = reco::deltaPhi(cons.endPhi(), startPhi);
      buildCons(zhalf, rInMinusZ, rOutMinusZ, rInPlusZ, rOutPlusZ, startPhi, deltaPhi);
    } break;
    case DDSolidShape::ddtubs: {
      DDTubs tubs(solid.solid());
      double zhalf = tubs.dZ() / dd4hep::cm;
      double rIn = tubs.rMin() / dd4hep::cm;
      double rOut = tubs.rMax() / dd4hep::cm;
      double startPhi = tubs.startPhi();
      double deltaPhi = tubs.endPhi() - startPhi;
      buildTubs(zhalf, rIn, rOut, startPhi, deltaPhi);
    } break;
    case DDSolidShape::ddpseudotrap: {
      vector<double> d = solid.parameters();

      // The pseudo-trapezoid parameters are:
      // d[0] -- x1
      // d[1] -- x2
      // d[2] -- y1
      // d[3] -- y2
      // d[4] -- halfZ
      // d[5] -- radius
      // d[6] -- atMinusZ (0 or 1)
      // Note all are lengths except for the last one. The lengths come from
      // DD4hep in DD4hep units and must be converted to cm for use.

      if (d.size() >= 7)
        LogTrace("MagGeoBuilder") << " Pseudo trap params raw =  " << d[0] << ", " << d[1] << ", " << d[2] << ", "
                                  << d[3] << ", " << d[4] << ", " << d[5] << ", " << d[6];

      // Convert all but last parameter to cm (last one is a boolean).
      transform(d.begin(), --(d.end()), d.begin(), [](double val) { return val / dd4hep::cm; });

      if (d.size() >= 7)
        LogTrace("MagGeoBuilder") << " Pseudo trap params converted =  " << d[0] << ", " << d[1] << ", " << d[2] << ", "
                                  << d[3] << ", " << d[4] << ", " << d[5] << ", " << d[6];

      buildPseudoTrap(d[0], d[1], d[2], d[3], d[4], d[5], static_cast<bool>(d[6]));
    } break;
    case DDSolidShape::ddtrunctubs: {
      DDTruncTubs tubs(solid.solid());
      double zhalf = tubs.dZ() / dd4hep::cm;               // half of the z-Axis
      double rIn = tubs.rMin() / dd4hep::cm;               // inner radius
      double rOut = tubs.rMax() / dd4hep::cm;              // outer radius
      double startPhi = tubs.startPhi();                   // angular start of the tube-section
      double deltaPhi = tubs.deltaPhi();                   // angular span of the tube-section
      double cutAtStart = tubs.cutAtStart() / dd4hep::cm;  // truncation at begin of the tube-section
      double cutAtDelta = tubs.cutAtDelta() / dd4hep::cm;  // truncation at end of the tube-section
      bool cutInside = tubs.cutInside();  // true, if truncation is on the inner side of the tube-section
      buildTruncTubs(zhalf, rIn, rOut, startPhi, deltaPhi, cutAtStart, cutAtDelta, cutInside);
    } break;
    default:
      LogError("magneticfield::volumeHandle")
          << "ctor: Unexpected shape # " << static_cast<int>(theShape) << " for vol " << name;
  }

  // The only materials used in the geometry are: materials:Air, d=0.001214; materials:Iron, d=7.87
  if (fv.volume().material().density() > 3.)
    isIronFlag = true;

  if (debug) {
    LogTrace("MagGeoBuilder") << " RMin =  " << theRMin << newln << " RMax =  " << theRMax;

    if (theRMin < 0 || theRN < theRMin || theRMax < theRN)
      LogTrace("MagGeoBuilder") << "*** WARNING: wrong RMin/RN/RMax";

    LogTrace("MagGeoBuilder") << "Summary: " << name << " " << copyno << " shape = " << theShape << " trasl "
                              << center() << " R " << center().perp() << " phi " << center().phi() << " magFile "
                              << magFile << " Material= " << fv.materialName() << " isIron= " << isIronFlag
                              << " masterSector= " << masterSector;

    LogTrace("MagGeoBuilder") << " Orientation of surfaces:";
    std::string sideName[3] = {"positiveSide", "negativeSide", "onSurface"};
    for (int i = 0; i < 6; ++i) {
      if (surfaces[i] != nullptr)
        LogTrace("MagGeoBuilder") << "  " << i << ":" << sideName[surfaces[i]->side(center_, 0.3)];
    }
  }
}

volumeHandle() [2/2]

magneticfield::volumeHandle::volumeHandle ( const volumeHandle &  v )

delete

Member Function Documentation

buildBox()

void magneticfield::volumeHandle::buildBox ( double  halfX, double  halfY, double  halfZ  )

private

Referenced by volumeHandle().

buildCons()

void magneticfield::volumeHandle::buildCons ( double  zhalf, double  rInMinusZ, double  rOutMinusZ, double  rInPlusZ, double  rOutPlusZ, double  startPhi, double  deltaPhi  )

private

Referenced by volumeHandle().

buildPseudoTrap()

void magneticfield::volumeHandle::buildPseudoTrap ( double  x1, double  x2, double  y1, double  y2, double  halfZ, double  radius, bool  atMinusZ  )

private

Referenced by volumeHandle().

buildTrap()

void magneticfield::volumeHandle::buildTrap ( double  x1, double  x2, double  x3, double  x4, double  y1, double  y2, double  theta, double  phi, double  halfZ, double  alpha1, double  alpha2  )

private

Referenced by volumeHandle().

buildTruncTubs()

void magneticfield::volumeHandle::buildTruncTubs ( double  zhalf, double  rIn, double  rOut, double  startPhi, double  deltaPhi, double  cutAtStart, double  cutAtDelta, bool  cutInside  )

private

Referenced by volumeHandle().

buildTubs()

void magneticfield::volumeHandle::buildTubs ( double  zhalf, double  rIn, double  rOut, double  startPhi, double  deltaPhi  )

private

Referenced by volumeHandle().

operator=()

volumeHandle magneticfield::volumeHandle::operator= ( const volumeHandle &  v )

delete

referencePlane()

void volumeHandle::referencePlane ( const cms::DDFilteredView &  fv )

private

Definition at line 164 of file DD4hep_volumeHandle.cc.

References magneticfield::BaseVolumeHandle::center_, ddpseudotrap, magneticfield::BaseVolumeHandle::debug, LogTrace, GloballyPositioned< T >::position(), magneticfield::BaseVolumeHandle::refPlane, cms::DDFilteredView::rot(), theShape, GloballyPositioned< T >::toGlobal(), x, and PV3DBase< T, PVType, FrameType >::z().

Referenced by volumeHandle().

                                                             {
  // The refPlane is the "main plane" for the solid. It corresponds to the
  // x,y plane in the DDD local frame, and defines a frame where the local
  // coordinates are the same as in DDD.
  // In the geometry version 85l_030919, this plane is normal to the
  // beam line for all volumes but pseudotraps, so that global R is along Y,
  // global phi is along -X and global Z along Z:
  //
  //   Global(for vol at pi/2)    Local
  //   +R (+Y)                    +Y
  //   +phi(-X)                   -X
  //   +Z                         +Z
  //
  // For pseudotraps the refPlane is parallel to beam line and global R is
  // along Z, global phi is along +-X and and global Z along Y:
  //
  //   Global(for vol at pi/2)    Local
  //   +R (+Y)                    +Z
  //   +phi(-X)                   +X
  //   +Z                         +Y
  //
  // Note that the frame is centered in the DDD volume center, which is
  // inside the volume for DDD boxes and (pesudo)trapezoids, on the beam line
  // for tubs, cons and trunctubs.

  // In geometry version 1103l, trapezoids have X and Z in the opposite direction
  // than the above.  Boxes are either oriented as described above or in some case
  // have opposite direction for Y and X.

  // The global position
  Surface::PositionType &posResult = center_;

  // The reference plane rotation
  math::XYZVector x, y, z;
  dd4hep::Rotation3D refRot;
  fv.rot(refRot);
  refRot.GetComponents(x, y, z);
  if (debug) {
    if (x.Cross(y).Dot(z) < 0.5) {
      LogTrace("MagGeoBuilder") << "*** WARNING: Rotation is not RH ";
    }
  }

  // The global rotation
  Surface::RotationType rotResult(float(x.X()),
                                  float(x.Y()),
                                  float(x.Z()),
                                  float(y.X()),
                                  float(y.Y()),
                                  float(y.Z()),
                                  float(z.X()),
                                  float(z.Y()),
                                  float(z.Z()));

  refPlane = new GloballyPositioned<float>(posResult, rotResult);

  // Check correct orientation
  if (debug) {
    LogTrace("MagGeoBuilder") << "Refplane pos  " << refPlane->position();

    // See comments above for the conventions for orientation.
    LocalVector globalZdir(0., 0., 1.);  // Local direction of the axis along global Z

    if (theShape == DDSolidShape::ddpseudotrap) {
      globalZdir = LocalVector(0., 1., 0.);
    }

    if (refPlane->toGlobal(globalZdir).z() < 0.) {
      globalZdir = -globalZdir;
    }
    float chk = refPlane->toGlobal(globalZdir).dot(GlobalVector(0, 0, 1));
    if (chk < .999)
      LogTrace("MagGeoBuilder") << "*** WARNING RefPlane check failed!***" << chk;
  }
}

shape()

DDSolidShape magneticfield::volumeHandle::shape ( ) const

inlineoverridevirtual

Shape of the solid.

Implements magneticfield::BaseVolumeHandle.

Definition at line 33 of file DD4hep_volumeHandle.h.

References theShape.

{ return (theShape); }

sides()

std::vector< VolumeSide > volumeHandle::sides ( void  ) const

overridevirtual

The surfaces and they orientation, as required to build a MagVolume.

Implements magneticfield::BaseVolumeHandle.

Definition at line 240 of file DD4hep_volumeHandle.cc.

References magneticfield::BaseVolumeHandle::center_, ddtubs, magneticfield::BaseVolumeHandle::expand, mps_fire::i, SurfaceOrientation::inner, SurfaceOrientation::phiminus, SurfaceOrientation::phiplus, mps_fire::result, alignCSCRings::s, ALPAKA_ACCELERATOR_NAMESPACE::ecal::reconstruction::internal::barrel::side(), magneticfield::BaseVolumeHandle::surfaces, magneticfield::BaseVolumeHandle::theRMin, and theShape.

Referenced by magneticfield::MagGeoBuilder::buildInterpolator().

                                                {
  std::vector<VolumeSide> result;
  for (int i = 0; i < 6; ++i) {
    // If this is just a master volume out of wich a 2pi volume
    // should be built (e.g. central cylinder), skip the phi boundaries.
    if (expand && (i == phiplus || i == phiminus))
      continue;

    // FIXME: Skip null inner degenerate cylindrical surface
    if (theShape == DDSolidShape::ddtubs && i == SurfaceOrientation::inner && theRMin < 0.001)
      continue;

    ReferenceCountingPointer<Surface> s = const_cast<Surface *>(surfaces[i].get());
    result.push_back(VolumeSide(s, GlobalFace(i), surfaces[i]->side(center_, 0.3)));
  }
  return result;
}

Member Data Documentation

solid

const cms::DDFilteredView& magneticfield::volumeHandle::solid

private

Definition at line 81 of file DD4hep_volumeHandle.h.

Referenced by volumeHandle().

theShape

const DDSolidShape magneticfield::volumeHandle::theShape

private

Definition at line 80 of file DD4hep_volumeHandle.h.

Referenced by referencePlane(), shape(), sides(), and volumeHandle().