Geometry information for a single wire plane.The plane is represented in the geometry by a solid which contains wires. Currently, only box solids are well supported. The box which is representation of the plane has some thickness, and it should not be assumed that the wires are in the median section of it, that is, the center of the box may not lie on the plane defined by the wires. More...

#include "PlaneGeo.h"

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

struct	RectSpecs

struct	WidthDepthReferenceTag
	Tag for plane frame base vectors. More...

struct	WireCoordinateReferenceTag
	Tag for wire base vectors. More...

Public Types
using	ID_t = PlaneID

using	WireCollection_t = std::vector< geo::WireGeo >

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

using	ElementIteratorBox = WireCollection_t const &
	Type returned by `IterateElements()`. More...

using	Rect = lar::util::simple_geo::Rectangle< double >
	Type for description of rectangles. More...

Types for geometry-local reference vectors.
These types represents points and displacement vectors in the reference frame defined in the plane 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::PlaneGeo` have the same type but are not compatible.
using	LocalPoint_t = geo::Point3DBase_t< PlaneGeoCoordinatesTag >
	Type of points in the local GDML wire plane frame. More...

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

Types for vectors in the wire coordinate frame.
using	WireCoordProjection_t = ROOT::Math::DisplacementVector2D< ROOT::Math::Cartesian2D< double >, WireCoordinateReferenceTag >
	Type for projections in the wire base representation. More...

using	WireDecomposer_t = geo::Decomposer< geo::Vector_t, geo::Point_t, WireCoordProjection_t >
	Type used for plane decompositions on wire base. More...

using	WireDecomposedVector_t = WireDecomposer_t::DecomposedVector_t
	Type describing a 3D point or vector decomposed on a plane on wire base. More...

Types for vectors in the width/depth coordinate frame.
using	WidthDepthProjection_t = ROOT::Math::DisplacementVector2D< ROOT::Math::Cartesian2D< double >, WidthDepthReferenceTag >

using	WidthDepthDisplacement_t = ROOT::Math::DisplacementVector2D< ROOT::Math::Cartesian2D< double >, WidthDepthReferenceTag >
	Type for vector projections in the plane frame base representation. More...

using	WidthDepthDecomposer_t = geo::Decomposer< geo::Vector_t, geo::Point_t, WidthDepthProjection_t >
	Type used for plane decompositions on plane frame (width/depth). More...

using	WDDecomposedVector_t = WidthDepthDecomposer_t::DecomposedVector_t

Public Member Functions
	PlaneGeo (TGeoNode const &node, geo::TransformationMatrix &&trans, WireCollection_t &&wires)
	Construct a representation of a single plane of the detector. More...

double	Width () const
	Return the width of the plane. More...

double	Depth () const
	Return the depth of the plane. More...

geo::BoxBoundedGeo	BoundingBox () const

WireGeo const &	Wire (unsigned int iwire) const

geo::WirePtr	WirePtr (unsigned int iwire) const
	Returns the wire number iwire from this plane. More...

const WireGeo &	FirstWire () const
	Return the first wire in the plane. More...

const WireGeo &	MiddleWire () const
	Return the middle wire in the plane. More...

const WireGeo &	LastWire () const
	Return the last wire in the plane. More...

geo::WireGeo const &	NearestWire (geo::Point_t const &pos) const
	Returns the wire closest to the specified position. More...

geo::WireID	ClosestWireID (geo::WireID::WireID_t wireNo) const
	Returns the closest valid wire ID to the specified wire. More...

geo::WireID	ClosestWireID (geo::WireID const &wireid) const
	Returns the closest valid wire ID to the specified wire. More...

Rect const &	ActiveArea () const
	Returns an area covered by the wires in the plane. More...

template<typename Stream >
void	PrintPlaneInfo (Stream &&out, std::string indent="", unsigned int verbosity=1) const
	Returns a volume including all the wires in the plane. More...

std::string	PlaneInfo (std::string indent="", unsigned int verbosity=1) const
	Returns a string with plane information. More...

double	WireCoordinate (geo::Point_t const &point) const
	Returns the coordinate of the point on the plane, in wire units. More...

WidthDepthProjection_t	DeltaFromPlane (WidthDepthProjection_t const &proj, double wMargin, double dMargin) const
	Returns a projection vector that, added to the argument, gives a projection inside (or at the border of) the plane. More...

WidthDepthProjection_t	DeltaFromPlane (WidthDepthProjection_t const &proj, double margin=0.0) const
	Returns a projection vector that, added to the argument, gives a projection inside (or at the border of) the area of plane. More...

WidthDepthProjection_t	DeltaFromActivePlane (WidthDepthProjection_t const &proj, double wMargin, double dMargin) const
	Returns a projection vector that, added to the argument, gives a projection inside (or at the border of) the active area of plane. More...

WidthDepthProjection_t	DeltaFromActivePlane (WidthDepthProjection_t const &proj, double margin=0.0) const
	Returns a projection vector that, added to the argument, gives a projection inside (or at the border of) the active area of plane. More...

WidthDepthProjection_t	MoveProjectionToPlane (WidthDepthProjection_t const &proj) const
	Returns the projection, moved onto the plane if necessary. More...

void	SortWires (geo::GeoObjectSorter const &sorter)
	Apply sorting to WireGeo objects. More...

void	UpdateAfterSorting (geo::PlaneID planeid, geo::BoxBoundedGeo const &TPCbox)
	Performs all needed updates after the TPC has sorted the planes. More...

Plane properties
View_t	View () const
	Which coordinate does this plane measure. More...

Orient_t	Orientation () const
	What is the orientation of the plane. More...

double	ThetaZ () const
	Angle of the wires from positive z axis; $\theta_{z} \in [ 0, \pi ]$ . More...

double	PhiZ () const
	Angle from positive z axis of the wire coordinate axis, in radians. More...

double	SinPhiZ () const
	Sine of PhiZ() More...

double	CosPhiZ () const
	Cosine of PhiZ() More...

geo::PlaneID const &	ID () const
	Returns the identifier of this plane. More...

Plane size and coordinates
Vector_t const &	WidthDir () const
	Return the direction of plane width. More...


Vector_t const &	DepthDir () const
	Return the direction of plane depth. More...

Wire access
unsigned int	Nwires () const
	Number of wires in this plane. More...

unsigned int	NElements () const
	Number of wires in this plane. More...


bool	HasWire (unsigned int iwire) const
	Returns whether a wire with index iwire is present in this plane. More...

bool	HasElement (unsigned int iwire) const
	Returns whether a wire with index iwire is present in this plane. More...


bool	HasWire (geo::WireID const &wireid) const
	Returns whether the wire in wireid is present in this plane. More...

bool	HasElement (geo::WireID const &wireid) const
	Returns whether the wire in wireid is present in this plane. More...


WireGeo const &	Wire (WireID const &wireid) const
	Returns the wire in wireid from this plane. More...

WireGeo const &	GetElement (WireID const &wireid) const
	Returns the wire in wireid from this plane. More...


geo::WirePtr	WirePtr (WireID const &wireid) const
	Returns the wire in wireid from this plane. More...

geo::WirePtr	GetElementPtr (WireID const &wireid) const
	Returns the wire in wireid from this plane. More...


ElementIteratorBox	IterateElements () const
	Allows range-for iteration on all wires in this plane. More...

ElementIteratorBox	IterateWires () const
	Allows range-for iteration on all wires in this plane. More...

Plane geometry properties
double	WirePitch () const
	Return the wire pitch (in centimeters). It is assumed constant. More...

bool	WireIDincreasesWithZ () const
	Returns whether the higher z wires have higher wire ID. More...

Vector_t const &	GetNormalDirection () const
	Returns the direction normal to the plane. More...


Vector_t const &	GetIncreasingWireDirection () const
	Returns the direction of increasing wires. More...


Point_t const &	GetCenter () const
	Returns the centre of the wire plane in world coordinates [cm]. More...


Point_t	GetBoxCenter () const
	Returns the centre of the box representing the plane. More...


Vector_t const &	GetWireDirection () const
	Returns the direction of the wires. More...


geo::WireID	NearestWireID (geo::Point_t const &pos) const
	Returns the ID of wire closest to the specified position. More...


double	DistanceFromPlane (geo::Point_t const &point) const
	Returns the distance of the specified point from the wire plane. More...


void	DriftPoint (geo::Point_t &position, double distance) const
	Shifts the position of an electron drifted by a distance. More...


void	DriftPoint (geo::Point_t &position) const
	Shifts the position along drift direction to fall on the plane. More...


double	InterWireProjectedDistance (WireCoordProjection_t const &projDir) const
	Returns the distance between wires along the specified direction. More...


double	InterWireDistance (geo::Vector_t const &dir) const
	Returns the distance between wires along the specified direction. More...


double	InterWireProjectedDistance (Vector_t const &dir) const
	Returns the distance between wires along the specified direction. More...

Projections on wire length/wire coordinate direction base
These methods deal with projection of points and vectors on the plane, using a geometric reference base which is dependent on the wire direction. This is useful for plane reconstruction.
double	PlaneCoordinateFrom (geo::Point_t const &point, geo::WireGeo const &refWire) const
	Returns the coordinate of point on the plane respect to a wire. More...


double	PlaneCoordinate (geo::Point_t const &point) const
	Returns the coordinate of the point on the plane. More...


WireDecomposedVector_t	DecomposePoint (geo::Point_t const &point) const
	Decomposes a 3D point in two components. More...


Point_t	ProjectionReferencePoint () const
	Returns the reference point used by `PointProjection()`. More...


WireCoordProjection_t	Projection (geo::Point_t const &point) const
	Returns the projection of the specified point on the plane. More...

WireCoordProjection_t	PointProjection (geo::Point_t const &point) const
	Returns the projection of the specified point on the plane. More...


WireCoordProjection_t	Projection (geo::Vector_t const &v) const
	Returns the projection of the specified vector on the plane. More...


Vector_t	ComposeVector (WireDecomposedVector_t const &decomp) const
	Returns the 3D vector from composition of projection and distance. More...


Vector_t	ComposeVector (double distance, WireCoordProjection_t const &proj) const
	Returns the 3D vector from composition of projection and distance. More...


Point_t	ComposePoint (WireDecomposedVector_t const &decomp) const
	Returns the 3D point from composition of projection and distance. More...


Point_t	ComposePoint (double distance, WireCoordProjection_t const &proj) const
	Returns the 3D point from composition of projection and distance. More...

Projection on width/depth plane
These methods deal with projection of points and vectors on the plane, using a geometric reference base which is not dependent on the wire direction. This is more useful when comparing with the TPC or other planes.
WDDecomposedVector_t	DecomposePointWidthDepth (geo::Point_t const &point) const
	Decomposes a 3D point in two components. More...


WidthDepthProjection_t	PointWidthDepthProjection (geo::Point_t const &point) const
	Returns the projection of the specified point on the plane. More...


WidthDepthProjection_t	VectorWidthDepthProjection (geo::Vector_t const &v) const
	Returns the projection of the specified vector on the plane. More...


bool	isProjectionOnPlane (geo::Point_t const &point) const
	Returns if the projection of specified point is within the plane. More...


geo::Point_t	MovePointOverPlane (geo::Point_t const &point) const
	Returns the point, moved so that its projection is over the plane. More...


Point_t	ComposePoint (WDDecomposedVector_t const &decomp) const
	Returns the 3D vector from composition of projection and distance. More...


Point_t	ComposePoint (double distance, WidthDepthProjection_t const &proj) const
	Returns the 3D point from composition of projection and distance. More...

Coordinate transformation
Local points and displacement vectors are described by the types `geo::PlaneGeo::LocalPoint_t` and `geo::PlaneGeo::LocalVector_t`, respectively.
geo::Point_t	toWorldCoords (LocalPoint_t const &local) const
	Transform point from local plane frame to world frame. More...

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

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

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

Setters
void	SetView (geo::View_t view)
	Set the signal view (for TPCGeo). More...

Static Public Member Functions
static std::string	ViewName (geo::View_t view)
	Returns the name of the specified view. More...

static std::string	OrientationName (geo::Orient_t orientation)
	Returns the name of the specified orientation. More...

Static Public Attributes
static constexpr unsigned int	MaxVerbosity = 6
	Maximum value for print verbosity. More...

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

Private Member Functions
void	DetectGeometryDirections ()
	Sets the geometry directions. More...

geo::Vector_t	GetNormalAxis () const
	Returns a direction normal to the plane (pointing is not defined). More...

void	UpdatePlaneNormal (geo::BoxBoundedGeo const &TPCbox)
	Updates the cached normal to plane versor; needs the TPC box coordinates. More...

void	UpdateWidthDepthDir ()
	Updates the cached depth and width direction. More...

void	UpdateIncreasingWireDir ()
	Updates the cached direction to increasing wires. More...

void	UpdateWireDir ()
	Updates the cached direction to wire. More...

void	UpdateOrientation ()
	Updates plane orientation. More...

void	UpdateWirePitch ()
	Updates the stored wire pitch. More...

void	UpdateWirePlaneCenter ()
	Updates the stored wire plane center. More...

void	UpdatePhiZ ()
	Updates the stored $\phi_{z}$ . More...

void	UpdateView ()
	Updates the stored view. More...

void	UpdateWirePitchSlow ()
	Updates the stored wire pitch with a slower, more robust algorithm. More...

void	UpdateDecompWireOrigin ()
	Updates the position of the wire coordinate decomposition. More...

void	UpdateActiveArea ()
	Updates the internally used active area. More...

bool	shouldFlipWire (geo::WireGeo const &wire) const
	Whether the specified wire should have start and end swapped. More...

Private Attributes
LocalTransformation_t	fTrans
	Plane to world transform. More...

TGeoVolume const *	fVolume
	Plane volume description. More...

View_t	fView
	Does this plane measure U, V, or W? More...

Orient_t	fOrientation
	Is the plane vertical or horizontal? More...

WireCollection_t	fWire
	List of wires in this plane. More...

double	fWirePitch
	Pitch of wires in this plane. More...

double	fSinPhiZ
	Sine of $\phi_{z}$ . More...

double	fCosPhiZ
	Cosine of $\phi_{z}$ . More...

geo::Vector_t	fNormal

WireDecomposer_t	fDecompWire

WidthDepthDecomposer_t	fDecompFrame

RectSpecs	fFrameSize

Rect	fActiveArea
	Area covered by wires in frame base. More...

geo::Point_t	fCenter
	Center of the plane, lying on the wire plane. More...

geo::PlaneID	fID
	ID of this plane. More...

Friends
struct	details::ActiveAreaCalculator

Detailed Description

Geometry information for a single wire plane.

The plane is represented in the geometry by a solid which contains wires. Currently, only box solids are well supported. The box which is representation of the plane has some thickness, and it should not be assumed that the wires are in the median section of it, that is, the center of the box may not lie on the plane defined by the wires.

The plane defines two local reference frames. The first, depending on wire directions and therefore called "wire base", is defined by the normal to the plane (pointing toward the center of the TPC), the direction of the wires, and the direction that the wires measure. This is a positive orthogonal base. Note that for this base to be correctly defined, the Geometry service has to provide external information (for example, where the center of the TPC is).

The second, depending only on the shape of the plane and called "frame base", is defined by the normal (the same as for the previous one), and two orthogonal axes, "width" and "depth", aligned with the sides of the plane. If the plane has not the shape of a box, this reference frame is not available. This coordinate system is also positive defined. These components are all measured in centimeters.

Definition at line 78 of file PlaneGeo.h.

Member Typedef Documentation

using geo::PlaneGeo::ElementIteratorBox = WireCollection_t const&

Type returned by IterateElements().

Definition at line 85 of file PlaneGeo.h.

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

Definition at line 82 of file PlaneGeo.h.

using geo::PlaneGeo::ID_t = PlaneID

Definition at line 80 of file PlaneGeo.h.

using geo::PlaneGeo::LocalPoint_t = geo::Point3DBase_t<PlaneGeoCoordinatesTag>

Type of points in the local GDML wire plane frame.

Definition at line 106 of file PlaneGeo.h.

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

private

Definition at line 1318 of file PlaneGeo.h.

using geo::PlaneGeo::LocalVector_t = geo::Vector3DBase_t<PlaneGeoCoordinatesTag>

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

Definition at line 109 of file PlaneGeo.h.

using geo::PlaneGeo::Rect = lar::util::simple_geo::Rectangle<double>

Type for description of rectangles.

Definition at line 157 of file PlaneGeo.h.

using geo::PlaneGeo::WDDecomposedVector_t = WidthDepthDecomposer_t::DecomposedVector_t

Type describing a 3D point or vector decomposed on a plane with plane frame base (width and depth).

Definition at line 152 of file PlaneGeo.h.

using geo::PlaneGeo::WidthDepthDecomposer_t = geo::Decomposer<geo::Vector_t, geo::Point_t, WidthDepthProjection_t>

Type used for plane decompositions on plane frame (width/depth).

Definition at line 148 of file PlaneGeo.h.

using geo::PlaneGeo::WidthDepthDisplacement_t = ROOT::Math::DisplacementVector2D<ROOT::Math::Cartesian2D<double>, WidthDepthReferenceTag>

Type for vector projections in the plane frame base representation.

Definition at line 144 of file PlaneGeo.h.

using geo::PlaneGeo::WidthDepthProjection_t = ROOT::Math::DisplacementVector2D<ROOT::Math::Cartesian2D<double>, WidthDepthReferenceTag>

Type for projections in the plane frame base representation.

Todo:: the following should be a PositionVector2D

Definition at line 140 of file PlaneGeo.h.

using geo::PlaneGeo::WireCollection_t = std::vector<geo::WireGeo>

Definition at line 81 of file PlaneGeo.h.

using geo::PlaneGeo::WireCoordProjection_t = ROOT::Math::DisplacementVector2D<ROOT::Math::Cartesian2D<double>, WireCoordinateReferenceTag>

Type for projections in the wire base representation.

Definition at line 121 of file PlaneGeo.h.

using geo::PlaneGeo::WireDecomposedVector_t = WireDecomposer_t::DecomposedVector_t

Type describing a 3D point or vector decomposed on a plane on wire base.

Definition at line 127 of file PlaneGeo.h.

using geo::PlaneGeo::WireDecomposer_t = geo::Decomposer<geo::Vector_t, geo::Point_t, WireCoordProjection_t>

Type used for plane decompositions on wire base.

Definition at line 124 of file PlaneGeo.h.

Constructor & Destructor Documentation

geo::PlaneGeo::PlaneGeo	(	TGeoNode const &	node,
		geo::TransformationMatrix &&	trans,
		WireCollection_t &&	wires
	)

Construct a representation of a single plane of the detector.

Definition at line 399 of file PlaneGeo.cxx.

References DetectGeometryDirections(), fVolume, and UpdateWirePitchSlow().

     : fTrans(std::move(trans))
     , fVolume(node.GetVolume())
     , fView(geo::kUnknown)
     , fOrientation(geo::kVertical)
     , fWire(std::move(wires))
     , fWirePitch(0.)
     , fSinPhiZ(0.)
     , fCosPhiZ(0.)
     , fDecompWire()
     , fDecompFrame()
     , fCenter()
   {
 
     if (!fVolume) {
       throw cet::exception("PlaneGeo")
         << "Plane geometry node " << node.IsA()->GetName() << "[" << node.GetName() << ", #"
         << node.GetNumber() << "] has no volume!\n";
     }
 
     // view is now set at TPC level with SetView
 
     DetectGeometryDirections();
     UpdateWirePitchSlow();
 
   } // PlaneGeo::PlaneGeo()

Member Function Documentation

Rect const& geo::PlaneGeo::ActiveArea ( ) const

inline

Returns an area covered by the wires in the plane.

The returned value is conceptually akin of a projection of Coverage() volume. Yet, the precise definition of the area is not specified, therefore this area should not be uses for physics.

The current implementation is documented in details::ActiveAreaCalculator.

Definition at line 685 of file PlaneGeo.h.

References art::detail::indent().

685 { return fActiveArea; }

geo::PlaneGeo::fActiveArea

Rect fActiveArea

Area covered by wires in frame base.

Definition: PlaneGeo.h:1350

geo::BoxBoundedGeo geo::PlaneGeo::BoundingBox ( ) const

Returns the world coordinates of the box containing the plane.

See also: GetBoxCenter()

Definition at line 430 of file PlaneGeo.cxx.

References geo::BoxBoundedGeo::ExtendToInclude(), fVolume, geo::BoxBoundedGeo::SetBoundaries(), and toWorldCoords().

   {
 
     //
     // The algorithm is not very refined...
     //
 
     TGeoBBox const* pShape = dynamic_cast<TGeoBBox const*>(fVolume->GetShape());
     if (!pShape) {
       throw cet::exception("PlaneGeo")
         << "BoundingBox(): volume " << fVolume->IsA()->GetName() << " is not a TGeoBBox!";
     }
 
     geo::BoxBoundedGeo box;
     unsigned int points = 0;
     for (double dx : {-(pShape->GetDX()), +(pShape->GetDX())}) {
       for (double dy : {-(pShape->GetDY()), +(pShape->GetDY())}) {
         for (double dz : {-(pShape->GetDZ()), +(pShape->GetDZ())}) {
 
           auto const p = toWorldCoords(LocalPoint_t{dx, dy, dz});
 
           if (points++ == 0)
             box.SetBoundaries(p, p);
           else
             box.ExtendToInclude(p);
 
         } // for z
       }   // for y
     }     // for x
     return box;
 
   } // PlaneGeo::BoundingBox()

geo::WireID geo::PlaneGeo::ClosestWireID ( geo::WireID::WireID_t wireNo ) const

inline

Returns the closest valid wire ID to the specified wire.

Parameters

wireNo number of the wire on this plane

Returns: complete wire ID of the closest wire on this plane

If the wire number described a wire present on this plane, its complete wire ID is returned, valid. Otherwise, a valid wire ID is returned which points to the existing wire closest to the specified wire number: the first wire if the wire number is negative, or the last wire if the wire number is larger than the actual wires.

Note that the argument geo::WireID::WireID_t type is an integral type, and if a floating point value is specified for it, it's subject to truncation.

Definition at line 1365 of file PlaneGeo.h.

Referenced by NearestWire().

 {
   return {ID(), std::min(wireNo, Nwires())};
 }

geo::WireID geo::PlaneGeo::ClosestWireID ( geo::WireID const & wireid ) const

inline

Returns the closest valid wire ID to the specified wire.

Parameters

wireid the wire ID (must be on this plane)

Returns: complete wire ID of the closest wire, invalid if not this plane

See also: ClosestWireID(geo::WireID::WireID_t)

If wireid is not on this plane, it is returned but marked as invalid. Otherwise, the returned ID is the same as in ClosestWireID(geo::WireID::WireID_t).

Definition at line 1370 of file PlaneGeo.h.

References geo::PlaneID::asPlaneID(), geo::CryostatID::markInvalid(), and geo::WireID::Wire.

 {
   if (wireid.asPlaneID() != ID()) {
     geo::WireID invalid{wireid};
     invalid.markInvalid();
     return invalid;
   }
   return ClosestWireID(wireid.Wire);
 } // geo::PlaneGeo::ClosestWireID()

Point_t geo::PlaneGeo::ComposePoint ( WireDecomposedVector_t const & decomp ) const

inline

Returns the 3D point from composition of projection and distance.

Parameters

decomp decomposed point

Returns: the 3D point from composition of projection and distance

See also: DecomposePoint(), ComposePoint(double, WireCoordProjection_t const&)

See ComposePoint(double, WireCoordProjection_t const&) for details.

Definition at line 924 of file PlaneGeo.h.

Referenced by geo::TPCGeo::ComposePoint(), and larg4::LArVoxelReadout::RecoverOffPlaneDeposit().

     {
       return fDecompWire.ComposePoint(decomp);
     }

Point_t geo::PlaneGeo::ComposePoint	(	double	distance,
		WireCoordProjection_t const &	proj
	)		const

inline

Returns the 3D point from composition of projection and distance.

Parameters

distance	distance of the target point from the wire plane
proj	projection of the target point on the wire plane

Returns: the 3D point from composition of projection and distance

See also: DecomposePoint()

The returned point is the reference point of the frame system (that is, the plane center), translated by two 3D vectors:

a vector parallel to the plane normal, with norm the input distance
a vector lying on the plane, whose projection via PointProjection() gives the input projection

The choice of the projection reference point embodies the same convention used in PointProjection() and DecomposePoint(). In fact, the strict definition of the result of this method is a 3D point whose decomposition on the plane frame base matches the method arguments.

Definition at line 950 of file PlaneGeo.h.

     {
       return fDecompWire.ComposePoint(distance, proj);
     }

Point_t geo::PlaneGeo::ComposePoint ( WDDecomposedVector_t const & decomp ) const

inline

Returns the 3D vector from composition of projection and distance.

Parameters

decomp decomposed point

Returns: the 3D vector from composition of projection and distance

See also: DecomposePointWidthDepth(), ComposePointWidthDepth(double, DecomposedVector_t::Projection_t const&)

See ComposePointWidthDepth(double, DecomposedVector_t::Projection_t const&) for details.

Definition at line 1182 of file PlaneGeo.h.

     {
       return fDecompFrame.ComposePoint(decomp);
     }

Point_t geo::PlaneGeo::ComposePoint	(	double	distance,
		WidthDepthProjection_t const &	proj
	)		const

inline

Returns the 3D point from composition of projection and distance.

Parameters

distance	distance of the target point from the wire plane
proj	projection of the target point on the wire plane

Returns: the 3D vector from composition of projection and distance

See also: DecomposePointWidthDepth()

The returned vector is the sum of two 3D vectors:

a vector parallel to the plane normal, with norm the input distance
a vector lying on the plane, whose projection via PointWidthDepthProjection() gives the input projection

Given the arbitrary definition of the projection reference, it is assumed that the same convention is used as in PointWidthDepthProjection() and DecomposePointWidthDepth().

Definition at line 1207 of file PlaneGeo.h.

     {
       return fDecompFrame.ComposePoint(distance, proj);
     }

Vector_t geo::PlaneGeo::ComposeVector ( WireDecomposedVector_t const & decomp ) const

inline

Returns the 3D vector from composition of projection and distance.

Parameters

decomp decomposed vector

Returns: the 3D vector from composition of projection and distance

See also: DecomposePoint(), ComposeVector(double, WireCoordProjection_t const&), ComposePoint(WireDecomposedVector_t const&)

See ComposeVector(double, WireCoordProjection_t const&) for details.

Definition at line 890 of file PlaneGeo.h.

     {
       return fDecompWire.ComposeVector(decomp);
     } //@}

Vector_t geo::PlaneGeo::ComposeVector	(	double	distance,
		WireCoordProjection_t const &	proj
	)		const

inline

Returns the 3D vector from composition of projection and distance.

Parameters

distance	component of target vector orthogonal to the wire plane
proj	projection of the target vector on the wire plane

Returns: the 3D vector from composition of projection and distance

See also: DecomposePoint()

The returned vector is the sum of two 3D vectors:

a vector parallel to the plane normal, with norm the input distance
a vector lying on the plane, whose projection via VectorProjection() gives the input projection

Definition at line 909 of file PlaneGeo.h.

     {
       return fDecompWire.ComposeVector(distance, proj);
     }

double geo::PlaneGeo::CosPhiZ ( ) const

inline

Cosine of PhiZ()

Definition at line 181 of file PlaneGeo.h.

181 { return fCosPhiZ; }

geo::PlaneGeo::fCosPhiZ

double fCosPhiZ

Cosine of .

Definition: PlaneGeo.h:1337

WireDecomposedVector_t geo::PlaneGeo::DecomposePoint ( geo::Point_t const & point ) const

inline

Decomposes a 3D point in two components.

Parameters

point the point to be decomposed

Returns: the two components of point, on the plane and orthogonal to it

The point is decomposed in:

a component orthogonal to the plane, expressed as a signed real number
a component lying on the plane, expressed as a 2D vector

The distance is obtained as by DistanceFromPlane(). The projection on the plane is obtained following the same convention as PointProjection().

Definition at line 817 of file PlaneGeo.h.

     {
       return fDecompWire.DecomposePoint(point);
     }

WDDecomposedVector_t geo::PlaneGeo::DecomposePointWidthDepth ( geo::Point_t const & point ) const

inline

Decomposes a 3D point in two components.

Parameters

point the point to be decomposed

Returns: the two components of point, on the plane and orthogonal to it

The point is decomposed in:

a component orthogonal to the plane, expressed as a signed real number
a component lying on the plane, expressed as a 2D vector

The distance is obtained as by DistanceFromPlane(). The projection on the plane is obtained following the same convention as PointWidthDepthProjection().

Definition at line 982 of file PlaneGeo.h.

Referenced by geo::TPCGeo::DecomposePoint().

     {
       return fDecompFrame.DecomposePoint(point);
     }

PlaneGeo::WidthDepthProjection_t geo::PlaneGeo::DeltaFromActivePlane	(	WidthDepthProjection_t const &	proj,
		double	wMargin,
		double	dMargin
	)		const

Returns a projection vector that, added to the argument, gives a projection inside (or at the border of) the active area of plane.

Parameters

proj	starting projection
wMargin	the point is brought this amount inside the active area
dMargin	the point is brought this amount inside the active area

Returns: a projection displacement

See also: DeltaFromPlane()

The "active" area of the plane is the rectangular area which includes all the wires. The area is obtained as the smallest rectangle including the projection of both ends of all wires in the plane, less half a pitch. This defines a "fiducial" area away from the borders of the plane. The projection is in the frame reference (PointWidthDepthProjection()). The area is reduced on each side by the specified margins. If for example wMargin is 1.0, the active area lower border on the width direction will be increased by 1 cm, and the upper border will be decreased by 1 cm effectively making the active area 2 cm narrowed on the width direction. The same independently applies to the depth direction with dMargin. The main purpose of the margins is to accommodate for rounding errors. A version of this method with default margins of 0 is also available.

If the projection is already on the active area of the plane, the returned displacement is null. Otherwise, the displacement, added to proj, will bring it on the active plane area (in fact, on its border).

Definition at line 515 of file PlaneGeo.cxx.

References lar::util::simple_geo::Range< Data >::delta(), lar::util::simple_geo::Rectangle< Data >::depth, fActiveArea, and lar::util::simple_geo::Rectangle< Data >::width.

Referenced by larg4::LArVoxelReadout::RecoverOffPlaneDeposit().

   {
 
     return {fActiveArea.width.delta(proj.X(), wMargin), fActiveArea.depth.delta(proj.Y(), dMargin)};
 
   } // PlaneGeo::DeltaFromActivePlane()

WidthDepthProjection_t geo::PlaneGeo::DeltaFromActivePlane	(	WidthDepthProjection_t const &	proj,
		double	margin = `0.0`
	)		const

inline

Returns a projection vector that, added to the argument, gives a projection inside (or at the border of) the active area of plane.

Parameters

proj	starting projection
margin	the point is brought this amount inside the active area _(default: 0)_

Returns: a projection displacement

See also: DeltaFromActivePlane(WidthDepthProjection_t const&, double, double)

This is the implementation with default values for margins of DeltaFromActivePlane(). The depth and width margins are the same, and 0 by default.

Definition at line 1131 of file PlaneGeo.h.

     {
       return DeltaFromActivePlane(proj, margin, margin);
     }

PlaneGeo::WidthDepthProjection_t geo::PlaneGeo::DeltaFromPlane	(	WidthDepthProjection_t const &	proj,
		double	wMargin,
		double	dMargin
	)		const

Returns a projection vector that, added to the argument, gives a projection inside (or at the border of) the plane.

Parameters

proj	starting projection
wMargin	the point is brought this amount inside the target area
dMargin	the point is brought this amount inside the target area

Returns: a projection displacement

See also: DeltaFromActivePlane()

The returned projection vector is guaranteed, when added to proj, to yield a projection on or within the border of the plane (the "target area"), as defined by the GDML geometry.

The target plane area is reduced on each side by the specified margins. If for example wMargin is 1.0, the area lower border on the width direction will be increased by 1 cm, and the upper border will be decreased by 1 cm effectively making the area 2 cm narrowed on the width direction. The same independently applies to the depth direction with dMargin. The main purpose of the margins is to accommodate for rounding errors. A version of this method with default margins of 0 is also available.

If the projection is already on the target area, the returned displacement is null.

Definition at line 504 of file PlaneGeo.cxx.

References fFrameSize, geo::PlaneGeo::RectSpecs::HalfDepth(), and geo::PlaneGeo::RectSpecs::HalfWidth().

Referenced by isProjectionOnPlane(), MovePointOverPlane(), and MoveProjectionToPlane().

   {
 
     return {symmetricCapDelta(proj.X(), fFrameSize.HalfWidth() - wMargin),
             symmetricCapDelta(proj.Y(), fFrameSize.HalfDepth() - dMargin)};
 
   } // PlaneGeo::DeltaFromPlane()

WidthDepthProjection_t geo::PlaneGeo::DeltaFromPlane	(	WidthDepthProjection_t const &	proj,
		double	margin = `0.0`
	)		const

inline

Returns a projection vector that, added to the argument, gives a projection inside (or at the border of) the area of plane.

Parameters

proj	starting projection
margin	the point is brought this amount inside the plane area _(default: 0)_

Returns: a projection displacement

See also: DeltaFromPlane(WidthDepthProjection_t const&, double, double)

This is the implementation with default values for margins of DeltaFromPlane(). The depth and width margins are the same, and 0 by default.

Definition at line 1081 of file PlaneGeo.h.

     {
       return DeltaFromPlane(proj, margin, margin);
     }

double geo::PlaneGeo::Depth ( ) const

inline

Return the depth of the plane.

See also: Width(), WidthDir(), DepthDir()

The precise definition is arbitrary (see DepthDir()).

Definition at line 229 of file PlaneGeo.h.

229 { return fFrameSize.Depth(); }

geo::PlaneGeo::RectSpecs::Depth

double Depth() const

Definition: PlaneGeo.h:1327

geo::PlaneGeo::fFrameSize

RectSpecs fFrameSize

Definition: PlaneGeo.h:1348

Vector_t const& geo::PlaneGeo::DepthDir ( ) const

inline

Return the direction of plane depth.

The precise definition of the sides is arbitrary, but they are defined to lie on the wire plane and so that WidthDir(), DepthDir() and GetNormalDirection() make a orthonormal base. That base (width, depth, normal) is guaranteed to be positive defined.

Definition at line 212 of file PlaneGeo.h.

Referenced by MovePointOverPlane(), geo::TPCGeo::RefDepthDir(), and UpdateWidthDepthDir().

212 { return fDecompFrame.SecondaryDir(); }

geo::PlaneGeo::fDecompFrame

WidthDepthDecomposer_t fDecompFrame

Definition: PlaneGeo.h:1347

geo::Decomposer::SecondaryDir

Vector_t const & SecondaryDir() const

Returns the plane secondary axis direction.

Definition: Decomposer.h:458

void geo::PlaneGeo::DetectGeometryDirections ( )

private

Sets the geometry directions.

Definition at line 707 of file PlaneGeo.cxx.

References util::abs(), e, fDecompFrame, fFrameSize, fVolume, geo::PlaneGeo::RectSpecs::halfDepth, geo::PlaneGeo::RectSpecs::halfWidth, geo::origin(), geo::vect::rounded01(), geo::Decomposer< Vector, Point, ProjVector >::SetMainDir(), geo::Decomposer< Vector, Point, ProjVector >::SetOrigin(), geo::Decomposer< Vector, Point, ProjVector >::SetSecondaryDir(), toWorldCoords(), and Z.

Referenced by PlaneGeo().

   {
 
     //
     // We need to identify which are the "long" directions of the plane.
     // We assume it is a box, and the shortest side is excluded.
     // The first direction ("width") is given by preference to z.
     // If z is the direction of the normal to the plane... oh well.
     // Let's say privilege to the one which comes from local z, then y.
     // That means: undefined.
     //
     // Requirements:
     //  - ROOT geometry information (shapes and transformations)
     //  - the shape must be a box (an error is PRINTED if not)
     //  - center of the wire plane (not just the center of the plane box)
     //
 
     //
     // how do they look like in the world?
     //
     TGeoBBox const* pShape = dynamic_cast<TGeoBBox const*>(fVolume->GetShape());
     if (!pShape) {
       mf::LogError("BoxInfo") << "Volume " << fVolume->IsA()->GetName()
                               << " is not a TGeoBBox! Dimensions won't be available.";
       // set it invalid
       fDecompFrame.SetOrigin(geo::origin());
       fDecompFrame.SetMainDir({0., 0., 0.});
       fDecompFrame.SetSecondaryDir({0., 0., 0.});
       fFrameSize = {0.0, 0.0};
       return;
     }
 
     std::array<geo::Vector_t, 3U> sides;
     size_t iSmallest = 3;
     {
       size_t iSide = 0;
 
       sides[iSide] = toWorldCoords(LocalVector_t{pShape->GetDX(), 0.0, 0.0});
       iSmallest = iSide;
       ++iSide;
 
       sides[iSide] = toWorldCoords(LocalVector_t{0.0, pShape->GetDY(), 0.0});
       if (sides[iSide].Mag2() < sides[iSmallest].Mag2()) iSmallest = iSide;
       ++iSide;
 
       sides[iSide] = toWorldCoords(LocalVector_t{0.0, 0.0, pShape->GetDZ()});
       if (sides[iSide].Mag2() < sides[iSmallest].Mag2()) iSmallest = iSide;
       ++iSide;
     }
 
     //
     // which are the largest ones?
     //
     size_t kept[2];
     {
       size_t iKept = 0;
       for (size_t i = 0; i < 3; ++i)
         if (i != iSmallest) kept[iKept++] = i;
     }
 
     //
     // which is which?
     //
     // Pick width as the most z-like.
     //
     size_t const iiWidth =
       std::abs(sides[kept[0]].Unit().Z()) > std::abs(sides[kept[1]].Unit().Z()) ? 0 : 1;
     size_t const iWidth = kept[iiWidth];
     size_t const iDepth = kept[1 - iiWidth]; // the other
 
     fDecompFrame.SetMainDir(geo::vect::rounded01(sides[iWidth].Unit(), 1e-4));
     fDecompFrame.SetSecondaryDir(geo::vect::rounded01(sides[iDepth].Unit(), 1e-4));
     fFrameSize.halfWidth = sides[iWidth].R();
     fFrameSize.halfDepth = sides[iDepth].R();
 
   } // PlaneGeo::DetectGeometryDirections()

double geo::PlaneGeo::DistanceFromPlane ( geo::Point_t const & point ) const

inline

Returns the distance of the specified point from the wire plane.

Parameters

point a point in world coordinates [cm]

Returns: the signed distance from the wire plane

The distance is defined positive if the point lies in the side the normal vector (GetNormalDirection()) points to.

The distance is defined from the geometric plane where the wires lie, and it may not match the distance from the center of the geometry box representing the plane. It should always match the drift distance from this wire plane, and the result of DriftPoint(point, DistanceFromPlane(point)) will bring the point to the plane.

Definition at line 558 of file PlaneGeo.h.

Referenced by geo::TPCGeo::ComputeDriftDistance(), geo::TPCGeo::DistanceFromReferencePlane(), larg4::LArVoxelReadout::RecoverOffPlaneDeposit(), and UpdateWirePlaneCenter().

     {
       return fDecompWire.PointNormalComponent(point);
     }

void geo::PlaneGeo::DriftPoint	(	geo::Point_t &	position,
		double	distance
	)		const

inline

Shifts the position of an electron drifted by a distance.

Parameters

position	_(modified)_ the position of the electron
distance	drift distance to shift the electron by [cm]

This is a pure geometry computation: the position is shifted by the drift distance in the direction opposite to the normal to the plane (as returned by GetNormalDirection()), no matter where the position is relative to the plane. The wording about "electron position" is just meant to remind that the drift shift is taken with opposite sign: since the point is assumed to be an electron, a positive drift normally moves its position toward the wire plane.

Definition at line 579 of file PlaneGeo.h.

Referenced by geo::TPCGeo::DriftPoint(), and UpdateWirePlaneCenter().

     {
       position -= distance * GetNormalDirection();
     }

void geo::PlaneGeo::DriftPoint ( geo::Point_t & position ) const

inline

Shifts the position along drift direction to fall on the plane.

Parameters

position _(modified)_ the position to be shifted

This is a pure geometry computation: the position is shifted by the drift distance in the direction opposite to the normal to the plane (as returned by GetNormalDirection()), no matter where the position is relative to the plane.

Definition at line 595 of file PlaneGeo.h.

References dir.

     {
       DriftPoint(position, DistanceFromPlane(position));
     }

const WireGeo& geo::PlaneGeo::FirstWire ( ) const

inline

Return the first wire in the plane.

Definition at line 312 of file PlaneGeo.h.

Referenced by geo::details::ActiveAreaCalculator::initializeWireEnds(), ThetaZ(), UpdateDecompWireOrigin(), and UpdateWireDir().

312 { return Wire(0); }

geo::PlaneGeo::Wire

WireGeo const & Wire(unsigned int iwire) const

Definition: PlaneGeo.cxx:465

Point_t geo::PlaneGeo::GetBoxCenter ( ) const

inline

Returns the centre of the box representing the plane.

Returns: the centre of the box, in world coordinates [cm]

See also: GetCenter()

This is the centre of the box representing the plane in the geometry description, in world coordinates. This is rarely of any use, as most of the times GetCenter() delivers the proper information, e.g. for simulation and reconstruction.

Definition at line 449 of file PlaneGeo.h.

Referenced by hit::GausHitFinderAna::analyze(), geo::TPCGeo::DetectDriftDirection(), evd::TWQMultiTPCProjectionView::FindLineLength(), evd::TWQProjectionView::FindLineLength(), cluster::ClusterCheater::produce(), geo::TPCGeo::ResetDriftDirection(), UpdatePlaneNormal(), and UpdateWirePlaneCenter().

449 { return toWorldCoords(LocalPoint_t{0.0, 0.0, 0.0}); }

geo::PlaneGeo::toWorldCoords

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

Transform point from local plane frame to world frame.

Definition: PlaneGeo.h:1225

geo::PlaneGeo::LocalPoint_t

geo::Point3DBase_t< PlaneGeoCoordinatesTag > LocalPoint_t

Type of points in the local GDML wire plane frame.

Definition: PlaneGeo.h:106

Point_t const& geo::PlaneGeo::GetCenter ( ) const

inline

Returns the centre of the wire plane in world coordinates [cm].

See also: GetBoxCenter()

The center of the plane is defined so that it has width and depth coordinates in the middle of the plane box (that is, the geometrical representation of the plane in the geometry description), and the other coordinate set at drift distance 0.

Note that this does not necessarily match the center of the box, if the geometry does not place the wires, which define the drift distance, in the plane in the middle of the box.

Definition at line 435 of file PlaneGeo.h.

Referenced by geo::DriftPartitions::computeCoverage(), detinfo::DetectorPropertiesStandard::DataFor(), larg4::LArVoxelReadout::DriftIonizationElectrons(), pma::PMAlgStitching::GetTPCXOffsets(), detsim::DriftElectronstoPlane::produce(), detsim::SimDriftElectrons::produce(), geo::TPCGeo::ProjectionReferencePoint(), phot::SemiAnalyticalModel::SemiAnalyticalModel(), DUNE::NeutrinoTrackingEff::truthLength(), and UpdateDecompWireOrigin().

435 { return fCenter; }

geo::PlaneGeo::fCenter

geo::Point_t fCenter

Center of the plane, lying on the wire plane.

Definition: PlaneGeo.h:1352

WireGeo const& geo::PlaneGeo::GetElement ( WireID const & wireid ) const

inline

Returns the wire in wireid from this plane.

Parameters

wireid full wire ID

Returns: a constant reference to the wire in wireid

Exceptions

cet::exception (category "WireOutOfRange") if no such wire

The cryostat, TPC and plane numbers in wireid are ignored, as it is ignored whether wireid is invalid.

Definition at line 285 of file PlaneGeo.h.

285 { return Wire(wireid); }

geo::PlaneGeo::Wire

WireGeo const & Wire(unsigned int iwire) const

Definition: PlaneGeo.cxx:465

geo::WirePtr geo::PlaneGeo::GetElementPtr ( WireID const & wireid ) const

inline

Returns the wire in wireid from this plane.

Parameters

wireid full wire ID

Returns: a constant pointer to the wire, or nullptr if it does not exist

The cryostat, TPC and plane numbers in wireid are ignored, as it is ignored whether wireid is invalid.

Definition at line 308 of file PlaneGeo.h.

308 { return WirePtr(wireid); }

geo::PlaneGeo::WirePtr

geo::WirePtr WirePtr(unsigned int iwire) const

Returns the wire number iwire from this plane.

Definition: PlaneGeo.h:293

Vector_t const& geo::PlaneGeo::GetIncreasingWireDirection ( ) const

inline

Returns the direction of increasing wires.

Returns: a TVector3 versor with the direction of increasing wires

The versor is orthogonal to the wires (assumed parallel), lies on the plane and its direction goes toward increasing wire IDs.

Definition at line 418 of file PlaneGeo.h.

Referenced by geo::details::ActiveAreaCalculator::adjustCorners(), ShowerRecoTools::ShowerTrajPointdEdx::CalculateElement(), shower::LArPandoraShowerAlg::OrderShowerHits(), shouldFlipWire(), UpdatePhiZ(), and WireIDincreasesWithZ().

418 { return fDecompWire.SecondaryDir(); }

geo::Decomposer::SecondaryDir

Vector_t const & SecondaryDir() const

Returns the plane secondary axis direction.

Definition: Decomposer.h:458

geo::PlaneGeo::fDecompWire

WireDecomposer_t fDecompWire

Definition: PlaneGeo.h:1343

geo::Vector_t geo::PlaneGeo::GetNormalAxis ( ) const

private

Returns a direction normal to the plane (pointing is not defined).

Definition at line 785 of file PlaneGeo.cxx.

References geo::WireGeo::Direction(), e, geo::WireGeo::GetCenter(), Nwires(), geo::vect::rounded01(), and Wire().

Referenced by UpdatePlaneNormal().

   {
     const unsigned int NWires = Nwires();
     if (NWires < 2) return {}; // why are we even here?
 
     // 1) get the direction of the middle wire
     auto const WireDir = Wire(NWires / 2).Direction();
 
     // 2) get the direction between the middle wire and the next one
     auto const ToNextWire = Wire(NWires / 2 + 1).GetCenter() - Wire(NWires / 2).GetCenter();
 
     // 3) get the direction perpendicular to the plane
     // 4) round it
     // 5) return its norm
     return geo::vect::rounded01(WireDir.Cross(ToNextWire).Unit(), 1e-4);
 
   } // PlaneGeo::GetNormalAxis()

Vector_t const& geo::PlaneGeo::GetNormalDirection ( ) const

inline

Returns the direction normal to the plane.

Returns: a TVector3 versor with a direction normal to the plane

The versor is orthogonal to the plane. The direction is defined so that the semi-space pointed to contains the TPC center.

Note: Each decomposition base (wire-based and frame-based) has its own normal, defined solely from its two decomposition plane axes. The wire-based frame is nevertheless required to have a normal matching this one, while the frame-based normal might happen to be in the opposite direction depending on the original geometry description.

Definition at line 407 of file PlaneGeo.h.

Referenced by shouldFlipWire(), UpdateIncreasingWireDir(), UpdateOrientation(), UpdateView(), UpdateWidthDepthDir(), and UpdateWireDir().

407 { return fNormal; }

geo::PlaneGeo::fNormal

geo::Vector_t fNormal

Definition: PlaneGeo.h:1339

Vector_t const& geo::PlaneGeo::GetWireDirection ( ) const

inline

Returns the direction of the wires.

Returns: a unit vector following the direction of the wires

All wires in the plane are assumed parallel.

Definition at line 459 of file PlaneGeo.h.

Referenced by lar::util::TrackPitchInView(), and UpdateView().

459 { return fDecompWire.MainDir(); }

geo::Decomposer::MainDir

Vector_t const & MainDir() const

Returns the plane main axis direction.

Definition: Decomposer.h:455

geo::PlaneGeo::fDecompWire

WireDecomposer_t fDecompWire

Definition: PlaneGeo.h:1343

bool geo::PlaneGeo::HasElement ( unsigned int iwire ) const

inline

Returns whether a wire with index iwire is present in this plane.

Parameters

iwire index of wire in this plane

Returns: whether the wire with index iwire is present in this plane

Definition at line 253 of file PlaneGeo.h.

253 { return HasWire(iwire); }

geo::PlaneGeo::HasWire

bool HasWire(unsigned int iwire) const

Returns whether a wire with index iwire is present in this plane.

Definition: PlaneGeo.h:252

bool geo::PlaneGeo::HasElement ( geo::WireID const & wireid ) const

inline

Returns whether the wire in wireid is present in this plane.

Parameters

wireid full wire ID

Returns: whether the wire in wireid is present in this plane

The cryostat, TPC and plane numbers in wireid are ignored, as it is ignored whether wireid is invalid.

Definition at line 266 of file PlaneGeo.h.

266 { return HasWire(wireid); }

geo::PlaneGeo::HasWire

bool HasWire(unsigned int iwire) const

Returns whether a wire with index iwire is present in this plane.

Definition: PlaneGeo.h:252

bool geo::PlaneGeo::HasWire ( unsigned int iwire ) const

inline

Returns whether a wire with index iwire is present in this plane.

Parameters

iwire index of wire in this plane

Returns: whether the wire with index iwire is present in this plane

Definition at line 252 of file PlaneGeo.h.

Referenced by geo::GeometryCore::HasWire().

252 { return iwire < Nwires(); }

geo::PlaneGeo::Nwires

unsigned int Nwires() const

Number of wires in this plane.

Definition: PlaneGeo.h:242

bool geo::PlaneGeo::HasWire ( geo::WireID const & wireid ) const

inline

Returns whether the wire in wireid is present in this plane.

Parameters

wireid full wire ID

Returns: whether the wire in wireid is present in this plane

The cryostat, TPC and plane numbers in wireid are ignored, as it is ignored whether wireid is invalid.

Definition at line 265 of file PlaneGeo.h.

References HasWire(), and geo::WireID::Wire.

Referenced by HasWire().

265 { return HasWire(wireid.Wire); }

geo::PlaneGeo::HasWire

bool HasWire(unsigned int iwire) const

Returns whether a wire with index iwire is present in this plane.

Definition: PlaneGeo.h:252

geo::PlaneID const& geo::PlaneGeo::ID ( ) const

inline

Returns the identifier of this plane.

Definition at line 184 of file PlaneGeo.h.

Referenced by larg4::LArVoxelReadout::DriftIonizationElectrons(), NearestWire(), NearestWireID(), geo::GeometryCore::Print(), geo::TPCGeo::ReferencePlaneID(), and lar::util::TrackPitchInView().

184 { return fID; }

geo::PlaneGeo::fID

geo::PlaneID fID

ID of this plane.

Definition: PlaneGeo.h:1354

double geo::PlaneGeo::InterWireDistance ( geo::Vector_t const & dir ) const

Returns the distance between wires along the specified direction.

Parameters

dir	the direction (3D)

Returns: the distance between wires along that direction [cm]

The direction is specified as a 3D vector in the world coordinate frame. The modulus of the vector is ignored but expected to be non null.

The returned distance is the space that would be covered starting from a wire toward the dir direction and stopping when the projection on the wire plane reaches another wire. This distance is returned in centimeters, always positive and not smaller than the wire pitch.

Note: If the direction is too close to the wire direction, the result will be numerically unstable and might be infinite (test with std::isinf(), std::isfinite() or std::isnormal()). It is recommended that the caller take special actions when the result is too large.

Definition at line 634 of file PlaneGeo.cxx.

References util::abs(), e, fDecompWire, fWirePitch, r, and geo::Decomposer< Vector, Point, ProjVector >::VectorSecondaryComponent().

   {
     // the secondary component of the wire decomposition basis is wire coord.
     double const r = dir.R();
     assert(r >= 1.e-6);
 
     double const absWireCoordProj = std::abs(fDecompWire.VectorSecondaryComponent(dir));
     return r / absWireCoordProj * fWirePitch;
 
   } // PlaneGeo::InterWireDistance()

double geo::PlaneGeo::InterWireProjectedDistance ( WireCoordProjection_t const & projDir ) const

Returns the distance between wires along the specified direction.

Parameters

projDir the direction, projected on the plane (2D)

Returns: the distance between wires along that direction [cm]

The direction is specified as a geo::PlaneGeo::WireCoordProjection_t vector, defined as in geo::PlaneGeo::Projection(). The modulus of the projection is ignored but expected to be non null.

The returned distance is the space that would be covered starting from a wire toward the projDir direction and stopping at the first wire met. This distance is returned in centimeters, always positive and not smaller than the wire pitch.

Note: If the direction is too close to the wire direction, the result will be numerically unstable and might be infinite (test with std::isinf(), std::isfinite() or std::isnormal()). It is recommended that the caller take special actions when the result is too large.

Definition at line 627 of file PlaneGeo.cxx.

References e, and fWirePitch.

Referenced by lar::util::TrackPitchInView().

   {
     assert(lar::util::Vector2DComparison{1e-6}.nonZero(projDir));
     return std::sqrt(cet::square(projDir.X() / projDir.Y()) + 1.0) * fWirePitch;
   } // PlaneGeo::InterWireProjectedDistance()

double geo::PlaneGeo::InterWireProjectedDistance ( Vector_t const & dir ) const

inline

Returns the distance between wires along the specified direction.

Parameters

dir	the direction in detector space (3D)

Returns: the distance between wires along that direction [cm]

See also: InterWireProjectedDistance(geo::PlaneGeo::WireCoordProjection_t const&) const

The direction is specified as a 3D vector. Its modulus is ignored but expected to be non null.

The returned distance is the space that would be covered starting from a wire toward the direction projection of dir on the wire plane, and stopping at the first wire met. This distance is returned in centimeters and always positive.

Note: This is not a 3D distance (for example, it's not useful to compute of a track to get its ionization energy ), but it is the distance projected on the wire plane.

Definition at line 668 of file PlaneGeo.h.

     {
       return InterWireProjectedDistance(Projection(dir));
     }

bool geo::PlaneGeo::isProjectionOnPlane ( geo::Point_t const & point ) const

Returns if the projection of specified point is within the plane.

Parameters

point world coordinate of the point to test [cm]

Returns: whether the projection of specified point is within the plane

See also: PointWidthDepthProjection(), Width(), Height()

The method extracts the projection of the specified point on the plane, as in PointWidthDepthProjection(), and then verifies that the projection falls within the wire plane area, as defined by the dimensions from the geometry description.

Definition at line 526 of file PlaneGeo.cxx.

References DeltaFromPlane(), and PointWidthDepthProjection().

   {
 
     auto const deltaProj = DeltaFromPlane(PointWidthDepthProjection(point));
 
     return (deltaProj.X() == 0.) && (deltaProj.Y() == 0.);
 
   } // PlaneGeo::isProjectionOnPlane()

ElementIteratorBox geo::PlaneGeo::IterateElements ( ) const

inline

Allows range-for iteration on all wires in this plane.

Returns: an object suitable for range-for iteration on all wires

This example uses geometry to iterate on all planes in an outer loop, and then iterates on all wires in the plane in the inner loop:

auto geom = lar::providerFrom<geo::Geometry>();
for (geo::PlaneGeo const& plane: geom->IteratePlanes()) {
  // collect plane information
  for (geo::WireGeo const& wire: plane.IterateWires()) {
    // do something with each single wire
  }
} // for planes

(note that all data types here can be replaced with auto). The resulting sequence exposes the wires within the plane in their ID order, from plane 0 to Nplanes() - 1.

Since the wire ID is not contained in geo::WireGeo, further steps are needed to obtain it if needed. For example:

auto geom = lar::providerFrom<geo::Geometry>();
for (geo::PlaneGeo const& plane: geom->IteratePlanes()) {
  // collect plane information
  geo::PlaneID const planeid { plane.ID() };
  for (auto&& iWire, wire: util::enumerate(plane.IterateWires())) {
    geo::WireID const wireid (planeID, iWire);
    // do something with each single wire and ID
  }
} // for planes

Definition at line 368 of file PlaneGeo.h.

368 { return fWire; }

geo::PlaneGeo::fWire

WireCollection_t fWire

List of wires in this plane.

Definition: PlaneGeo.h:1334

ElementIteratorBox geo::PlaneGeo::IterateWires ( ) const

inline

Allows range-for iteration on all wires in this plane.

Returns: an object suitable for range-for iteration on all wires

This example uses geometry to iterate on all planes in an outer loop, and then iterates on all wires in the plane in the inner loop:

auto geom = lar::providerFrom<geo::Geometry>();
for (geo::PlaneGeo const& plane: geom->IteratePlanes()) {
  // collect plane information
  for (geo::WireGeo const& wire: plane.IterateWires()) {
    // do something with each single wire
  }
} // for planes

(note that all data types here can be replaced with auto). The resulting sequence exposes the wires within the plane in their ID order, from plane 0 to Nplanes() - 1.

Since the wire ID is not contained in geo::WireGeo, further steps are needed to obtain it if needed. For example:

auto geom = lar::providerFrom<geo::Geometry>();
for (geo::PlaneGeo const& plane: geom->IteratePlanes()) {
  // collect plane information
  geo::PlaneID const planeid { plane.ID() };
  for (auto&& iWire, wire: util::enumerate(plane.IterateWires())) {
    geo::WireID const wireid (planeID, iWire);
    // do something with each single wire and ID
  }
} // for planes

Definition at line 369 of file PlaneGeo.h.

369 { return IterateElements(); }

geo::PlaneGeo::IterateElements

ElementIteratorBox IterateElements() const

Allows range-for iteration on all wires in this plane.

Definition: PlaneGeo.h:368

const WireGeo& geo::PlaneGeo::LastWire ( ) const

inline

Return the last wire in the plane.

Definition at line 318 of file PlaneGeo.h.

Referenced by geo::details::ActiveAreaCalculator::initializeWireEnds().

318 { return Wire(Nwires() - 1); }

geo::PlaneGeo::Wire

WireGeo const & Wire(unsigned int iwire) const

Definition: PlaneGeo.cxx:465

geo::PlaneGeo::Nwires

unsigned int Nwires() const

Number of wires in this plane.

Definition: PlaneGeo.h:242

const WireGeo& geo::PlaneGeo::MiddleWire ( ) const

inline

Return the middle wire in the plane.

Definition at line 315 of file PlaneGeo.h.

315 { return Wire(Nwires() / 2); }

geo::PlaneGeo::Wire

WireGeo const & Wire(unsigned int iwire) const

Definition: PlaneGeo.cxx:465

geo::PlaneGeo::Nwires

unsigned int Nwires() const

Number of wires in this plane.

Definition: PlaneGeo.h:242

geo::Point_t geo::PlaneGeo::MovePointOverPlane ( geo::Point_t const & point ) const

Returns the point, moved so that its projection is over the plane.

Parameters

point point to be checked and moved

Returns: the new value of the point

See also: isProjectionOnPlane(), MoveProjectionToPlane(), Width(), Height()

If the projection of the point on the plane falls outside it, the returned point is translated so that its projection is now on the border of the plane. The translation happens along the directions of the plane frame, as described in MoveProjectionToPlane().

Definition at line 558 of file PlaneGeo.cxx.

References DeltaFromPlane(), DepthDir(), PointWidthDepthProjection(), and WidthDir().

   {
     //
     // This implementation is subject to rounding errors, since the result of
     // the addition might jitter above or below the border.
     //
 
     auto const deltaProj = DeltaFromPlane(PointWidthDepthProjection(point));
 
     return point + deltaProj.X() * WidthDir() + deltaProj.Y() * DepthDir();
 
   } // PlaneGeo::MovePointOverPlane()

PlaneGeo::WidthDepthProjection_t geo::PlaneGeo::MoveProjectionToPlane ( WidthDepthProjection_t const & proj ) const

Returns the projection, moved onto the plane if necessary.

Parameters

proj	projection to be checked and moved

Returns: the new value of the projection

See also: isProjectionOnPlane(), Width(), Height()

The projection proj is defined as in the output of PointWidthDepthProjection(). The method caps width and depth of the projection so that it stays on the plane. A new capped value is returned. Since the reference point of the frame is defined as the center of the plane, this action is equivalent to force the width component in $\left[ -\frac{w}{2}, \frac{w}{2} \right]$ range and the depth component into $\left[ -\frac{d}{2}, \frac{d}{2} \right]$ , with $ w $ and $ d $ the width and depth of the wire plane.

Definition at line 536 of file PlaneGeo.cxx.

References DeltaFromPlane(), fFrameSize, geo::PlaneGeo::RectSpecs::HalfDepth(), and geo::PlaneGeo::RectSpecs::HalfWidth().

   {
     //
     // We have a more complicate implementation to avoid rounding errors.
     // In this way, the result is really guaranteed to be exactly on the border.
     //
     auto const delta = DeltaFromPlane(proj);
     return {(delta.X() == 0.0) ?
               proj.X() :
               ((delta.X() > 0) ? -fFrameSize.HalfWidth() // delta positive -> proj on negative side
                                  :
                                  fFrameSize.HalfWidth()),
             (delta.Y() == 0.0) ?
               proj.Y() :
               ((delta.Y() > 0) ? -fFrameSize.HalfDepth() // delta positive -> proj on negative side
                                  :
                                  fFrameSize.HalfDepth())};
 
   } // PlaneGeo::MoveProjectionToPlane()

geo::WireGeo const & geo::PlaneGeo::NearestWire ( geo::Point_t const & pos ) const

Returns the wire closest to the specified position.

Parameters

pos	world coordinates of the point [cm]

Returns: the ID of the wire closest to the projection of pos on the plane

Exceptions

InvalidWireError (category: "Geometry") if out of range

The position is projected on the wire plane, and the nearest wire to the projected point is returned.

If the wire is father than half a wire pitch from the point, an exception is thrown that contains both the wire that would be the closest one (badWireID()), and also the wire that is actually the closest one (betterWireID()). When this happens, the specified position was outside the wire plane.

Note that the caller should check for containment: this function may or may not report the position being outside the plane, depending on where it is. In the current implementation, the wires are considered infinitely long, and if the position projection is closer than half the wire pitch from any of these extrapolated wires, the method will not report error.

Definition at line 605 of file PlaneGeo.cxx.

References ClosestWireID(), ID(), NearestWireID(), Wire(), and geo::WireID::Wire.

   {
 
     //
     // Note that this code is ready for when NearestWireID() will be changed
     // to return an invalid ID instead of throwing.
     // As things are now, `NearestWireID()` will never return an invalid ID,
     // but it will throw an exception similar to this one.
     //
 
     geo::WireID const wireID = NearestWireID(point);
     if (wireID) return Wire(wireID); // we have that wire, so we return it
 
     // wire ID is invalid, meaning it's out of range. Throw an exception!
     geo::WireID const closestID = ClosestWireID(wireID);
     throw InvalidWireError("Geometry", ID(), closestID.Wire, wireID.Wire)
       << "Can't find nearest wire for position " << point << " in plane " << std::string(ID())
       << " approx wire number # " << closestID.Wire << " (capped from " << wireID.Wire << ")\n";
 
   } // PlaneGeo::NearestWire()

geo::WireID geo::PlaneGeo::NearestWireID ( geo::Point_t const & pos ) const

Returns the ID of wire closest to the specified position.

Parameters

pos	world coordinates of the point [cm]

Returns: the ID of the wire closest to the projection of pos on the plane

Exceptions

InvalidWireError (category: "Geometry") if out of range

The position is projected on the wire plane, and the ID of the nearest wire to the projected point is returned.

If the wire does not exist, an exception is thrown that contains both the wire that would be the closest one (badWireID()), and also the wire that is actually the closest one (betterWireID()). When this happens, the specified position was outside the wire plane.

Note that the caller should check for containment: this function may or may not report the position being outside the plane, depending on where it is. In the current implementation, the wires are considered infinitely long, and if the position projection is closer than half the wire pitch from any of these extrapolated wires, the method will not report error.

Todo:: When the ID is out of range, instead of throwing an exception, return an invalid wire ID with the wire number set to the non-existing wire which would be the nearest to pos.

Definition at line 572 of file PlaneGeo.cxx.

References ID(), Nwires(), and WireCoordinate().

Referenced by NearestWire(), and geo::GeometryCore::NearestWireID().

   {
 
     //
     // 1) compute the wire coordinate of the point
     // 2) get the closest wire number
     // 3) check if the wire does exist
     // 4) build and return the wire ID
     //
 
     // this line merges parts (1) and (2); add 0.5 to have the correct rounding:
     int nearestWireNo = int(0.5 + WireCoordinate(pos));
 
     // if we are outside of the wireplane range, throw an exception
     if ((nearestWireNo < 0) || ((unsigned int)nearestWireNo >= Nwires())) {
 
       auto wireNo = nearestWireNo; // save for the output
 
       if (nearestWireNo < 0)
         wireNo = 0;
       else
         wireNo = Nwires() - 1;
 
       throw InvalidWireError("Geometry", ID(), nearestWireNo, wireNo)
         << "Can't find nearest wire for position " << pos << " in plane " << std::string(ID())
         << " approx wire number # " << wireNo << " (capped from " << nearestWireNo << ")\n";
     } // if invalid
 
     return {ID(), (geo::WireID::WireID_t)nearestWireNo};
 
   } // PlaneGeo::NearestWireID()

unsigned int geo::PlaneGeo::NElements ( ) const

inline

Number of wires in this plane.

Definition at line 243 of file PlaneGeo.h.

Referenced by geo::GeometryCore::Nwires().

243 { return Nwires(); }

geo::PlaneGeo::Nwires

unsigned int Nwires() const

Number of wires in this plane.

Definition: PlaneGeo.h:242

unsigned int geo::PlaneGeo::Nwires ( ) const

inline

Number of wires in this plane.

Definition at line 242 of file PlaneGeo.h.

Referenced by hit::DisambigCheater::DisambigCheater(), geo::GeometryCore::GetEndWireID(), GetNormalAxis(), geo::ChannelMapStandardAlg::Initialize(), NearestWireID(), geo::GeometryCore::Print(), UpdateIncreasingWireDir(), and UpdateWirePitch().

242 { return fWire.size(); }

geo::PlaneGeo::fWire

WireCollection_t fWire

List of wires in this plane.

Definition: PlaneGeo.h:1334

Orient_t geo::PlaneGeo::Orientation ( ) const

inline

What is the orientation of the plane.

Definition at line 169 of file PlaneGeo.h.

169 { return fOrientation; }

geo::PlaneGeo::fOrientation

Orient_t fOrientation

Is the plane vertical or horizontal?

Definition: PlaneGeo.h:1333

std::string geo::PlaneGeo::OrientationName ( geo::Orient_t orientation )

static

Returns the name of the specified orientation.

Definition at line 697 of file PlaneGeo.cxx.

References geo::kHorizontal, and geo::kVertical.

   {
     switch (orientation) {
     case geo::kHorizontal: return "horizontal"; break;
     case geo::kVertical: return "vertical"; break;
     default: return "unexpected"; break;
     } // switch
   }   // PlaneGeo::OrientationName()

double geo::PlaneGeo::PhiZ ( ) const

inline

Angle from positive z axis of the wire coordinate axis, in radians.

Definition at line 175 of file PlaneGeo.h.

Referenced by geo::GeometryCore::ThirdPlane_dTdW(), and geo::GeometryCore::ThirdPlaneSlope().

175 { return std::atan2(fSinPhiZ, fCosPhiZ); }

geo::PlaneGeo::fSinPhiZ

double fSinPhiZ

Sine of .

Definition: PlaneGeo.h:1336

geo::PlaneGeo::fCosPhiZ

double fCosPhiZ

Cosine of .

Definition: PlaneGeo.h:1337

double geo::PlaneGeo::PlaneCoordinate ( geo::Point_t const & point ) const

inline

Returns the coordinate of the point on the plane.

Parameters

point world coordinate of the point to get the coordinate of [cm]

Returns: the coordinate of the point [cm]

See also: PlaneCoordinateFrom(TVector3 const&, geo::Wire const&)

The method returns the coordinate of the point in the direction measured by the wires on this plane starting on the first wire, in world units (that is, centimeters). A point on the first wire will have coordinate 0.0, one on the next wire will have coordinate equal to a single wire pitch, etc.

The point does not need to be on the plane, and the projection of the point to the plane is considered.

Definition at line 777 of file PlaneGeo.h.

Referenced by pma::GetProjectionToPlane(), and pma::Node3D::UpdateProj2D().

     {
       return fDecompWire.PointSecondaryComponent(point);
     }

double geo::PlaneGeo::PlaneCoordinateFrom	(	geo::Point_t const &	point,
		geo::WireGeo const &	refWire
	)		const

inline

Returns the coordinate of point on the plane respect to a wire.

Parameters

point	world coordinate of the point to get the coordinate of [cm]
refWire	reference wire

Returns: the coordinate of the point [cm]

See also: WireCoordinate()

The method returns the coordinate of the point in the direction measured by the wires on this plane starting from the specified reference wire, in world units (that is, centimeters).

The point does not need to be on the plane, and the projection of the point to the plane is considered. The reference wire, instead, must belong to this plane. This assumption is not checked, and if violated the results are undefined (in the current implementation, they are just wrong).

Definition at line 755 of file PlaneGeo.h.

References geo::WireGeo::GetCenter().

     {
       return fDecompWire.VectorSecondaryComponent(point - refWire.GetCenter());
     }

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

Returns a string with plane information.

See also: PrintPlaneInfo()

The information is provided by PrintPlaneInfo(), and the arguments have the same meaning.

Definition at line 495 of file PlaneGeo.cxx.

References PrintPlaneInfo().

   {
     std::ostringstream sstr;
     PrintPlaneInfo(sstr, indent, verbosity);
     return sstr.str();
   } // PlaneGeo::PlaneInfo()

WireCoordProjection_t geo::PlaneGeo::PointProjection ( geo::Point_t const & point ) const

inline

Returns the projection of the specified point on the plane.

Parameters

point the 3D point to be projected, in world coordinates

Returns: a 2D vector representing the projection of point on the plane

The returned vector is a 2D vector expressing the projection of the point (from world coordinates) on the wire plane. The vector is expressed as $( \ell, w )$ . The component $\ell$ is measured on the direction of the first wire (see WireGeo::Direction()), using its center (see WireGeo::GetCenter()) as reference point. The component $ w $ is defined on the wire coordinate direction (see GetIncreasingWireDirection()), relative to the first wire, as it is returned by PlaneCoordinate().

The reference point is also returned by ProjectionReferencePoint().

Definition at line 854 of file PlaneGeo.h.

     {
       return Projection(point);
     }

WidthDepthProjection_t geo::PlaneGeo::PointWidthDepthProjection ( geo::Point_t const & point ) const

inline

Returns the projection of the specified point on the plane.

Parameters

point the 3D point to be projected, in world coordinates

Returns: a 2D vector representing the projection of point on the plane

The returned vector is a 2D vector expressing the projection of the point (from world coordinates) on the wire plane. The vector is expressed as $ ( w, d ) $ , components following the width direction (WidthDir()) and the depth direction (DepthDir()) respectively. The origin point is the center of the plane.

Definition at line 1000 of file PlaneGeo.h.

Referenced by geo::details::ActiveAreaCalculator::initializeWireEnds(), isProjectionOnPlane(), MovePointOverPlane(), geo::TPCGeo::Projection(), and larg4::LArVoxelReadout::RecoverOffPlaneDeposit().

     {
       return fDecompFrame.ProjectPointOnPlane(point);
     }

template<typename Stream >

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

Returns a volume including all the wires in the plane.

Prints information about this plane.

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

Information on single wires is not printed. Note that the first line out the output is not indented.

Verbosity levels

0: only plane ID
1 _(default)_: also center and wire angle
2: also information about wires
3: also information about normal and increasing coordinate direction
4: also information about wire direction, width and depth
5: also coverage
6: also bounding box

Definition at line 1384 of file PlaneGeo.h.

Referenced by PlaneInfo(), and geo::GeometryCore::Print().

 {
 
   //----------------------------------------------------------------------------
   out << "plane " << std::string(ID());
 
   if (verbosity-- <= 0) return; // 0
 
   //----------------------------------------------------------------------------
   out << " at " << GetCenter() << " cm"
       << ", theta: " << ThetaZ() << " rad";
 
   if (verbosity-- <= 0) return; // 1
 
   //----------------------------------------------------------------------------
   unsigned int const nWires = Nwires();
 
   out << "\n"
       << indent << "normal to wire: " << PhiZ() << " rad"
       << ", with orientation " << OrientationName(Orientation()) << ", has " << nWires
       << " wires measuring " << ViewName(View()) << " with a wire pitch of " << WirePitch()
       << " cm";
 
   if (verbosity-- <= 0) return; // 2
 
   //----------------------------------------------------------------------------
   auto const& normal = GetNormalDirection();
   auto const& incrZdir = GetIncreasingWireDirection();
   auto const& wireNormalDir = fDecompWire.NormalDir();
   out << "\n"
       << indent << "normal to plane: " << normal
       << ", direction of increasing wire number: " << incrZdir
       << " [wire frame normal: " << wireNormalDir << "]"
       << " (" << (WireIDincreasesWithZ() ? "increases" : "decreases") << " with z)";
 
   if (verbosity-- <= 0) return; // 3
 
   //----------------------------------------------------------------------------
 
   auto const& wireDir = GetWireDirection();
   auto const& widthDir = WidthDir();
   auto const& depthDir = DepthDir();
   auto const& frameNormalDir = fDecompFrame.NormalDir();
 
   out << "\n"
       << indent << "wire direction: " << wireDir << "; width " << Width()
       << " cm in direction: " << widthDir << ", depth " << Depth()
       << " cm in direction: " << depthDir << " [normal: " << frameNormalDir << "]";
 
   if (verbosity-- <= 0) return; // 4
 
   //----------------------------------------------------------------------------
   // get the area spanned by the wires
   out << "\n"
       << indent << "wires cover width " << ActiveArea().width.lower << " to "
       << ActiveArea().width.upper << ", depth " << ActiveArea().depth.lower << " to "
       << ActiveArea().depth.upper << " cm";
   if (verbosity-- <= 0) return; // 5
 
   //----------------------------------------------------------------------------
   // print also the containing box
   auto const box = BoundingBox();
   out << "\n" << indent << "bounding box: " << box.Min() << " -- " << box.Max();
 
   //  if (verbosity-- <= 0) return; // 6
 
   //----------------------------------------------------------------------------
 } // geo::PlaneGeo::PrintPlaneInfo()

WireCoordProjection_t geo::PlaneGeo::Projection ( geo::Point_t const & point ) const

inline

Returns the projection of the specified point on the plane.

Parameters

point the 3D point to be projected, in world coordinates

Returns: a 2D vector representing the projection of point on the plane

The returned vector is a 2D vector expressing the projection of the point (from world coordinates) on the wire plane. The vector is expressed as $( \ell, w )$ . The component $\ell$ is measured on the direction of the first wire (see WireGeo::Direction()), using its center (see WireGeo::GetCenter()) as reference point. The component $ w $ is defined on the wire coordinate direction (see GetIncreasingWireDirection()), relative to the first wire, as it is returned by PlaneCoordinate().

The reference point is also returned by ProjectionReferencePoint().

Definition at line 850 of file PlaneGeo.h.

Referenced by lar::util::TrackPitchInView().

     {
       return fDecompWire.ProjectPointOnPlane(point);
     }

WireCoordProjection_t geo::PlaneGeo::Projection ( geo::Vector_t const & v ) const

inline

Returns the projection of the specified vector on the plane.

Parameters

v	the 3D vector to be projected, in world units

Returns: a 2D vector representing the projection of v on the plane

The returned vector is a 2D vector expressing the projection of the vector (from world units) on the wire plane. The vector is expressed as $( \ell, w )$ . The component $\ell$ is measured on the direction of the first wire (see WireGeo::Direction()). The component $ w $ is defined on the wire coordinate direction (see GetIncreasingWireDirection()).

Definition at line 873 of file PlaneGeo.h.

     {
       return fDecompWire.ProjectVectorOnPlane(v);
     }

Point_t geo::PlaneGeo::ProjectionReferencePoint ( ) const

inline

Returns the reference point used by PointProjection().

The returned point is such that its decomposition results in a null projection and a 0 distance from the plane.

Definition at line 830 of file PlaneGeo.h.

830 { return fDecompWire.ReferencePoint(); }

geo::Decomposer::ReferencePoint

Point_t ReferencePoint() const

Returns the reference point for the plane coordinate, as a 3D point.

Definition: Decomposer.h:449

geo::PlaneGeo::fDecompWire

WireDecomposer_t fDecompWire

Definition: PlaneGeo.h:1343

void geo::PlaneGeo::SetView ( geo::View_t view )

inline

Set the signal view (for TPCGeo).

Definition at line 1254 of file PlaneGeo.h.

Referenced by UpdateView().

1254 { fView = view; }

geo::PlaneGeo::fView

View_t fView

Does this plane measure U, V, or W?

Definition: PlaneGeo.h:1332

bool geo::PlaneGeo::shouldFlipWire ( geo::WireGeo const & wire ) const

private

Whether the specified wire should have start and end swapped.

Definition at line 1113 of file PlaneGeo.cxx.

References geo::WireGeo::Direction(), GetIncreasingWireDirection(), and GetNormalDirection().

Referenced by UpdateAfterSorting().

   {
     //
     // The correct orientation is so that:
     //
     // (direction) x (wire coordinate direction) . (plane normal)
     //
     // is positive; it it's negative, then we should flip the wire.
     //
     // Note that the increasing wire direction comes from the wire frame, while
     // the normal direction is computed independently by geometry.
     // The resulting normal in the wire frame is expected to be the same as the
     // plane normal from GetNormalDirection(); if this is not the case, flipping
     // the wire direction should restore it.
     //
 
     return wire.Direction().Cross(GetIncreasingWireDirection()).Dot(GetNormalDirection()) <
            +0.5; // should be in fact exactly +1
 
   } // PlaneGeo::shouldFlipWire()

double geo::PlaneGeo::SinPhiZ ( ) const

inline

Sine of PhiZ()

Definition at line 178 of file PlaneGeo.h.

178 { return fSinPhiZ; }

geo::PlaneGeo::fSinPhiZ

double fSinPhiZ

Sine of .

Definition: PlaneGeo.h:1336

void geo::PlaneGeo::SortWires ( geo::GeoObjectSorter const & sorter )

Apply sorting to WireGeo objects.

Definition at line 477 of file PlaneGeo.cxx.

References fWire, and geo::GeoObjectSorter::SortWires().

   {
     sorter.SortWires(fWire);
   }

double geo::PlaneGeo::ThetaZ ( ) const

Angle of the wires from positive z axis; $\theta_{z} \in [ 0, \pi ]$ .

Definition at line 646 of file PlaneGeo.cxx.

References FirstWire(), and geo::WireGeo::ThetaZ().

Referenced by tca::dEdx(), calo::Calorimetry::GetPitch(), trkf::SpacePts::produce(), trkf::Track3Dreco::produce(), vertex::VertexFinder2D::produce(), and geo::GeometryCore::WireAngleToVertical().

   {
     return FirstWire().ThetaZ();
   }

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

inline

Transform point from world frame to local plane frame.

Definition at line 1237 of file PlaneGeo.h.

     {
       return fTrans.toLocalCoords(world);
     }

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

inline

Transform direction vector from world to local.

Definition at line 1243 of file PlaneGeo.h.

     {
       return fTrans.toLocalCoords(world);
     }

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

inline

Transform point from local plane frame to world frame.

Definition at line 1225 of file PlaneGeo.h.

Referenced by BoundingBox(), DetectGeometryDirections(), evd::RecoBaseDrawer::DrawTrack2D(), evd::TWQMultiTPCProjectionView::FindEndPoint(), evd::TWQProjectionView::FindEndPoint(), util::GeometryUtilities::Get2DPointProjection(), util::GeometryUtilities::GetProjectedPoint(), and geo::sortPlaneStandard().

     {
       return fTrans.toWorldCoords(local);
     }

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

inline

Transform direction vector from local to world.

Definition at line 1231 of file PlaneGeo.h.

     {
       return fTrans.toWorldCoords(local);
     }

void geo::PlaneGeo::UpdateActiveArea ( )

private

Updates the internally used active area.

Definition at line 1068 of file PlaneGeo.cxx.

References fActiveArea.

Referenced by UpdateAfterSorting().

   {
 
     //
     // The active area is defined in the width/depth space which include
     // approximatively all wires.
     //
     // See `ActiveAreaCalculator` for details of the algorithm.
     //
 
     // we scratch 1 um from each side to avoid rounding errors later
     fActiveArea = details::ActiveAreaCalculator(*this, 0.0001);
 
   } // PlaneGeo::UpdateActiveArea()

void geo::PlaneGeo::UpdateAfterSorting	(	geo::PlaneID	planeid,
		geo::BoxBoundedGeo const &	TPCbox
	)

Performs all needed updates after the TPC has sorted the planes.

Definition at line 652 of file PlaneGeo.cxx.

References fID, fWire, shouldFlipWire(), UpdateActiveArea(), UpdateDecompWireOrigin(), UpdateIncreasingWireDir(), UpdateOrientation(), UpdatePhiZ(), UpdatePlaneNormal(), UpdateView(), UpdateWidthDepthDir(), UpdateWireDir(), UpdateWirePitch(), and UpdateWirePlaneCenter().

   {
     // the order here matters
 
     // reset our ID
     fID = planeid;
 
     UpdatePlaneNormal(TPCbox);
     UpdateWidthDepthDir();
     UpdateIncreasingWireDir();
 
     // update wires
     geo::WireID::WireID_t wireNo = 0;
     for (auto& wire : fWire) {
       wire.UpdateAfterSorting(geo::WireID(fID, wireNo), shouldFlipWire(wire));
       ++wireNo;
     } // for wires
 
     UpdateDecompWireOrigin();
     UpdateWireDir();
     UpdateWirePlaneCenter();
     UpdateOrientation();
     UpdateWirePitch();
     UpdateActiveArea();
     UpdatePhiZ();
     UpdateView();
 
   } // PlaneGeo::UpdateAfterSorting()

void geo::PlaneGeo::UpdateDecompWireOrigin ( )

private

Updates the position of the wire coordinate decomposition.

Definition at line 1057 of file PlaneGeo.cxx.

References fDecompWire, FirstWire(), GetCenter(), geo::Decomposer< Vector, Point, ProjVector >::SetOrigin(), and geo::vect::toPoint().

Referenced by UpdateAfterSorting().

   {
 
     //
     // update the origin of the reference frame (the middle of the first wire)
     //
     fDecompWire.SetOrigin(geo::vect::toPoint(FirstWire().GetCenter()));
 
   } // PlaneGeo::UpdateDecompWireOrigin()

void geo::PlaneGeo::UpdateIncreasingWireDir ( )

private

Updates the cached direction to increasing wires.

Definition at line 991 of file PlaneGeo.cxx.

References e, fDecompWire, geo::WireGeo::GetCenter(), GetNormalDirection(), Nwires(), geo::vect::rounded01(), geo::Decomposer< Vector, Point, ProjVector >::SetSecondaryDir(), and Wire().

Referenced by UpdateAfterSorting().

   {
 
     //
     // Direction measured by the wires, pointing toward increasing wire number;
     // requires:
     // - the normal to the plane to be correct
     // - wires to be sorted
     //
 
     // 1) get the direction of the middle wire
     auto refWireNo = Nwires() / 2;
     if (refWireNo == Nwires() - 1) --refWireNo;
     auto const& refWire = Wire(refWireNo);
     auto const& WireDir = refWire.Direction(); // we only rely on the axis
 
     // 2) get the axis perpendicular to it on the wire plane
     //    (arbitrary direction)
     auto wireCoordDir = GetNormalDirection().Cross(WireDir).Unit();
 
     // 3) where is the next wire?
     auto toNextWire = Wire(refWireNo + 1).GetCenter() - refWire.GetCenter();
 
     // 4) if wireCoordDir is pointing away from the next wire, flip it
     if (wireCoordDir.Dot(toNextWire) < 0) { wireCoordDir = -wireCoordDir; }
     fDecompWire.SetSecondaryDir(geo::vect::rounded01(wireCoordDir, 1e-4));
 
   } // PlaneGeo::UpdateIncreasingWireDir()

void geo::PlaneGeo::UpdateOrientation ( )

private

Updates plane orientation.

Definition at line 804 of file PlaneGeo.cxx.

References util::abs(), e, fOrientation, fWire, GetNormalDirection(), geo::kHorizontal, and geo::kVertical.

Referenced by UpdateAfterSorting().

   {
 
     //
     // this algorithm needs to know about the axis;
     // the normal is expected to be already updated.
     //
 
     // sanity check
     if (fWire.size() < 2) {
       // this likely means construction is not complete yet
       throw cet::exception("NoWireInPlane")
         << "PlaneGeo::UpdateOrientation(): only " << fWire.size() << " wires!\n";
     } // if
 
     auto normal = GetNormalDirection();
 
     if (std::abs(std::abs(normal.X()) - 1.) < 1e-3)
       fOrientation = kVertical;
     else if (std::abs(std::abs(normal.Y()) - 1.) < 1e-3)
       fOrientation = kHorizontal;
     else {
       // at this point, the only problem is the lack of a label for this
       // orientation; probably introducing a geo::kOtherOrientation would
       // suffice
       throw cet::exception("Geometry")
         << "Plane with unsupported orientation (normal: " << normal << ")\n";
     }
 
   } // PlaneGeo::UpdateOrientation()

void geo::PlaneGeo::UpdatePhiZ ( )

private

Updates the stored $\phi_{z}$ .

Definition at line 849 of file PlaneGeo.cxx.

References fCosPhiZ, fSinPhiZ, and GetIncreasingWireDirection().

Referenced by UpdateAfterSorting().

   {
     auto const& wire_coord_dir = GetIncreasingWireDirection();
     fCosPhiZ = wire_coord_dir.Z();
     fSinPhiZ = wire_coord_dir.Y();
   } // PlaneGeo::UpdatePhiZ()

void geo::PlaneGeo::UpdatePlaneNormal ( geo::BoxBoundedGeo const & TPCbox )

private

Updates the cached normal to plane versor; needs the TPC box coordinates.

Definition at line 952 of file PlaneGeo.cxx.

References geo::BoxBoundedGeo::Center(), e, fNormal, GetBoxCenter(), GetNormalAxis(), and geo::vect::round01().

Referenced by UpdateAfterSorting().

   {
 
     //
     // direction normal to the wire plane, points toward the center of TPC
     //
 
     // start from the axis
     fNormal = GetNormalAxis();
 
     // now evaluate where we are pointing
     auto const towardCenter = TPCbox.Center() - GetBoxCenter();
 
     // if they are pointing in opposite directions, flip the normal
     if (fNormal.Dot(towardCenter) < 0) fNormal = -fNormal;
     geo::vect::round01(fNormal, 1e-3);
 
   } // PlaneGeo::UpdatePlaneNormal()

void geo::PlaneGeo::UpdateView ( )

private

Updates the stored view.

Definition at line 856 of file PlaneGeo.cxx.

References util::abs(), geo::vect::dot(), e, GetNormalDirection(), GetWireDirection(), geo::kU, geo::kV, geo::kX, geo::kY, geo::kZ, geo::vect::mixedProduct(), SetView(), geo::Xaxis(), geo::Yaxis(), and geo::Zaxis().

Referenced by UpdateAfterSorting().

   {
     /*
      * This algorithm assigns views according to the angle the wire axis cuts
      * with y axis ("thetaY"), but from the point of view of the center of the
      * TPC.
      * A special case is when the drift axis is on y axis.
      *
      * In the normal case, the discrimination happens on the the arctangent of
      * the point { (y,w), (y x n,w) }, where w is the wire direction, y is the
      * coordinate axis and n the normal to the wire plane. This definition gives
      * the same value regardless of the direction of w on its axis.
      *
      * If thetaY is 0, wires are parallel to the y axis:
      * the view is assigned as kX or kZ depending on whether the plane normal is
      * closer to the z axis or the x axis, respectively (the normal describes
      * a direction _not_ measured by the wires).
      *
      * If thetaY is a right angle, the wires are orthogonal to y axis and view
      * kY view is assigned.
      * If thetaY is smaller than 0, the view is called "U".
      * If thetaY is larger than 0, the view is called "V".
      *
      * The special case where the drift axis is on y axis is treated separately.
      * In that case, the role of y axis is replaced by the z axis and the
      * discriminating figure is equivalent to the usual ThetaZ().
      *
      * If thetaZ is 0, the wires are measuring x and kX view is chosen.
      * If thetaZ is a right angle, the wires are measuring z and kZ view is
      * chosen.
      * If thetaZ is smaller than 0, the view is called "U".
      * If thetaZ is larger than 0, the view is called "V".
      *
      */
 
     auto const& normalDir = GetNormalDirection();
     auto const& wireDir = GetWireDirection();
 
     // normal direction has been rounded, so exact comparison can work
     if (std::abs(normalDir.Y()) != 1.0) {
       //
       // normal case: drift direction is not along y (vertical)
       //
 
       // yw is pretty much GetWireDirection().Y()...
       // thetaY is related to atan2(ynw, yw)
       double const yw = geo::vect::dot(wireDir, geo::Yaxis());
       double const ynw = geo::vect::mixedProduct(geo::Yaxis(), normalDir, wireDir);
 
       if (std::abs(yw) < 1.0e-4) { // wires orthogonal to y axis
         double const closeToX = std::abs(geo::vect::dot(normalDir, geo::Xaxis()));
         double const closeToZ = std::abs(geo::vect::dot(normalDir, geo::Zaxis()));
         SetView((closeToZ > closeToX) ? geo::kX : geo::kY);
       }
       else if (std::abs(ynw) < 1.0e-4) { // wires parallel to y axis
         SetView(geo::kZ);
       }
       else if ((ynw * yw) < 0)
         SetView(geo::kU); // different sign => thetaY > 0
       else if ((ynw * yw) > 0)
         SetView(geo::kV); // same sign => thetaY < 0
       else
         assert(false); // logic error?!
     }
     else { // if drift is vertical
       //
       // special case: drift direction is along y (vertical)
       //
 
       // zw is pretty much GetWireDirection().Z()...
       double const zw = geo::vect::dot(wireDir, geo::Zaxis());
       // while GetNormalDirection() axis is on y, its direction is not fixed:
       double const znw = geo::vect::mixedProduct(geo::Zaxis(), normalDir, wireDir);
 
       // thetaZ is std::atan(znw/zw)
 
       if (std::abs(zw) < 1.0e-4) { // orthogonal to z, orthogonal to y...
         // this is equivalent to thetaZ = +/- pi/2
         SetView(geo::kZ);
       }
       else if (std::abs(znw) < 1.0e-4) { // parallel to z, orthogonal to y...
         // this is equivalent to thetaZ = 0
         SetView(geo::kX);
       }
       else if ((znw * zw) < 0)
         SetView(geo::kU); // different sign => thetaZ > 0
       else if ((znw * zw) > 0)
         SetView(geo::kV); // same sign => thetaZ < 0
       else
         assert(false); // logic error?!
 
     } // if drift direction... else
 
   } // UpdateView()

void geo::PlaneGeo::UpdateWidthDepthDir ( )

private

Updates the cached depth and width direction.

Definition at line 972 of file PlaneGeo.cxx.

References DepthDir(), e, fDecompFrame, GetNormalDirection(), geo::vect::rounded01(), geo::Decomposer< Vector, Point, ProjVector >::SecondaryDir(), geo::Decomposer< Vector, Point, ProjVector >::SetSecondaryDir(), and WidthDir().

Referenced by UpdateAfterSorting().

   {
 
     //
     // fix the positiveness of the width/depth/normal frame
     //
 
     // The basis is already set and orthonormal, with only the width
     // and depth directions arbitrary.
     // We choose the direction of the secondary axis ("depth")
     // so that the frame normal is oriented in the general direction of the
     // plane normal (the latter is computed independently).
     if (WidthDir().Cross(DepthDir()).Dot(GetNormalDirection()) < 0.0) {
       fDecompFrame.SetSecondaryDir(geo::vect::rounded01(-fDecompFrame.SecondaryDir(), 1e-4));
     }
 
   } // PlaneGeo::UpdateWidthDepthDir()

void geo::PlaneGeo::UpdateWireDir ( )

private

Updates the cached direction to wire.

Definition at line 1021 of file PlaneGeo.cxx.

References e, fDecompWire, FirstWire(), GetNormalDirection(), lar::util::makeVector3DComparison(), geo::Decomposer< Vector, Point, ProjVector >::NormalDir(), geo::vect::rounded01(), and geo::Decomposer< Vector, Point, ProjVector >::SetMainDir().

Referenced by UpdateAfterSorting().

   {
 
     fDecompWire.SetMainDir(geo::vect::rounded01(FirstWire().Direction(), 1e-4));
 
     //
     // check that the resulting normal matches the plane one
     //
     assert(
       lar::util::makeVector3DComparison(1e-5).equal(fDecompWire.NormalDir(), GetNormalDirection()));
 
   } // PlaneGeo::UpdateWireDir()

void geo::PlaneGeo::UpdateWirePitch ( )

private

Updates the stored wire pitch.

Definition at line 836 of file PlaneGeo.cxx.

References fWirePitch, Nwires(), Wire(), and geo::WireGeo::WirePitch().

Referenced by UpdateAfterSorting().

   {
     // pick long wires around the center of the detector,
     // so that their coordinates are defined with better precision
     assert(Nwires() > 1);
 
     auto const iWire = Nwires() / 2;
 
     fWirePitch = geo::WireGeo::WirePitch(Wire(iWire - 1), Wire(iWire));
 
   } // PlaneGeo::UpdateWirePitch()

void geo::PlaneGeo::UpdateWirePitchSlow ( )

private

Updates the stored wire pitch with a slower, more robust algorithm.

Definition at line 1035 of file PlaneGeo.cxx.

References e, fWire, fWirePitch, and geo::WireGeo::WirePitch().

Referenced by PlaneGeo().

   {
 
     //
     // Compare one wire (the first one, for convenience) with all other wires;
     // the wire pitch is the smallest distance we find.
     //
     // This algorithm assumes wire pitch is constant, but it does not assume
     // wire ordering (which UpdateWirePitch() does).
     //
     auto firstWire = fWire.cbegin(), wire = firstWire, wend = fWire.cend();
     fWirePitch = geo::WireGeo::WirePitch(*firstWire, *(++wire));
 
     while (++wire != wend) {
       auto wirePitch = geo::WireGeo::WirePitch(*firstWire, *wire);
       if (wirePitch < 1e-4) continue; // it's 0!
       if (wirePitch < fWirePitch) fWirePitch = wirePitch;
     } // while
 
   } // PlaneGeo::UpdateWirePitchSlow()

void geo::PlaneGeo::UpdateWirePlaneCenter ( )

private

Updates the stored wire plane center.

Definition at line 1084 of file PlaneGeo.cxx.

References DistanceFromPlane(), DriftPoint(), e, fCenter, fDecompFrame, GetBoxCenter(), geo::vect::round0(), and geo::Decomposer< Vector, Point, ProjVector >::SetOrigin().

Referenced by UpdateAfterSorting().

   {
 
     //
     // The center of the wire plane is defined as the center of the plane box,
     // translated to the plane the wires lie on.
     // This assumes that the thickness direction of the box is aligned with
     // the drift direction, so that the translated point is still in the middle
     // of width and depth dimensions.
     // It is possible to remove that assumption by translating the center of the
     // box along the thickness direction enough to bring it to the wire plane.
     // The math is just a bit less straightforward, so we don't bother yet.
     //
     // Requirements:
     //  * the wire decomposition frame must be set up (at least its origin and
     //    normal direction)
     //
 
     fCenter = GetBoxCenter();
 
     DriftPoint(fCenter, DistanceFromPlane(fCenter));
 
     geo::vect::round0(fCenter, 1e-7); // round dimensions less than 1 nm to 0
 
     fDecompFrame.SetOrigin(fCenter); // equivalent to GetCenter() now
 
   } // PlaneGeo::UpdateWirePlaneCenter()

WidthDepthProjection_t geo::PlaneGeo::VectorWidthDepthProjection ( geo::Vector_t const & v ) const

inline

Returns the projection of the specified vector on the plane.

Parameters

v	the 3D vector to be projected, in world units

Returns: a 2D vector representing the projection of v on the plane

The returned vector is a 2D vector expressing the projection of the vector (from world units) on the wire plane. The vector is expressed as $ ( w, d ) $ , components following the width direction (WidthDir()) and the depth direction (DepthDir()) respectively.

Definition at line 1018 of file PlaneGeo.h.

References proj.

Referenced by geo::details::ActiveAreaCalculator::adjustCorners(), and geo::TPCGeo::Projection().

     {
       return fDecompFrame.ProjectVectorOnPlane(v);
     }

View_t geo::PlaneGeo::View ( ) const

inline

Which coordinate does this plane measure.

Definition at line 166 of file PlaneGeo.h.

Referenced by cluster::ClusterMergeHelper::AppendResult(), ShowerRecoTools::ShowerUnidirectiondEdx::CalculateElement(), evd::RecoBaseDrawer::Cluster2D(), detinfo::DetectorPropertiesStandard::DataFor(), evd::RecoBaseDrawer::DrawTrackVertexAssns2D(), evd::RecoBaseDrawer::EndPoint2D(), evd::RecoBaseDrawer::Event2D(), util::GeometryUtilities::Get2DangleFrom3D(), lar_pandora::detector_functions::GetDetectorType(), shower::EMShowerAlg::MakeShower(), cluster::SmallClusterFinder::produce(), calo::Calorimetry::produce(), evd::RecoBaseDrawer::Prong2D(), geo::GeometryCore::View(), geo::TPCGeo::Views(), and geo::GeometryCore::WireAngleToVertical().

166 { return fView; }

geo::PlaneGeo::fView

View_t fView

Does this plane measure U, V, or W?

Definition: PlaneGeo.h:1332

std::string geo::PlaneGeo::ViewName ( geo::View_t view )

static

Returns the name of the specified view.

Definition at line 682 of file PlaneGeo.cxx.

References geo::k3D, geo::kU, geo::kUnknown, geo::kV, geo::kX, geo::kY, geo::kZ, and util::to_string().

Referenced by nnet::WaveformDenoiseTest::analyze(), nnet::NoiseWaveformDump::analyze(), nnet::RawWaveformDump::analyze(), nnet::RawWaveformClnSigDump::analyze(), trkf::SeedFinderAlgorithm::GetCenterAndDirection(), lar::util::TrackPitchInView(), and geo::GeometryCore::WireAngleToVertical().

   {
     switch (view) {
     case geo::kU: return "U";
     case geo::kV: return "V";
     case geo::kZ: return "Z";
     case geo::kY: return "Y";
     case geo::kX: return "X";
     case geo::k3D: return "3D";
     case geo::kUnknown: return "?";
     default: return "<UNSUPPORTED (" + std::to_string((int)view) + ")>";
     } // switch
   }   // PlaneGeo::ViewName()

double geo::PlaneGeo::Width ( ) const

inline

Return the width of the plane.

See also: Depth(), WidthDir(), DepthDir()

The precise definition is arbitrary (see WidthDir()).

Definition at line 221 of file PlaneGeo.h.

221 { return fFrameSize.Width(); }

geo::PlaneGeo::fFrameSize

RectSpecs fFrameSize

Definition: PlaneGeo.h:1348

geo::PlaneGeo::RectSpecs::Width

double Width() const

Definition: PlaneGeo.h:1326

Vector_t const& geo::PlaneGeo::WidthDir ( ) const

inline

Return the direction of plane width.

The precise definition of the sides is arbitrary, but they are defined to lie on the wire plane and so that WidthDir(), DepthDir() and GetNormalDirection() make a orthonormal base. That base (width, depth, normal) is guaranteed to be positive defined.

Definition at line 200 of file PlaneGeo.h.

Referenced by MovePointOverPlane(), geo::TPCGeo::RefWidthDir(), and UpdateWidthDepthDir().

200 { return fDecompFrame.MainDir(); }

geo::PlaneGeo::fDecompFrame

WidthDepthDecomposer_t fDecompFrame

Definition: PlaneGeo.h:1347

geo::Decomposer::MainDir

Vector_t const & MainDir() const

Returns the plane main axis direction.

Definition: Decomposer.h:455

geo::WireGeo const & geo::PlaneGeo::Wire ( unsigned int iwire ) const

Return the iwire'th wire in the plane.

Exceptions

cet::exception (category "WireOutOfRange") if no such wire

Note: In the past, no check was performed.

Definition at line 465 of file PlaneGeo.cxx.

References WirePtr().

Referenced by hit::MagDriftAna::analyze(), trkf::Track3DKalmanSPS::dQdxCalc(), evd::RecoBaseDrawer::DrawTrack2D(), GetNormalAxis(), geo::ChannelMapStandardAlg::Initialize(), trkf::SpacePointAlg::makeSpacePoints(), NearestWire(), geo::GeometryCore::Print(), UpdateIncreasingWireDir(), UpdateWirePitch(), and geo::GeometryCore::Wire().

   {
     geo::WireGeo const* pWire = WirePtr(iwire);
     if (!pWire) {
       throw cet::exception("WireOutOfRange") << "Request for non-existant wire " << iwire << "\n";
     }
     return *pWire;
   } // PlaneGeo::Wire(int)

WireGeo const& geo::PlaneGeo::Wire ( WireID const & wireid ) const

inline

Returns the wire in wireid from this plane.

Parameters

wireid full wire ID

Returns: a constant reference to the wire in wireid

Exceptions

cet::exception (category "WireOutOfRange") if no such wire

The cryostat, TPC and plane numbers in wireid are ignored, as it is ignored whether wireid is invalid.

Definition at line 284 of file PlaneGeo.h.

References Wire(), and geo::WireID::Wire.

Referenced by Wire().

284 { return Wire(wireid.Wire); }

geo::PlaneGeo::Wire

WireGeo const & Wire(unsigned int iwire) const

Definition: PlaneGeo.cxx:465

double geo::PlaneGeo::WireCoordinate ( geo::Point_t const & point ) const

inline

Returns the coordinate of the point on the plane, in wire units.

Parameters

point world coordinate of the point to get the coordinate of

Returns: the coordinate of the point, in wire pitch units

See also: CoordinateFrom(TVector3 const&, geo::Wire const&)

The method returns the coordinate of the point in the direction measured by the wires on this plane starting on the first wire, in wire units (that is, wire pitches). A point on the first wire will have coordinate 0.0, one on the next wire will have coordinate 1.0, etc.

The point does not need to be on the plane, and the projection of the point to the plane is considered.

Definition at line 797 of file PlaneGeo.h.

Referenced by lar_cluster3d::StandardHit3DBuilder::NearestWireID(), lar_cluster3d::SnippetHit3DBuilder::NearestWireID(), NearestWireID(), and geo::GeometryCore::WireCoordinate().

     {
       return PlaneCoordinate(point) / WirePitch();
     }

bool geo::PlaneGeo::WireIDincreasesWithZ ( ) const

Returns whether the higher z wires have higher wire ID.

Returns: whether the higher z wires have higher wire ID

See also: GetIncreasingWireDirection()

This method is related to GetIncreasingWireDirection() (it might be expressed as "GetIncreasingWireDirection()[2] > 0"), but it is implemented in a faster and independent way.

Definition at line 483 of file PlaneGeo.cxx.

References e, GetIncreasingWireDirection(), lar::util::RealComparisons< RealType >::nonNegative(), and Z.

   {
     return lar::util::RealComparisons(1e-3).nonNegative(GetIncreasingWireDirection().Z());
   } // PlaneGeo::WireIDincreasesWithZ()

double geo::PlaneGeo::WirePitch ( ) const

inline

Return the wire pitch (in centimeters). It is assumed constant.

Definition at line 378 of file PlaneGeo.h.

Referenced by geo::details::ActiveAreaCalculator::adjustCorners(), pma::CmToWireDrift(), pma::ProjectionMatchingAlg::GetCloseHits_(), util::GeometryUtilities::PitchInView(), geo::GeometryCore::ThirdPlane_dTdW(), lar::util::TrackPitchInView(), pma::ProjectionMatchingAlg::validate(), pma::ProjectionMatchingAlg::validate_on_adc_test(), pma::WireDriftToCm(), geo::TPCGeo::WirePitch(), and geo::GeometryCore::WirePitch().

378 { return fWirePitch; }

geo::PlaneGeo::fWirePitch

double fWirePitch

Pitch of wires in this plane.

Definition: PlaneGeo.h:1335

geo::WirePtr geo::PlaneGeo::WirePtr ( unsigned int iwire ) const

inline

Returns the wire number iwire from this plane.

Parameters

iwire the number of local wire

Returns: a constant pointer to the wire, or nullptr if it does not exist

Definition at line 293 of file PlaneGeo.h.

Referenced by Wire(), and geo::GeometryCore::WirePtr().

     {
       return HasWire(iwire) ? &(fWire[iwire]) : nullptr;
     }

geo::WirePtr geo::PlaneGeo::WirePtr ( WireID const & wireid ) const

inline

Returns the wire in wireid from this plane.

Parameters

wireid full wire ID

Returns: a constant pointer to the wire, or nullptr if it does not exist

The cryostat, TPC and plane numbers in wireid are ignored, as it is ignored whether wireid is invalid.

Definition at line 307 of file PlaneGeo.h.

References geo::WireID::Wire, and WirePtr().

Referenced by WirePtr().

307 { return WirePtr(wireid.Wire); }

geo::PlaneGeo::WirePtr

geo::WirePtr WirePtr(unsigned int iwire) const

Returns the wire number iwire from this plane.

Definition: PlaneGeo.h:293

Friends And Related Function Documentation

friend struct details::ActiveAreaCalculator

friend

Definition at line 1356 of file PlaneGeo.h.

Member Data Documentation

Rect geo::PlaneGeo::fActiveArea

private

Area covered by wires in frame base.

Definition at line 1350 of file PlaneGeo.h.

Referenced by DeltaFromActivePlane(), and UpdateActiveArea().

geo::Point_t geo::PlaneGeo::fCenter

private

Center of the plane, lying on the wire plane.

Definition at line 1352 of file PlaneGeo.h.

Referenced by UpdateWirePlaneCenter().

double geo::PlaneGeo::fCosPhiZ

private

Cosine of $\phi_{z}$ .

Definition at line 1337 of file PlaneGeo.h.

Referenced by UpdatePhiZ().

WidthDepthDecomposer_t geo::PlaneGeo::fDecompFrame

private

Decomposition on frame coordinates; the main direction is a "width", the secondary one is just orthogonal to it ("depth"). Normal can differ in sign from the plane one.

Definition at line 1347 of file PlaneGeo.h.

Referenced by DetectGeometryDirections(), UpdateWidthDepthDir(), and UpdateWirePlaneCenter().

WireDecomposer_t geo::PlaneGeo::fDecompWire

private

Decomposition on wire coordinates; the main direction is along the wire, the secondary one is the one measured by the wire, the normal matches the plane's normal.

Definition at line 1343 of file PlaneGeo.h.

Referenced by InterWireDistance(), UpdateDecompWireOrigin(), UpdateIncreasingWireDir(), and UpdateWireDir().

RectSpecs geo::PlaneGeo::fFrameSize

private

Size of the frame of the plane.

Definition at line 1348 of file PlaneGeo.h.

Referenced by DeltaFromPlane(), DetectGeometryDirections(), and MoveProjectionToPlane().

geo::PlaneID geo::PlaneGeo::fID

private

ID of this plane.

Definition at line 1354 of file PlaneGeo.h.

Referenced by UpdateAfterSorting().

geo::Vector_t geo::PlaneGeo::fNormal

private

Normal to the plane, inward in TPC.

Definition at line 1339 of file PlaneGeo.h.

Referenced by UpdatePlaneNormal().

Orient_t geo::PlaneGeo::fOrientation

private

Is the plane vertical or horizontal?

Definition at line 1333 of file PlaneGeo.h.

Referenced by UpdateOrientation().

double geo::PlaneGeo::fSinPhiZ

private

Sine of $\phi_{z}$ .

Definition at line 1336 of file PlaneGeo.h.

Referenced by UpdatePhiZ().

LocalTransformation_t geo::PlaneGeo::fTrans

private

Plane to world transform.

Definition at line 1330 of file PlaneGeo.h.

View_t geo::PlaneGeo::fView

private

Does this plane measure U, V, or W?

Definition at line 1332 of file PlaneGeo.h.

TGeoVolume const* geo::PlaneGeo::fVolume

private

Plane volume description.

Definition at line 1331 of file PlaneGeo.h.

Referenced by BoundingBox(), DetectGeometryDirections(), and PlaneGeo().

WireCollection_t geo::PlaneGeo::fWire

private

List of wires in this plane.

Definition at line 1334 of file PlaneGeo.h.

Referenced by SortWires(), UpdateAfterSorting(), UpdateOrientation(), and UpdateWirePitchSlow().

double geo::PlaneGeo::fWirePitch

private

Pitch of wires in this plane.

Definition at line 1335 of file PlaneGeo.h.

Referenced by InterWireDistance(), InterWireProjectedDistance(), UpdateWirePitch(), and UpdateWirePitchSlow().

constexpr unsigned int geo::PlaneGeo::MaxVerbosity = 6

static

Maximum value for print verbosity.

Definition at line 725 of file PlaneGeo.h.

Referenced by geo::GeometryCore::Print().

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

larcorealg/v09_13_01/source/larcorealg/Geometry/PlaneGeo.h
larcorealg/v09_13_01/source/larcorealg/Geometry/PlaneGeo.cxx

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Verbosity levels

Friends And Related Function Documentation

Member Data Documentation