Position element for ARICH. More...

#include <ARICHPositionElement.h>

Inheritance diagram for ARICHPositionElement:

Public Member Functions
	ARICHPositionElement ()
	Default constructor.

	ARICHPositionElement (double x, double y, double z, double alpha, double beta, double gamma, const std::string &name="ARICHAlignment")
	Full constructor.

void	setX (double x)
	Sets translation in x.

void	setY (double y)
	Sets translation in y.

void	setZ (double z)
	Sets translation in z.

void	setRPhi (double r, double phi)
	Sets x,y from r,phi.

void	setAlpha (double alpha)
	Sets rotation around x.

void	setBeta (double beta)
	Sets rotation around y.

void	setGamma (double gamma)
	Sets rotation around z.

void	addShift (double dx, double dy, double dz, double dalpha, double dbeta, double dgamma)
	Shift the existing values of parameters.

double	getX () const
	Returns translation in x.

double	getY () const
	Returns translation in y.

double	getZ () const
	Returns translation in z.

double	getAlpha () const
	Returns rotation angle around x.

double	getBeta () const
	Returns rotation angle around y.

double	getGamma () const
	Returns rotation angle around z.

ROOT::Math::Rotation3D	getRotation () const
	Returns rotation matrix.

ROOT::Math::XYZVector	getTranslation () const
	Returns translation vector (always in basf2 units!)

bool	isConsistent () const override
	Check for consistency of data members.

void	print (const std::string &title="Parameters of position element") const override
	Print the content of the class.

void	setName (const std::string &name)
	Sets object name.

const std::string &	getName () const
	Returns object name.

virtual void	printSurface (const GeoOpticalSurface &surface) const
	Print the content of optical surface.

virtual void	printPlacement (double x, double y, double z, double rx, double ry, double rz) const
	Print volume positioning parameters.

Protected Member Functions
	ClassDef (ARICHGeoBase, 2)
	ClassDef.

Protected Attributes
std::string	m_name
	geometry object name

Static Protected Attributes
static double	s_unit = Unit::cm
	conversion unit for length

static std::string	s_unitName
	conversion unit name

Private Member Functions
	ClassDefOverride (ARICHPositionElement, 1)
	ClassDef.

Private Attributes
float	m_x = 0
	translation in x

float	m_y = 0
	translation in y

float	m_z = 0
	translation in z

float	m_alpha = 0
	rotation angle around x

float	m_beta = 0
	rotation angle around y

float	m_gamma = 0
	rotation angle around z

Detailed Description

Position element for ARICH.

Holding parameters for displacement and alignment of arich components

Definition at line 29 of file ARICHPositionElement.h.

Constructor & Destructor Documentation

◆ ARICHPositionElement() [1/2]

ARICHPositionElement ( )

inline

Default constructor.

Definition at line 35 of file ARICHPositionElement.h.

36 {}

◆ ARICHPositionElement() [2/2]

ARICHPositionElement	(	double	x,
		double	y,
		double	z,
		double	alpha,
		double	beta,
		double	gamma,
		const std::string &	name = "ARICHAlignment" )

inline

Full constructor.

Parameters

x	translation in x
y	translation in y
z	translation in z
alpha	rotation angle around x
beta	rotation angle around y
gamma	rotation angle around z
name	object name

Definition at line 48 of file ARICHPositionElement.h.

                                                                                                           :
      ARICHGeoBase(name),
      m_x(x), m_y(y), m_z(z),
      m_alpha(alpha), m_beta(beta), m_gamma(gamma)
    {}

◆ ~ARICHPositionElement()

~ARICHPositionElement ( )

inline

Definition at line 55 of file ARICHPositionElement.h.

56 {}

Member Function Documentation

◆ addShift()

void addShift	(	double	dx,
		double	dy,
		double	dz,
		double	dalpha,
		double	dbeta,
		double	dgamma )

inline

Shift the existing values of parameters.

Parameters

dx	translation in x
dy	translation in y
dz	translation in z
dalpha	rotation angle around x
dbeta	rotation angle around y
dgamma	rotation angle around z

Definition at line 116 of file ARICHPositionElement.h.

    {
      m_x += dx;
      m_y += dy;
      m_z += dz;
      m_alpha += dalpha;
      m_beta += dbeta;
      m_gamma += dgamma;
    };

◆ getAlpha()

double getAlpha ( ) const

inline

Returns rotation angle around x.

Returns: rotation angle

Definition at line 148 of file ARICHPositionElement.h.

148{return m_alpha;}

◆ getBeta()

double getBeta ( ) const

inline

Returns rotation angle around y.

Returns: rotation angle

Definition at line 154 of file ARICHPositionElement.h.

154{return m_beta;}

◆ getGamma()

double getGamma ( ) const

inline

Returns rotation angle around z.

Returns: rotation angle

Definition at line 160 of file ARICHPositionElement.h.

160{return m_gamma;}

◆ getName()

const std::string & getName ( ) const

inlineinherited

Returns object name.

Returns: object name

Definition at line 49 of file ARICHGeoBase.h.

49{return m_name;}

◆ getRotation()

ROOT::Math::Rotation3D getRotation ( ) const

inline

Returns rotation matrix.

Returns: rotation matrix

Definition at line 166 of file ARICHPositionElement.h.

    {
      ROOT::Math::Rotation3D rot;
      ROOT::Math::RotationX rotX(m_alpha);
      ROOT::Math::RotationY rotY(m_beta);
      ROOT::Math::RotationZ rotZ(m_gamma);
      rot *= rotZ * rotY * rotX;
      return rot;
    }

◆ getTranslation()

ROOT::Math::XYZVector getTranslation ( ) const

inline

Returns translation vector (always in basf2 units!)

Returns: translation vector

Definition at line 180 of file ARICHPositionElement.h.

180{return ROOT::Math::XYZVector(m_x, m_y, m_z);}

◆ getX()

double getX ( ) const

inline

Returns translation in x.

Returns: x coordinate

Definition at line 130 of file ARICHPositionElement.h.

130{return m_x / s_unit;}

◆ getY()

double getY ( ) const

inline

Returns translation in y.

Returns: y coordinate

Definition at line 136 of file ARICHPositionElement.h.

136{return m_y / s_unit;}

◆ getZ()

double getZ ( ) const

inline

Returns translation in z.

Returns: z coordinate

Definition at line 142 of file ARICHPositionElement.h.

142{return m_z / s_unit;}

◆ isConsistent()

bool isConsistent ( ) const

inlineoverridevirtual

Check for consistency of data members.

Returns: true if values consistent (valid)

Reimplemented from ARICHGeoBase.

Definition at line 186 of file ARICHPositionElement.h.

186{return true;}

◆ print()

void print ( const std::string & title = "Parameters of position element" ) const

inlineoverridevirtual

Print the content of the class.

Parameters

title title to be printed

Reimplemented from ARICHGeoBase.

Definition at line 192 of file ARICHPositionElement.h.

    {
      std::cout << title << std::endl;
      std::cout << "translations (x,y,z): " << m_x << " " << m_y << " " << m_z << std::endl;
      std::cout << "rotations (x,y,z axis): " << m_alpha << " " << m_beta << " " << m_gamma << std::endl;
 
    }

◆ printPlacement()

void printPlacement	(	double	x,
		double	y,
		double	z,
		double	rx,
		double	ry,
		double	rz ) const

virtualinherited

Print volume positioning parameters.

Parameters

x	x position
y	y position
z	z position
rx	rotation around x-axis
ry	rotation around y-axis
rz	rotation around z-axis

Definition at line 25 of file ARICHGeoBase.cc.

{
//  cout << "Volume positioning information (inside local ARICH frame)" << endl;
  cout << " Center position; x: " << x << " " << s_unitName << ", y: " << y << " " << s_unitName << ", z: " << z << " " << s_unitName
       << endl;
  cout << " Rotations; x-axis: " << rx << " y-axis: " << ry << " z-axis: " << rz << " (in rad)"  << endl;
}

◆ printSurface()

void printSurface ( const GeoOpticalSurface & surface ) const

virtualinherited

Print the content of optical surface.

Parameters

surface optical surface parameters

Definition at line 32 of file ARICHGeoBase.cc.

{
  cout << " Optical surface: ";
  if (surface.getName().empty() and !surface.hasProperties()) {
    cout << "not defined" << endl;
    return;
  }
  cout << surface.getName();
  cout << ", model: " << surface.getModel();
  cout << ", finish: " << surface.getFinish();
  cout << ", type: " << surface.getType();
  cout << ", value: " << surface.getValue();
  cout << endl;
  if (surface.hasProperties()) {
    for (const auto& property : surface.getProperties()) {
      cout << "  - property: ";
      cout << property.getName() << " [";
      for (const auto& value : property.getValues()) cout << value << ", ";
      cout << "], @[";
      for (const auto& value : property.getEnergies()) cout << value / Unit::eV << ", ";
      cout << "] eV" << endl;
    }
  } else {
    cout << "  - properties: None" << endl;
  }
 
}

◆ setAlpha()

void setAlpha ( double alpha )

inline

Sets rotation around x.

Parameters

alpha rotation angle around x

Definition at line 91 of file ARICHPositionElement.h.

91{m_alpha = alpha;}

◆ setBeta()

void setBeta ( double beta )

inline

Sets rotation around y.

Parameters

beta	rotation angle around y

Definition at line 98 of file ARICHPositionElement.h.

98{m_beta = beta;}

◆ setGamma()

void setGamma ( double gamma )

inline

Sets rotation around z.

Parameters

gamma rotation angle around z

Definition at line 105 of file ARICHPositionElement.h.

105{m_gamma = gamma;}

◆ setName()

void setName ( const std::string & name )

inlineinherited

Sets object name.

Parameters

name	object name

Definition at line 43 of file ARICHGeoBase.h.

43{m_name = name;}

◆ setRPhi()

void setRPhi	(	double	r,
		double	phi )

inline

Sets x,y from r,phi.

Parameters

r	radius
phi	phi angle

Definition at line 81 of file ARICHPositionElement.h.

82 {

83 m_x = r * cos(phi / Unit::rad);

84 m_y = r * sin(phi / Unit::rad);

85 }

◆ setX()

void setX ( double x )

inline

Sets translation in x.

Parameters

x	translation in x

Definition at line 62 of file ARICHPositionElement.h.

62{m_x = x;}

◆ setY()

void setY ( double y )

inline

Sets translation in y.

Parameters

y	translation in y

Definition at line 68 of file ARICHPositionElement.h.

68{m_y = y;}

◆ setZ()

void setZ ( double z )

inline

Sets translation in z.

Parameters

z	translation in z

Definition at line 74 of file ARICHPositionElement.h.

74{m_z = z;}

Member Data Documentation

◆ m_alpha

float m_alpha = 0

private

rotation angle around x

Definition at line 205 of file ARICHPositionElement.h.

◆ m_beta

float m_beta = 0

private

rotation angle around y

Definition at line 206 of file ARICHPositionElement.h.

◆ m_gamma

float m_gamma = 0

private

rotation angle around z

Definition at line 207 of file ARICHPositionElement.h.

◆ m_name

std::string m_name

protectedinherited

geometry object name

Definition at line 82 of file ARICHGeoBase.h.

◆ m_x

float m_x = 0

private

translation in x

Definition at line 202 of file ARICHPositionElement.h.

◆ m_y

float m_y = 0

private

translation in y

Definition at line 203 of file ARICHPositionElement.h.

◆ m_z

float m_z = 0

private

translation in z

Definition at line 204 of file ARICHPositionElement.h.

◆ s_unit

double s_unit = Unit::cm

staticprotectedinherited

conversion unit for length

Definition at line 83 of file ARICHGeoBase.h.

◆ s_unitName

std::string s_unitName

staticprotectedinherited

conversion unit name

Definition at line 84 of file ARICHGeoBase.h.

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

arich/dbobjects/include/ARICHPositionElement.h

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ARICHPositionElement() [1/2]

◆ ARICHPositionElement() [2/2]

◆ ~ARICHPositionElement()

Member Function Documentation

◆ addShift()

◆ getAlpha()

◆ getBeta()

◆ getGamma()

◆ getName()

◆ getRotation()

◆ getTranslation()

◆ getX()

◆ getY()

◆ getZ()

◆ isConsistent()

◆ print()

◆ printPlacement()

◆ printSurface()

◆ setAlpha()

◆ setBeta()

◆ setGamma()

◆ setName()

◆ setRPhi()

◆ setX()

◆ setY()

◆ setZ()

Member Data Documentation

◆ m_alpha

◆ m_beta

◆ m_gamma

◆ m_name

◆ m_x

◆ m_y

◆ m_z

◆ s_unit

◆ s_unitName