Geometry description of a TPC wireThe wire is a single straight segment on a wire plane. Different wires may be connected to the same readout channel. That is of no relevance for the geometry description. More...

#include <WireGeo.h>

Classes
struct	WireGeoCoordinatesTag
	Tag for vectors in the "local" GDML coordinate frame of the plane. More...

Public Types
using	GeoNodePath_t = std::vector< TGeoNode const * >

Types for geometry-local reference vectors.
These types represents points and displacement vectors in the reference frame defined in the wire geometry "box" from the GDML geometry description. No alias is explicitly defined for the LArSoft global vector types, `geo::Point_t` and `geo::Vector_t`. Remember the `LocalPoint_t` and `LocalVector_t` vectors from different instances of `geo::WireGeo` have the same type but are not compatible.
using	LocalPoint_t = geo::Point3DBase_t< WireGeoCoordinatesTag >
	Type of points in the local GDML wire plane frame. More...

using	LocalVector_t = geo::Vector3DBase_t< WireGeoCoordinatesTag >
	Type of displacement vectors in the local GDML wire plane frame. More...

Public Member Functions
	WireGeo (TGeoNode const &node, geo::TransformationMatrix &&trans)
	Constructor from a ROOT geometry node and a transformation. More...

const TGeoNode *	Node () const

void	UpdateAfterSorting (geo::WireID const &, bool flip)

Size and coordinates
double	RMax () const
	Returns the outer half-size of the wire [cm]. More...


double	HalfL () const
	Returns half the length of the wire [cm]. More...


double	RMin () const
	Returns the inner radius of the wire (usually 0) [cm]. More...


void	GetCenter (double *xyz, double localz=0.0) const
	Fills the world coordinate of a point on the wire. More...


void	GetStart (double *xyz) const


void	GetEnd (double *xyz) const


template<typename Point >
Point	GetPositionFromCenter (double localz) const
	Returns the position (world coordinate) of a point on the wire. More...

DefaultPoint_t	GetPositionFromCenter (double localz) const


template<typename Point >
Point	GetPositionFromCenterUnbounded (double localz) const
	Returns the position (world coordinate) of a point on the wire. More...

DefaultPoint_t	GetPositionFromCenterUnbounded (double localz) const


template<typename Point >
Point	GetCenter () const

DefaultPoint_t	GetCenter () const


template<typename Point >
Point	GetStart () const

DefaultPoint_t	GetStart () const


template<typename Point >
Point	GetEnd () const

DefaultPoint_t	GetEnd () const


double	Length () const
	Returns the wire length in centimeters. More...

Orientation and angles
double	ThetaZ () const
	Returns angle of wire with respect to z axis in the Y-Z plane in radians. More...


double	ThetaZ (bool degrees) const


double	CosThetaZ () const
	Returns trigonometric operations on ThetaZ() More...

double	SinThetaZ () const

double	TanThetaZ () const


bool	isHorizontal () const
	Returns if this wire is horizontal (theta_z ~ 0) More...


bool	isVertical () const
	Returns if this wire is vertical (theta_z ~ pi/2) More...


bool	isParallelTo (geo::WireGeo const &wire) const
	Returns if this wire is parallel to another. More...


template<typename Vector >
Vector	Direction () const

DefaultVector_t	Direction () const

Coordinate transformation
Local points and displacement vectors are described by the types `geo::WireGeo::LocalPoint_t` and `geo::WireGeo::LocalVector_t`, respectively.
void	LocalToWorld (const double wire, double world) const
	Transform point from local wire frame to world frame. More...

geo::Point_t	toWorldCoords (LocalPoint_t const &local) const
	Transform point from local wire frame to world frame. More...

void	LocalToWorldVect (const double wire, double world) const
	Transform direction vector from local to world. More...

geo::Vector_t	toWorldCoords (LocalVector_t const &local) const
	Transform direction vector from local to world. More...

void	WorldToLocal (const double world, double wire) const
	Transform point from world frame to local wire frame. More...

LocalPoint_t	toLocalCoords (geo::Point_t const &world) const
	Transform point from world frame to local wire frame. More...

void	WorldToLocalVect (const double world, double wire) const
	Transform direction vector from world to local. More...

LocalVector_t	toLocalCoords (geo::Vector_t const &world) const
	Transform direction vector from world to local. More...

Geometric properties and algorithms
double	ComputeZatY0 () const

double	DistanceFrom (geo::WireGeo const &wire) const
	Returns 3D distance from the specified wire. More...

template<typename Point = DefaultPoint_t>
Point	IntersectionWith (geo::WireGeo const &other) const
	Returns the point of this wire that is closest to `other` wire. More...

template<typename Point = DefaultPoint_t>
geo::IntersectionPointAndOffsets< Point >	IntersectionAndOffsetsWith (geo::WireGeo const &other) const
	Returns the point of this wire that is closest to `other` wire. More...

Static Public Member Functions
static double	WirePitch (geo::WireGeo const &w1, geo::WireGeo const &w2)
	Returns the pitch (distance on y/z plane) between two wires, in cm. More...

Private Types
using	DefaultVector_t = TVector3

using	DefaultPoint_t = TVector3

using	LocalTransformation_t = geo::LocalTransformationGeo< ROOT::Math::Transform3D, LocalPoint_t, LocalVector_t >

Private Member Functions
bool	isFlipped () const

double	relLength (double local) const
	Returns the relative length from center to be used when transforming. More...

double	capLength (double local) const
	Caps the specified local length coordinate to lay on the wire. More...

double	capRelLength (double local) const
	Stacked `capLength()` and `relLength()`. More...

void	Flip ()
	Set to swap the start and end wire. More...

Static Private Member Functions
static double	gausSum (double a, double b)

Private Attributes
const TGeoNode *	fWireNode
	Pointer to the wire node. More...

double	fThetaZ
	angle of the wire with respect to the z direction More...

double	fHalfL
	half length of the wire More...

geo::Point_t	fCenter
	Center of the wire in world coordinates. More...

LocalTransformation_t	fTrans
	Wire to world transform. More...

bool	flipped
	whether start and end are reversed More...

Printing
static constexpr unsigned int	MaxVerbosity = 4
	Maximum verbosity supported by `PrintWireInfo()`. More...

template<typename Stream >
void	PrintWireInfo (Stream &&out, std::string indent="", unsigned int verbosity=1) const
	Prints information about this wire. More...

std::string	WireInfo (std::string indent="", unsigned int verbosity=1) const
	Returns a string with all the information of the wire. More...

Detailed Description

Geometry description of a TPC wire

The wire is a single straight segment on a wire plane. Different wires may be connected to the same readout channel. That is of no relevance for the geometry description.

The wire has a start and an end point. Their definition of them is related to the other wires in the plane and to the TPC itself.

The direction of increasing wire coordinate, defined in the wire plane, is orthogonal to the wire direction and of course points to the direction where the wire number within the plane increases. This direction is indirectly defined when sorting the wires in the plane, which is done by the plane (geo::PlaneGeo). This direction lies by definition on the wire plane. The direction normal to the wire plane is defined by the TPC so that it points inward the TPC rather than outward. Finally, the wire direction is defined so that the triplet of unit vectors direction of the wire $\hat{l}$ , direction of increasing wire number $\hat{w}$ , and normal to the plane $\hat{n}$ is positively defined ( $\hat{l} \times \hat{w} \cdot \hat{n} = +1$ ). The start $\vec{a}_{w}$ and the end of the wire $\vec{b}_{w}$ are defined so that their difference $\vec{b}_{w} - \vec{a}_{w}$ points in the same direction as $\hat{l}$ .

Definition at line 65 of file WireGeo.h.

Member Typedef Documentation

using geo::WireGeo::DefaultPoint_t = TVector3

private

Definition at line 68 of file WireGeo.h.

using geo::WireGeo::DefaultVector_t = TVector3

private

Definition at line 67 of file WireGeo.h.

using geo::WireGeo::GeoNodePath_t = std::vector<TGeoNode const*>

Definition at line 72 of file WireGeo.h.

using geo::WireGeo::LocalPoint_t = geo::Point3DBase_t<WireGeoCoordinatesTag>

Type of points in the local GDML wire plane frame.

Definition at line 94 of file WireGeo.h.

using geo::WireGeo::LocalTransformation_t = geo::LocalTransformationGeo <ROOT::Math::Transform3D, LocalPoint_t, LocalVector_t>

private

Definition at line 481 of file WireGeo.h.

using geo::WireGeo::LocalVector_t = geo::Vector3DBase_t<WireGeoCoordinatesTag>

Type of displacement vectors in the local GDML wire plane frame.

Definition at line 97 of file WireGeo.h.

Constructor & Destructor Documentation

geo::WireGeo::WireGeo	(	TGeoNode const &	node,
		geo::TransformationMatrix &&	trans
	)

Constructor from a ROOT geometry node and a transformation.

Parameters

node	ROOT geometry node
trans	transformation matrix (local to world)

The node describes the shape of the wire (the only relevant information is in fact the length), while the transformation described its positioning in the world (both position and orientation).

A pointer to the node and a copy of the transformation matrix are kept in the WireGeo object.

Definition at line 32 of file WireGeo.cxx.

     : fWireNode(&node)
     , fTrans(std::move(trans))
     , flipped(false)
   {
     fHalfL    = ((TGeoTube*)fWireNode->GetVolume()->GetShape())->GetDZ();
 
     // uncomment the following to check the paths to the wires
     //   std::string p(base);
     //   for(int i = 0; i <= depth; ++i){
     //     p += "/";
     //     p += path[i]->GetName();
     //   }
     //   std::cout << p.c_str() << std::endl;
 
     // determine the orientation of the wire
     auto lp = geo::origin<LocalPoint_t>();
     fCenter = toWorldCoords(lp);
 
     lp.SetZ(fHalfL);
     auto end = toWorldCoords(lp);
 
     fThetaZ = std::acos(std::clamp((end.Z() - fCenter.Z())/fHalfL, -1.0, +1.0));
 
     // check to see if it runs "forward" or "backwards" in z
     // check is made looking at the y position of the end point
     // relative to the center point because you want to know if
     // the end point is above or below the center of the wire in
     // the yz plane
     if(end.Y() < fCenter.Y()) fThetaZ *= -1.;
 
     //This ensures we are looking at the angle between 0 and Pi
     //as if the wire runs at one angle it also runs at that angle +-Pi
     if(fThetaZ < 0) fThetaZ += util::pi();
     
     assert(std::isfinite(fThetaZ));
 
   } // geo::WireGeo::WireGeo()

Member Function Documentation

double geo::WireGeo::capLength ( double local ) const

inlineprivate

Caps the specified local length coordinate to lay on the wire.

Definition at line 498 of file WireGeo.h.

499 { return std::min(+HalfL(), std::max(-HalfL(), local)); }

max

static int max(int a, int b)

Definition: fortranscanner.cpp:60366

geo::WireGeo::HalfL

double HalfL() const

Returns half the length of the wire [cm].

Definition: WireGeo.h:128

cet::sqlite::min

T min(sqlite3 *const db, std::string const &table_name, std::string const &column_name)

Definition: statistics.h:55

double geo::WireGeo::capRelLength ( double local ) const

inlineprivate

Stacked capLength() and relLength().

Definition at line 502 of file WireGeo.h.

503 { return capLength(relLength(local)); }

geo::WireGeo::relLength

double relLength(double local) const

Returns the relative length from center to be used when transforming.

Definition: WireGeo.h:495

geo::WireGeo::capLength

double capLength(double local) const

Caps the specified local length coordinate to lay on the wire.

Definition: WireGeo.h:498

double geo::WireGeo::ComputeZatY0 ( ) const

inline

Returns the z coordinate, in centimetres, at the point where y = 0. Assumes the wire orthogonal to x axis and the wire not parallel to z.

Definition at line 399 of file WireGeo.h.

400 { return fCenter.Z() - fCenter.Y() / TanThetaZ(); }

geo::WireGeo::fCenter

geo::Point_t fCenter

Center of the wire in world coordinates.

Definition: WireGeo.h:486

geo::WireGeo::TanThetaZ

double TanThetaZ() const

Definition: WireGeo.h:266

double geo::WireGeo::CosThetaZ ( ) const

inline

Returns trigonometric operations on ThetaZ()

Definition at line 264 of file WireGeo.h.

264 { return std::cos(ThetaZ()); }

geo::WireGeo::ThetaZ

double ThetaZ() const

Returns angle of wire with respect to z axis in the Y-Z plane in radians.

Definition: WireGeo.h:250

template<typename Vector >

Vector geo::WireGeo::Direction ( ) const

Returns the wire direction as a norm-one vector.

Template Parameters

Vector type of the vector being returned

Definition at line 587 of file WireGeo.h.

                                    {
   // maybe (GetCenter() - GetStart()) / HalfL() would be faster;
   // strangely, TVector3 does not implement operator/ (double).
   return geo::vect::convertTo<Vector>(GetEnd<geo::Point_t>() - GetStart<geo::Point_t>()) * (1.0 / Length());
 } // geo::WireGeo::Direction()

DefaultVector_t geo::WireGeo::Direction ( ) const

inline

Definition at line 293 of file WireGeo.h.

293 { return Direction<DefaultVector_t>(); }

double geo::WireGeo::DistanceFrom ( geo::WireGeo const & wire ) const

Returns 3D distance from the specified wire.

Returns: the signed distance in centimetres (0 if wires are not parallel)

If the specified wire is "ahead" in z respect to this, the distance is returned negative.

Definition at line 113 of file WireGeo.cxx.

                                                            {
     //
     // The algorithm assumes that picking any point on the wire will do,
     // that is, that the wires are parallel.
     //
 
     if (!isParallelTo(wire)) return 0;
 
     // a vector connecting to the other wire
     auto const toWire = wire.GetCenter() - GetCenter();
 
     // the distance is that vector, times the sine of the angle with the wire
     // direction; we get that in a generic way with a cross product.
     // We don't even care about the sign here
     // (if we did, we would do a dot-product with the normal to the plane,
     // and we should get a positive distance if the other wire has larger wire
     // coordinate than this one).
     return toWire.Cross(Direction()).Mag();
 
   } // WireGeo::DistanceFrom()

void geo::WireGeo::Flip ( )

private

Set to swap the start and end wire.

Definition at line 144 of file WireGeo.cxx.

                      {
     // we don't need to do much to flip so far:
     // - ThetaZ() is defined in [0, pi], invariant to flipping
     // - we don't change the transformation matrices, that we want to be
     //   untouched and coherent with the original geometry source
     // - center is invariant for flipping
     // - start and end are computed on the fly (taking flipping into account)
     // - ... and we chose to leave half length unsigned and independent
 
     // change the flipping bit
     flipped = !flipped;
 
   } // WireGeo::Flip()

static double geo::WireGeo::gausSum	(	double	a,
		double	b
	)

inlinestaticprivate

Definition at line 509 of file WireGeo.h.

509 { return std::sqrt(a*a + b*b); }

a

const double a

Definition: gUpMuFluxGen.cxx:164

b

static bool * b

Definition: config.cpp:1043

void geo::WireGeo::GetCenter	(	double *	xyz,
		double	localz = `0.0`
	)		const

Fills the world coordinate of a point on the wire.

Parameters

xyz	_(output)_ the position to be filled, as [ x, y, z ] (in cm)
localz	distance of the requested point from the middle of the wire

See also: GetCenter(), GetStart(), GetEnd(), GetPositionFromCenter()

The center of the wires corresponds to localz equal to 0; negative positions head toward the start of the wire, positive toward the end.

If the localz position would put the point outside the wire, the returned position is the wire end closest to the requested position.

Deprecated:: Use the version returning a vector instead.

Definition at line 73 of file WireGeo.cxx.

   {
     if (localz == 0.) { // if no dislocation is requested, we already have it
       geo::vect::fillCoords(xyz, fCenter);
       return;
     }
 
     double locz = relLength(localz);
     if (std::abs(locz) > fHalfL) {
       mf::LogWarning("WireGeo") << "asked for position along wire that"
         " extends beyond the wire, returning position at end point";
       locz = relLength((locz < 0)? -fHalfL: fHalfL);
     }
     const double local[3] = { 0., 0., locz };
     LocalToWorld(local, xyz);
   }

template<typename Point >

Point geo::WireGeo::GetCenter ( ) const

inline

Returns the world coordinate of the center of the wire [cm]

Template Parameters

Point type of the point being returned

Definition at line 212 of file WireGeo.h.

212 { return geo::vect::convertTo<Point>(fCenter); }

geo::WireGeo::fCenter

geo::Point_t fCenter

Center of the wire in world coordinates.

Definition: WireGeo.h:486

DefaultPoint_t geo::WireGeo::GetCenter ( ) const

inline

Definition at line 213 of file WireGeo.h.

213 { return GetCenter<DefaultPoint_t>(); }

void geo::WireGeo::GetEnd ( double * xyz ) const

inline

Fills the world coordinate of one end of the wire

Deprecated:: Use the version returning a vector instead.

Definition at line 163 of file WireGeo.h.

163 { GetCenter(xyz, +fHalfL); }

geo::WireGeo::GetCenter

Point GetCenter() const

Definition: WireGeo.h:212

geo::WireGeo::fHalfL

double fHalfL

half length of the wire

Definition: WireGeo.h:485

template<typename Point >

Point geo::WireGeo::GetEnd ( ) const

inline

Returns the world coordinate of one end of the wire [cm]

Template Parameters

Point type of the point being returned

Definition at line 229 of file WireGeo.h.

230 { return GetPositionFromCenterUnbounded<Point>(+HalfL()); }

geo::WireGeo::HalfL

double HalfL() const

Returns half the length of the wire [cm].

Definition: WireGeo.h:128

DefaultPoint_t geo::WireGeo::GetEnd ( ) const

inline

Definition at line 231 of file WireGeo.h.

231 { return GetEnd<DefaultPoint_t>(); }

template<typename Point >

Point geo::WireGeo::GetPositionFromCenter ( double localz ) const

inline

Returns the position (world coordinate) of a point on the wire.

Template Parameters

Point type of vector to be returned (current default: TVector3)

Parameters

localz distance of the requested point from the middle of the wire

Returns: the position of the requested point (in cm)

See also: GetCenter(), GetStart(), GetEnd(), GetPositionFromCenterUnbounded()

The center of the wires corresponds to localz equal to 0; negative positions head toward the start of the wire, positive toward the end.

If the localz position would put the point outside the wire, the returned position is the wire end closest to the requested position.

Definition at line 182 of file WireGeo.h.

183 { return GetPositionFromCenterUnbounded<Point>(capLength(localz)); }

geo::WireGeo::capLength

double capLength(double local) const

Caps the specified local length coordinate to lay on the wire.

Definition: WireGeo.h:498

DefaultPoint_t geo::WireGeo::GetPositionFromCenter ( double localz ) const

inline

Definition at line 184 of file WireGeo.h.

185 { return GetPositionFromCenter<DefaultPoint_t>(localz); }

template<typename Point >

Point geo::WireGeo::GetPositionFromCenterUnbounded ( double localz ) const

Returns the position (world coordinate) of a point on the wire.

Template Parameters

Point type of vector to be returned (current default: TVector3)

Parameters

localz distance of the requested point from the middle of the wire

Returns: the position of the requested point (in cm)

See also: GetCenter(), GetStart(), GetEnd(), GetPositionFromCenter()

The center of the wires corresponds to localz equal to 0; negative positions head toward the start of the wire, positive toward the end.

If the localz position would put the point outside the wire, the returned position will lie beyond the end of the wire.

Definition at line 579 of file WireGeo.h.

                                                                     {
   return geo::vect::convertTo<Point>
     (toWorldCoords(LocalPoint_t{ 0.0, 0.0, relLength(localz) }));
 } // geo::WireGeo::GetPositionFromCenterImpl()

DefaultPoint_t geo::WireGeo::GetPositionFromCenterUnbounded ( double localz ) const

inline

Definition at line 204 of file WireGeo.h.

205 { return GetPositionFromCenterUnbounded<DefaultPoint_t>(localz); }

void geo::WireGeo::GetStart ( double * xyz ) const

inline

Fills the world coordinate of one end of the wire

Deprecated:: Use the version returning a vector instead.

Definition at line 157 of file WireGeo.h.

157 { GetCenter(xyz, -fHalfL); }

geo::WireGeo::GetCenter

Point GetCenter() const

Definition: WireGeo.h:212

geo::WireGeo::fHalfL

double fHalfL

half length of the wire

Definition: WireGeo.h:485

template<typename Point >

Point geo::WireGeo::GetStart ( ) const

inline

Returns the world coordinate of one end of the wire [cm]

Template Parameters

Point type of the point being returned

Definition at line 220 of file WireGeo.h.

221 { return GetPositionFromCenterUnbounded<Point>(-HalfL()); }

geo::WireGeo::HalfL

double HalfL() const

Returns half the length of the wire [cm].

Definition: WireGeo.h:128

DefaultPoint_t geo::WireGeo::GetStart ( ) const

inline

Definition at line 222 of file WireGeo.h.

222 { return GetStart<DefaultPoint_t>(); }

double geo::WireGeo::HalfL ( ) const

inline

Returns half the length of the wire [cm].

Definition at line 128 of file WireGeo.h.

128 { return fHalfL; }

geo::WireGeo::fHalfL

double fHalfL

half length of the wire

Definition: WireGeo.h:485

template<typename Point >

geo::IntersectionPointAndOffsets< Point > geo::WireGeo::IntersectionAndOffsetsWith ( geo::WireGeo const & other ) const

Returns the point of this wire that is closest to other wire.

Template Parameters

Point the type of point returned

Parameters

other the other wire

Returns: a data structure with three fields: point: the point of this wire closest to other; offset1: its offset on this wire [cm]; offset2: its offset on the other wire [cm]

See also: IntersectionWith()

The point of this wire that is closest to any point of the other wire is returned. The returned intersection point is the same as for IntersectionWith(other). The return value is actually triplet, though, which is most easily unpacked immediately:

auto [ point, offset, otherOffset ]

= wire.IntersectionAndOffsetsWith(otherWire);

The two other elements of the triplets are the distances of the intersection point from the center of this wire (offset in the example) and from the center of the other wire (otherOffset), in centimeters. The sign of the offsets are positive if the intersection points lie on the side pointed by the Direction() of the respective wires.

To reassign the variables after they have been defined, instead:

std::tie(point, otherOffset, offset)

= otherWire.IntersectionAndOffsetsWith(wire);

Definition at line 645 of file WireGeo.h.

 {
   auto const& [ point, ofsA, ofsB ] = WiresIntersectionAndOffsets(*this, other);
   return { geo::vect::convertTo<Point>(point), ofsA, ofsB };
 } // geo::WireGeo::IntersectionAndOffsetsWith()

template<typename Point >

Point geo::WireGeo::IntersectionWith ( geo::WireGeo const & other ) const

Returns the point of this wire that is closest to other wire.

Template Parameters

Point the type of point returned

Parameters

other the other wire

Returns: the point of this wire closest to other

See also: IntersectionAndOffsetsWith()

The point of this wire that is closest to any point of the other wire is returned.

The other wire is assumed not to be parallel to this one, and when this prerequisite is not met the behaviour is undefined.

Another method, IntersectionAndOffsetsWith(), also returns the offset of the intersection from the two wire centers.

Definition at line 637 of file WireGeo.h.

                                                                 {
   return geo::vect::convertTo<Point>(WiresIntersection(*this, other));
 } // geo::WireGeo::IntersectionWith()

bool geo::WireGeo::isFlipped ( ) const

inlineprivate

Returns whether ( 0, 0, fHalfL ) identifies end (false) or start (true) of the wire.

Definition at line 492 of file WireGeo.h.

492 { return flipped; }

geo::WireGeo::flipped

bool flipped

whether start and end are reversed

Definition: WireGeo.h:488

bool geo::WireGeo::isHorizontal ( ) const

inline

Returns if this wire is horizontal (theta_z ~ 0)

Definition at line 271 of file WireGeo.h.

271 { return std::abs(SinThetaZ()) < 1e-5; }

geo::WireGeo::SinThetaZ

double SinThetaZ() const

Definition: WireGeo.h:265

abs

T abs(T value)

Definition: sparse_vector_test.cc:30

e

const double e

Definition: gUpMuFluxGen.cxx:165

bool geo::WireGeo::isParallelTo ( geo::WireGeo const & wire ) const

inline

Returns if this wire is parallel to another.

Definition at line 281 of file WireGeo.h.

       {
         return // parallel if the dot product of the directions is about +/- 1
           std::abs(std::abs(Direction<geo::Vector_t>().Dot(wire.Direction<geo::Vector_t>())) - 1.) < 1e-5;
       }

bool geo::WireGeo::isVertical ( ) const

inline

Returns if this wire is vertical (theta_z ~ pi/2)

Definition at line 276 of file WireGeo.h.

276 { return std::abs(CosThetaZ()) < 1e-5; }

abs

T abs(T value)

Definition: sparse_vector_test.cc:30

e

const double e

Definition: gUpMuFluxGen.cxx:165

geo::WireGeo::CosThetaZ

double CosThetaZ() const

Returns trigonometric operations on ThetaZ()

Definition: WireGeo.h:264

double geo::WireGeo::Length ( ) const

inline

Returns the wire length in centimeters.

Definition at line 236 of file WireGeo.h.

236 { return 2. * HalfL(); }

geo::WireGeo::HalfL

double HalfL() const

Returns half the length of the wire [cm].

Definition: WireGeo.h:128

void geo::WireGeo::LocalToWorld	(	const double *	wire,
		double *	world
	)		const

inline

Transform point from local wire frame to world frame.

Definition at line 355 of file WireGeo.h.

356 { fTrans.LocalToWorld(wire, world); }

geo::LocalTransformation::LocalToWorld

void LocalToWorld(double const *local, double *world) const

Transforms a point from local frame to world frame.

geo::WireGeo::fTrans

LocalTransformation_t fTrans

Wire to world transform.

Definition: WireGeo.h:487

void geo::WireGeo::LocalToWorldVect	(	const double *	wire,
		double *	world
	)		const

inline

Transform direction vector from local to world.

Definition at line 363 of file WireGeo.h.

364 { fTrans.LocalToWorldVect(wire, world); }

geo::LocalTransformation::LocalToWorldVect

void LocalToWorldVect(double const *local, double *world) const

Transforms a vector from local frame to world frame.

geo::WireGeo::fTrans

LocalTransformation_t fTrans

Wire to world transform.

Definition: WireGeo.h:487

const TGeoNode* geo::WireGeo::Node ( ) const

inline

Definition at line 390 of file WireGeo.h.

390 { return fWireNode; }

geo::WireGeo::fWireNode

const TGeoNode * fWireNode

Pointer to the wire node.

Definition: WireGeo.h:483

template<typename Stream >

void geo::WireGeo::PrintWireInfo	(	Stream &&	out,
		std::string	indent = `""`,
		unsigned int	verbosity = `1`
	)		const

Prints information about this wire.

Template Parameters

Stream type of output stream to use

Parameters

out	stream to send the information to
indent	prepend each line with this string
verbosity	amount of information printed

Note that the first line out the output is not indented.

Verbosity levels

0: only start and end
1 _(default)_: also length
2: also angle with z axis
3: also center
4: also direction

The constant MaxVerbosity is set to the highest supported verbosity level.

Definition at line 596 of file WireGeo.h.

         {
 
   //----------------------------------------------------------------------------
   out << "wire from " << GetStart<geo::Point_t>()
     << " to " << GetEnd<geo::Point_t>();
 
   if (verbosity-- <= 0) return; // 0
 
   //----------------------------------------------------------------------------
   out << " (" << Length() << " cm long)";
 
   if (verbosity-- <= 0) return; // 1
 
   //----------------------------------------------------------------------------
   out << ", theta(z)=" << ThetaZ() << " rad";
 
   if (verbosity-- <= 0) return; // 2
 
   //----------------------------------------------------------------------------
   out << "\n" << indent
     << "  center at " << GetCenter<geo::Point_t>() << " cm";
 
   if (verbosity-- <= 0) return; // 3
 
   //----------------------------------------------------------------------------
   out << ", direction: " << Direction<geo::Vector_t>();
   if (isHorizontal()) out << " (horizontal)";
   if (isVertical()) out << " (vertical)";
 
 //  if (verbosity-- <= 0) return; // 4
 
   //----------------------------------------------------------------------------
 } // geo::WireGeo::PrintWireInfo()

double geo::WireGeo::relLength ( double local ) const

inlineprivate

Returns the relative length from center to be used when transforming.

Definition at line 495 of file WireGeo.h.

495 { return isFlipped()? -local: local; }

geo::WireGeo::isFlipped

bool isFlipped() const

Definition: WireGeo.h:492

double geo::WireGeo::RMax ( ) const

Returns the outer half-size of the wire [cm].

Definition at line 91 of file WireGeo.cxx.

92 { return ((TGeoTube*)fWireNode->GetVolume()->GetShape())->GetRmax(); }

geo::WireGeo::fWireNode

const TGeoNode * fWireNode

Pointer to the wire node.

Definition: WireGeo.h:483

double geo::WireGeo::RMin ( ) const

Returns the inner radius of the wire (usually 0) [cm].

Definition at line 95 of file WireGeo.cxx.

96 { return ((TGeoTube*)fWireNode->GetVolume()->GetShape())->GetRmin(); }

geo::WireGeo::fWireNode

const TGeoNode * fWireNode

Pointer to the wire node.

Definition: WireGeo.h:483

double geo::WireGeo::SinThetaZ ( ) const

inline

Definition at line 265 of file WireGeo.h.

265 { return std::sin(ThetaZ()); }

geo::WireGeo::ThetaZ

double ThetaZ() const

Returns angle of wire with respect to z axis in the Y-Z plane in radians.

Definition: WireGeo.h:250

double geo::WireGeo::TanThetaZ ( ) const

inline

Definition at line 266 of file WireGeo.h.

266 { return std::tan(ThetaZ()); }

geo::WireGeo::ThetaZ

double ThetaZ() const

Returns angle of wire with respect to z axis in the Y-Z plane in radians.

Definition: WireGeo.h:250

double geo::WireGeo::ThetaZ ( ) const

inline

Returns angle of wire with respect to z axis in the Y-Z plane in radians.

Definition at line 250 of file WireGeo.h.

250 { return fThetaZ; }

geo::WireGeo::fThetaZ

double fThetaZ

angle of the wire with respect to the z direction

Definition: WireGeo.h:484

double geo::WireGeo::ThetaZ ( bool degrees ) const

Returns angle of wire with respect to z axis in the Y-Z plane

Parameters

degrees return the angle in degrees rather than radians

Returns: wire angle

Definition at line 99 of file WireGeo.cxx.

100 { return degrees? util::RadiansToDegrees(fThetaZ): fThetaZ; }

geo::WireGeo::fThetaZ

double fThetaZ

angle of the wire with respect to the z direction

Definition: WireGeo.h:484

util::RadiansToDegrees

constexpr T RadiansToDegrees(T angle)

Converts the argument angle from radians into degrees ( )

Definition: PhysicalConstants.h:88

LocalPoint_t geo::WireGeo::toLocalCoords ( geo::Point_t const & world ) const

inline

Transform point from world frame to local wire frame.

Definition at line 375 of file WireGeo.h.

376 { return fTrans.toLocalCoords(world); }

geo::LocalTransformationGeo::toLocalCoords

LocalPoint_t toLocalCoords(GlobalPoint_t const &world) const

Transforms a point from world frame to local frame.

Definition: LocalTransformationGeo.h:134

geo::WireGeo::fTrans

LocalTransformation_t fTrans

Wire to world transform.

Definition: WireGeo.h:487

LocalVector_t geo::WireGeo::toLocalCoords ( geo::Vector_t const & world ) const

inline

Transform direction vector from world to local.

Definition at line 383 of file WireGeo.h.

384 { return fTrans.toLocalCoords(world); }

geo::LocalTransformationGeo::toLocalCoords

LocalPoint_t toLocalCoords(GlobalPoint_t const &world) const

Transforms a point from world frame to local frame.

Definition: LocalTransformationGeo.h:134

geo::WireGeo::fTrans

LocalTransformation_t fTrans

Wire to world transform.

Definition: WireGeo.h:487

geo::Point_t geo::WireGeo::toWorldCoords ( LocalPoint_t const & local ) const

inline

Transform point from local wire frame to world frame.

Definition at line 359 of file WireGeo.h.

360 { return fTrans.toWorldCoords(local); }

geo::WireGeo::fTrans

LocalTransformation_t fTrans

Wire to world transform.

Definition: WireGeo.h:487

geo::LocalTransformationGeo::toWorldCoords

GlobalPoint_t toWorldCoords(LocalPoint_t const &local) const

Transforms a point from local frame to world frame.

Definition: LocalTransformationGeo.h:104

geo::Vector_t geo::WireGeo::toWorldCoords ( LocalVector_t const & local ) const

inline

Transform direction vector from local to world.

Definition at line 367 of file WireGeo.h.

368 { return fTrans.toWorldCoords(local); }

geo::WireGeo::fTrans

LocalTransformation_t fTrans

Wire to world transform.

Definition: WireGeo.h:487

geo::LocalTransformationGeo::toWorldCoords

GlobalPoint_t toWorldCoords(LocalPoint_t const &local) const

Transforms a point from local frame to world frame.

Definition: LocalTransformationGeo.h:104

void geo::WireGeo::UpdateAfterSorting	(	geo::WireID const &	,
		bool	flip
	)

Internal updates after the relative position of the wire is known (currently no-op)

Definition at line 136 of file WireGeo.cxx.

                                                               {
 
     // flip, if asked
     if (flip) Flip();
 
   } // WireGeo::UpdateAfterSorting()

std::string geo::WireGeo::WireInfo	(	std::string	indent = `""`,
		unsigned int	verbosity = `1`
	)		const

Returns a string with all the information of the wire.

See also: PrintWireInfo()

All arguments are equivalent to the ones of PrintWireInfo.

Definition at line 104 of file WireGeo.cxx.

   {
     std::ostringstream sstr;
     PrintWireInfo(sstr, indent, verbosity);
     return sstr.str();
   } // WireGeo::WireInfo()

static double geo::WireGeo::WirePitch	(	geo::WireGeo const &	w1,
		geo::WireGeo const &	w2
	)

inlinestatic

Returns the pitch (distance on y/z plane) between two wires, in cm.

Definition at line 476 of file WireGeo.h.

477 { return std::abs(w2.DistanceFrom(w1)); }

abs

T abs(T value)

Definition: sparse_vector_test.cc:30

void geo::WireGeo::WorldToLocal	(	const double *	world,
		double *	wire
	)		const

inline

Transform point from world frame to local wire frame.

Definition at line 371 of file WireGeo.h.

372 { fTrans.WorldToLocal(world, wire); }

geo::LocalTransformation::WorldToLocal

void WorldToLocal(double const *world, double *local) const

Transforms a point from world frame to local frame.

geo::WireGeo::fTrans

LocalTransformation_t fTrans

Wire to world transform.

Definition: WireGeo.h:487

void geo::WireGeo::WorldToLocalVect	(	const double *	world,
		double *	wire
	)		const

inline

Transform direction vector from world to local.

Definition at line 379 of file WireGeo.h.

380 { fTrans.WorldToLocalVect(world, wire); }

geo::WireGeo::fTrans

LocalTransformation_t fTrans

Wire to world transform.

Definition: WireGeo.h:487

geo::LocalTransformation::WorldToLocalVect

void WorldToLocalVect(const double *world, double *local) const

Transforms a vector from world frame to local frame.

Member Data Documentation

geo::Point_t geo::WireGeo::fCenter

private

Center of the wire in world coordinates.

Definition at line 486 of file WireGeo.h.

double geo::WireGeo::fHalfL

private

half length of the wire

Definition at line 485 of file WireGeo.h.

bool geo::WireGeo::flipped

private

whether start and end are reversed

Definition at line 488 of file WireGeo.h.

double geo::WireGeo::fThetaZ

private

angle of the wire with respect to the z direction

Definition at line 484 of file WireGeo.h.

LocalTransformation_t geo::WireGeo::fTrans

private

Wire to world transform.

Definition at line 487 of file WireGeo.h.

const TGeoNode* geo::WireGeo::fWireNode

private

Pointer to the wire node.

Definition at line 483 of file WireGeo.h.

constexpr unsigned int geo::WireGeo::MaxVerbosity = 4

static

Maximum verbosity supported by PrintWireInfo().

Definition at line 338 of file WireGeo.h.

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

larcorealg/larcorealg/Geometry/WireGeo.h
larcorealg/larcorealg/Geometry/WireGeo.cxx

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Printing

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Verbosity levels

Member Data Documentation