DDLRotationAndReflection Class Reference

DDLRotationAndReflection handles RotationCMSIM and ReflectionRotation elements. More...

#include <DDLRotationAndReflection.h>

Inheritance diagram for DDLRotationAndReflection:

Public Member Functions
	DDLRotationAndReflection (DDLElementRegistry *myreg)
	Constructor. More...
int	isLeftHanded (DD3Vector x, DD3Vector y, DD3Vector z, const std::string &nmspace)
	returns 1 = left handed rotation matrix, 0 = right-handed, -1 = not orthonormal. More...
void	processElement (const std::string &name, const std::string &nmspace, DDCompactView &cpv)
	Processing the element. More...
	~DDLRotationAndReflection (void)
	Destructor. More...
Public Member Functions inherited from DDXMLElement
void	appendText (const std::string &inText)
	append to the current (i.e. most recently added) More...
virtual std::vector < DDXMLAttribute > ::const_iterator	begin (void)
virtual void	clear (void)
	clear this element's contents. More...
	DDXMLElement (DDLElementRegistry *myreg)
	Constructor. More...
	DDXMLElement (DDLElementRegistry *myreg, const bool &clearme)
	Constructor for autoClear element. More...
virtual std::vector < DDXMLAttribute > ::const_iterator	end (void)
virtual const std::string &	get (const std::string &name, size_t aIndex=0) const
	Returns a specific value from the aIndex set of attributes. More...
virtual const std::string &	getAttribute (const std::string &name) const
	Access to attributes by name. More...
virtual const DDXMLAttribute &	getAttributeSet (size_t aIndex=0) const
	Get a "row" of attributes, i.e. one attribute set. More...
virtual const DDName	getDDName (const std::string &defaultNS, const std::string &attname=std::string("name"), size_t aIndex=0)
const std::string	getText (size_t tindex=0) const
	retrieve the text blob. More...
virtual std::vector< std::string >	getVectorAttribute (const std::string &name)
	Returns a set of values as a std::vector of strings, given the attribute name. More...
virtual bool	gotText (void) const
	gotText()? kind of like gotMilk? Yes = text has already been encountered. More...
virtual bool	isEmpty (void) const
	Have any elements of this type been encountered but not processed? More...
void	loadAttributes (const std::string &elemName, const std::vector< std::string > &names, const std::vector< std::string > &values, const std::string &nmspace, DDCompactView &cpv)
	Load the element attributes. More...
void	loadText (const std::string &inText)
	Used to load both text and XML comments into this object. More...
std::vector< DDXMLAttribute > ::const_iterator &	operator++ (int inc)
	Allow the elements of this type to be iterated over using ++ operator. More...
const std::string &	parent (void) const
	access to parent element name More...
virtual void	preProcessElement (const std::string &name, const std::string &nmspace, DDCompactView &cpv)
	Called by loadAttributes AFTER attributes are loaded. More...
void	setParent (const std::string &pename)
	Set parent element name to central list of names. More...
void	setSelf (const std::string &sename)
	Set self element name to central list of names. More...
virtual size_t	size (void) const
	Number of elements accumulated. More...
virtual void	stream (std::ostream &os) const
	Allow for the elements to have their own streaming method, but also provide a default. More...
void	throwError (const std::string &keyMessage) const
	format std::string for throw an error. More...
virtual	~DDXMLElement (void)
	Destructor. More...

Private Member Functions
DD3Vector	makeX (std::string nmspace)
DD3Vector	makeY (std::string nmspace)
DD3Vector	makeZ (std::string nmspace)

Additional Inherited Members
Static Public Member Functions inherited from DDXMLElement
static std::string	itostr (int i)
	WARNING: abused by other classes in this system: yet another conversion from int to std::string... More...
Protected Attributes inherited from DDXMLElement
DDLElementRegistry *	myRegistry_

Detailed Description

DDLRotationAndReflection handles RotationCMSIM and ReflectionRotation elements.

Author

Michael Case

DDLRotationAndReflection.h - description

begin: Tue Oct 30 2001 email: case@.nosp@m.ucdh.nosp@m.ep.uc.nosp@m.davi.nosp@m.s.edu

This is the Rotation and Reflection element processor.

Definition at line 25 of file DDLRotationAndReflection.h.

Constructor & Destructor Documentation

DDLRotationAndReflection::DDLRotationAndReflection

(

DDLElementRegistry *

myreg

)

Constructor.

Definition at line 27 of file DDLRotationAndReflection.cc.

  : DDXMLElement( myreg ) 
{}

DDLRotationAndReflection::~DDLRotationAndReflection

(

void

)

Destructor.

Definition at line 31 of file DDLRotationAndReflection.cc.

{}

Member Function Documentation

int DDLRotationAndReflection::isLeftHanded	(	DD3Vector	x,
		DD3Vector	y,
		DD3Vector	z,
		const std::string &	nmspace
	)

returns 1 = left handed rotation matrix, 0 = right-handed, -1 = not orthonormal.

Definition at line 110 of file DDLRotationAndReflection.cc.

References funct::abs(), DDVectorGetter::check(), gather_cfg::cout, DCOUT_V, ev, ClhepEvaluator::eval(), DDLElementRegistry::evaluator(), DDXMLElement::getAttributeSet(), DDXMLElement::getDDName(), DDXMLElement::myRegistry_, and runTheMatrix::ret.

Referenced by processElement().

{
  DCOUT_V('P', "DDLRotation::isLeftHanded started");

  int ret = 0;

  /**************** copied and cannibalized code:
 
  from g3tog4
 
  http://atlassw1.phy.bnl.gov/lxr/source/external/geant4.3.1/source/g3tog4/src/G4gsrotm.cc

 48         // Construct unit std::vectors 
 49     
 50     G4ThreeVector x(sin(th1r)*cos(phi1r), sin(th1r)*sin(phi1r), cos(th1r)->second;
 51     G4ThreeVector y(sin(th2r)*cos(phi2r), sin(th2r)*sin(phi2r), cos(th2r));
 52     G4ThreeVector z(sin(th3r)*cos(phi3r), sin(th3r)*sin(phi3r), cos(th3r));
 53 
 54         // check for orthonormality and left-handedness
 55 
 56     G4double check = (x.cross(y))*z;
 57     G4double tol = 1.0e-3;
 58         
 59     if (1-abs(check)>tol) {
 60         G4cerr << "Coordinate axes forming rotation matrix "
 61                << irot << " are not orthonormal.(" << 1-abs(check) << ")" 
 62          << G4std::endl;
 63         G4cerr << " thetaX=" << theta1;
 64         G4cerr << " phiX=" << phi1;
 65         G4cerr << " thetaY=" << theta2;
 66         G4cerr << " phiY=" << phi2;
 67         G4cerr << " thetaZ=" << theta3;
 68         G4cerr << " phiZ=" << phi3;
 69         G4cerr << G4std::endl;
 70         G4Exception("G4gsrotm error");
 71     }
 72     else if (1+check<=tol) {
 73         G4cerr << "G4gsrotm warning: coordinate axes forming rotation "
 74                << "matrix " << irot << " are left-handed" << G4std::endl;
 75     }   
 76
 77     G3toG4RotationMatrix* rotp = new G3toG4RotationMatrix;
 78 
 79     rotp->SetRotationMatrixByRow(x, y, z);

  ****************/


  // check for orthonormality and left-handedness
  
  double check = (x.Cross(y)).Dot(z);
  double tol = 1.0e-3;
  ClhepEvaluator & ev = myRegistry_->evaluator();
  DDXMLAttribute atts = getAttributeSet();
  
  if (1.0-std::abs(check)>tol) {
    std::cout << "DDLRotationAndReflection Coordinate axes forming rotation matrix "
          << getDDName(nmspace) 
          << " are not orthonormal.(tolerance=" << tol 
          << " check=" << std::abs(check)  << ")" 
          << std::endl
          << " thetaX=" << (atts.find("thetaX")->second) 
          << ' ' << ev.eval(nmspace, atts.find("thetaX")->second)/deg << std::endl
          << " phiX=" << (atts.find("phiX")->second) 
          << ' ' << ev.eval(nmspace, atts.find("phiX")->second)/deg << std::endl
          << " thetaY=" << (atts.find("thetaY")->second) 
          << ' ' << ev.eval(nmspace, atts.find("thetaY")->second)/deg << std::endl
          << " phiY=" << (atts.find("phiY")->second)
          << ' ' << ev.eval(nmspace, atts.find("phiY")->second)/deg << std::endl
          << " thetaZ=" << (atts.find("thetaZ")->second)
          << ' ' << ev.eval(nmspace, atts.find("thetaZ")->second)/deg << std::endl
          << " phiZ=" << (atts.find("phiZ")->second)
          << ' ' << ev.eval(nmspace, atts.find("phiZ")->second)/deg 
          << std::endl
          << "  WAS NOT CREATED!" << std::endl;
    ret = -1;
  }
  else if (1.0+check<=tol) {
    ret = 1;    
  }
  DCOUT_V('P', "DDLRotation::isLeftHanded completed");
  return ret;
}

DD3Vector DDLRotationAndReflection::makeX ( std::string  nmspace )

private

Definition at line 195 of file DDLRotationAndReflection.cc.

References funct::cos(), ev, ClhepEvaluator::eval(), DDLElementRegistry::evaluator(), DDXMLElement::getAttributeSet(), DDXMLElement::myRegistry_, funct::sin(), and x.

Referenced by processElement().

{
  DD3Vector x;
  DDXMLAttribute atts = getAttributeSet();
  if (atts.find("thetaX") != atts.end())
  {
    ClhepEvaluator & ev = myRegistry_->evaluator(); 
    double thetaX = ev.eval(nmspace, atts.find("thetaX")->second.c_str());
    double phiX = ev.eval(nmspace, atts.find("phiX")->second.c_str());
    // colx
    x.SetX(sin(thetaX) * cos(phiX));
    x.SetY(sin(thetaX) * sin(phiX));
    x.SetZ(cos(thetaX));
  }
  return x;
}

DD3Vector DDLRotationAndReflection::makeY ( std::string  nmspace )

private

Definition at line 213 of file DDLRotationAndReflection.cc.

References funct::cos(), ev, ClhepEvaluator::eval(), DDLElementRegistry::evaluator(), DDXMLElement::getAttributeSet(), DDXMLElement::myRegistry_, funct::sin(), and y.

Referenced by processElement().

{
  DD3Vector y;
  DDXMLAttribute atts = getAttributeSet();
  if (atts.find("thetaY") != atts.end())
  {
    ClhepEvaluator & ev = myRegistry_->evaluator(); 
    double thetaY = ev.eval(nmspace, atts.find("thetaY")->second.c_str());
    double phiY = ev.eval(nmspace, atts.find("phiY")->second.c_str());
      
    // coly
    y.SetX(sin(thetaY) * cos(phiY));
    y.SetY(sin(thetaY) * sin(phiY));
    y.SetZ(cos(thetaY));
  }
  return y;
}

DD3Vector DDLRotationAndReflection::makeZ ( std::string  nmspace )

private

Definition at line 231 of file DDLRotationAndReflection.cc.

References funct::cos(), ev, ClhepEvaluator::eval(), DDLElementRegistry::evaluator(), DDXMLElement::getAttributeSet(), DDXMLElement::myRegistry_, funct::sin(), and z.

Referenced by processElement().

{
  DD3Vector z;
  DDXMLAttribute atts = getAttributeSet();
  if (atts.find("thetaZ") != atts.end())
  {
    ClhepEvaluator & ev = myRegistry_->evaluator(); 
    double thetaZ = ev.eval(nmspace, atts.find("thetaZ")->second.c_str());
    double phiZ = ev.eval(nmspace, atts.find("phiZ")->second.c_str());
      
    // colz
    z.SetX(sin(thetaZ) * cos(phiZ));
    z.SetY(sin(thetaZ) * sin(phiZ));
    z.SetZ(cos(thetaZ));
  }
  return z;
}

void DDLRotationAndReflection::processElement ( const std::string &  name, const std::string &  nmspace, DDCompactView &  cpv  )

virtual

Processing the element.

The processElement method completes any necessary work to process the XML element.

For example, this can be used to call the DDCore to make the geometry in memory. There is a default for this so that if not declared in the inheriting class, no processing is done.

Reimplemented from DDXMLElement.

Definition at line 35 of file DDLRotationAndReflection.cc.

References DDXMLElement::clear(), DCOUT_V, DDrot(), DDrotReflect(), ev, ClhepEvaluator::eval(), DDLElementRegistry::evaluator(), DDXMLElement::getAttributeSet(), DDXMLElement::getDDName(), isLeftHanded(), makeX(), makeY(), makeZ(), visualization-live-secondInstance_cfg::msg, DDXMLElement::myRegistry_, AlCaHLTBitMon_QueryRunRegistry::string, DDXMLElement::throwError(), x, y, and z.

{

  DCOUT_V('P', "DDLRotationAndReflection::processElement started " << name);

  DD3Vector x = makeX(nmspace);
  DD3Vector y = makeY(nmspace);
  DD3Vector z = makeZ(nmspace);

  DDXMLAttribute atts = getAttributeSet();


  if ((name == "Rotation") && isLeftHanded(x, y, z, nmspace) == 0)
  {
    DDRotationMatrix* ddr = new DDRotationMatrix(x, y, z);
    DDRotation ddrot = DDrot(getDDName(nmspace), ddr);
    DCOUT_V ('p', "Rotation created: " << ddrot << std::endl);
  }
  else if ((name == "Rotation")  && isLeftHanded(x, y, z, nmspace) == 1)
  {
    std::string msg("\nDDLRotationAndReflection attempted to make a");
    msg += " left-handed rotation with a Rotation element. If";
    msg += " you meant to make a reflection, use ReflectionRotation";
    msg += " elements, otherwise, please check your matrix.  Other";
    msg += " errors may follow.  Rotation  matrix not created.";
    edm::LogError("DetectorDescription_Parser_Rotation_and_Reflection") << msg << std::endl; // this could become a throwWarning or something.
  }
  else if (name == "ReflectionRotation" && isLeftHanded(x, y, z, nmspace) == 1) 
  {
    ClhepEvaluator & ev = myRegistry_->evaluator();
    DDRotation ddrot = 
      DDrotReflect(getDDName(nmspace)
           , ev.eval(nmspace, atts.find("thetaX")->second)
           , ev.eval(nmspace, atts.find("phiX")->second)
           , ev.eval(nmspace, atts.find("thetaY")->second)
           , ev.eval(nmspace, atts.find("phiY")->second)
           , ev.eval(nmspace, atts.find("thetaZ")->second)
           , ev.eval(nmspace, atts.find("phiZ")->second));
    DCOUT_V ('p', "Rotation created: " << ddrot << std::endl);
  }
  else if (name == "ReflectionRotation" && isLeftHanded(x, y, z, nmspace) == 0)
  {
    std::string msg("WARNING:  Attempted to make a right-handed");
    msg += " rotation using a ReflectionRotation element. ";
    msg += " If you meant to make a Rotation, use Rotation";
    msg += " elements, otherwise, please check your matrix.";
    msg += "  Other errors may follow.  ReflectionRotation";
    msg += " matrix not created.";
    edm::LogError("DetectorDescription_Parser_Rotation_and_Reflection") << msg << std::endl; // this could be a throwWarning or something.
  }
  else
  {
    std::string msg = "\nDDLRotationAndReflection::processElement tried to process wrong element.";
    throwError(msg);
  }
  // after a rotation or reflection rotation has been processed, clear it
  clear();

  DCOUT_V('P', "DDLRotationAndReflection::processElement completed");
}