geo::PlaneGeo Class Reference

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	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...
lar::util::simple_geo::Volume	Coverage () const
	Returns a volume including all the wires in the plane. More...
template<typename Stream >
void	PrintPlaneInfo (Stream &&out, std::string indent="", unsigned int verbosity=1) const
	Prints information about this plane. More...
std::string	PlaneInfo (std::string indent="", unsigned int verbosity=1) const
	Returns a string with plane information. More...
template<typename Point >
double	WireCoordinate (Point 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; . 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
template<typename Vector >
Vector	WidthDir () const
	Return the direction of plane width. More...
DefaultVector_t	WidthDir () const
template<typename Vector >
Vector	DepthDir () const
	Return the direction of plane depth. More...
DefaultVector_t	DepthDir () const
Wire access
unsigned int	Nwires () const
	Number of wires in this plane. More...
unsigned int	NElements () const
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
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
WireGeo const &	Wire (WireID const &wireid) const
	Returns the wire in wireid from this plane. More...
WireGeo const &	GetElement (WireID const &wireid) const
geo::WirePtr	WirePtr (WireID const &wireid) const
	Returns the wire in wireid from this plane. More...
geo::WirePtr	GetElementPtr (WireID const &wireid) const
ElementIteratorBox	IterateElements () const
	Allows range-for iteration on all wires in this plane. More...
ElementIteratorBox	IterateWires () const
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...
template<typename Vector >
Vector	GetNormalDirection () const
	Returns the direction normal to the plane. More...
DefaultVector_t	GetNormalDirection () const
template<typename Vector >
Vector	GetIncreasingWireDirection () const
	Returns the direction of increasing wires. More...
DefaultVector_t	GetIncreasingWireDirection () const
template<typename Point >
Point	GetCenter () const
	Returns the centre of the wire plane in world coordinates [cm]. More...
DefaultPoint_t	GetCenter () const
template<typename Point >
Point	GetBoxCenter () const
	Returns the centre of the box representing the plane. More...
DefaultPoint_t	GetBoxCenter () const
template<typename Vector >
Vector	GetWireDirection () const
	Returns the direction of the wires. More...
DefaultVector_t	GetWireDirection () const
geo::WireID	NearestWireID (geo::Point_t const &pos) const
	Returns the ID of wire closest to the specified position. More...
geo::WireID	NearestWireID (TVector3 const &pos) const
double	DistanceFromPlane (geo::Point_t const &point) const
	Returns the distance of the specified point from the wire plane. More...
double	DistanceFromPlane (TVector3 const &point) const
void	DriftPoint (geo::Point_t &position, double distance) const
	Shifts the position of an electron drifted by a distance. More...
void	DriftPoint (TVector3 &position, double distance) const
void	DriftPoint (geo::Point_t &position) const
	Shifts the position along drift direction to fall on the plane. More...
void	DriftPoint (TVector3 &position) const
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	InterWireDistance (TVector3 const &dir) const
template<typename Vector >
std::enable_if_t < geo::vect::dimension< Vector >)==3U, double >	InterWireProjectedDistance (Vector 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	PlaneCoordinateFrom (TVector3 const &point, geo::WireGeo const &refWire) const
double	PlaneCoordinate (geo::Point_t const &point) const
	Returns the coordinate of the point on the plane. More...
double	PlaneCoordinate (TVector3 const &point) const
WireDecomposedVector_t	DecomposePoint (geo::Point_t const &point) const
	Decomposes a 3D point in two components. More...
WireDecomposedVector_t	DecomposePoint (TVector3 const &point) const
template<typename Point >
Point	ProjectionReferencePoint () const
	Returns the reference point used by PointProjection(). More...
DefaultPoint_t	ProjectionReferencePoint () const
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
WireCoordProjection_t	PointProjection (TVector3 const &point) const
WireCoordProjection_t	Projection (geo::Vector_t const &v) const
	Returns the projection of the specified vector on the plane. More...
WireCoordProjection_t	VectorProjection (geo::Vector_t const &v) const
WireCoordProjection_t	VectorProjection (TVector3 const &v) const
template<typename Vector >
Vector	ComposeVector (WireDecomposedVector_t const &decomp) const
	Returns the 3D vector from composition of projection and distance. More...
DefaultVector_t	ComposeVector (WireDecomposedVector_t const &decomp) const
template<typename Vector >
Vector	ComposeVector (double distance, WireCoordProjection_t const &proj) const
	Returns the 3D vector from composition of projection and distance. More...
DefaultVector_t	ComposeVector (double distance, WireCoordProjection_t const &proj) const
template<typename Point >
Point	ComposePoint (WireDecomposedVector_t const &decomp) const
	Returns the 3D point from composition of projection and distance. More...
DefaultPoint_t	ComposePoint (WireDecomposedVector_t const &decomp) const
template<typename Point >
Point	ComposePoint (double distance, WireCoordProjection_t const &proj) const
	Returns the 3D point from composition of projection and distance. More...
DefaultPoint_t	ComposePoint (double distance, WireCoordProjection_t const &proj) const
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...
WDDecomposedVector_t	DecomposePointWidthDepth (TVector3 const &point) const
WidthDepthProjection_t	PointWidthDepthProjection (geo::Point_t const &point) const
	Returns the projection of the specified point on the plane. More...
WidthDepthProjection_t	PointWidthDepthProjection (TVector3 const &point) const
WidthDepthProjection_t	VectorWidthDepthProjection (geo::Vector_t const &v) const
	Returns the projection of the specified vector on the plane. More...
WidthDepthProjection_t	VectorWidthDepthProjection (TVector3 const &v) const
bool	isProjectionOnPlane (geo::Point_t const &point) const
	Returns if the projection of specified point is within the plane. More...
bool	isProjectionOnPlane (TVector3 const &point) const
geo::Point_t	MovePointOverPlane (geo::Point_t const &point) const
	Returns the point, moved so that its projection is over the plane. More...
TVector3	MovePointOverPlane (TVector3 const &point) const
template<typename Point >
Point	ComposePoint (WDDecomposedVector_t const &decomp) const
	Returns the 3D vector from composition of projection and distance. More...
DefaultPoint_t	ComposePoint (WDDecomposedVector_t const &decomp) const
template<typename Point >
Point	ComposePoint (double distance, WidthDepthProjection_t const &proj) const
	Returns the 3D point from composition of projection and distance. More...
DefaultPoint_t	ComposePoint (double distance, WidthDepthProjection_t const &proj) const
Coordinate transformation
Local points and displacement vectors are described by the types geo::PlaneGeo::LocalPoint_t and geo::PlaneGeo::LocalVector_t, respectively.
void	LocalToWorld (const double *plane, double *world) const
	Transform point from local plane frame to world frame. More...
TVector3	LocalToWorld (const TVector3 &local) const
	Transform point from local plane frame to world frame. More...
geo::Point_t	toWorldCoords (LocalPoint_t const &local) const
	Transform point from local plane frame to world frame. More...
void	LocalToWorldVect (const double *plane, double *world) const
	Transform direction vector from local to world. More...
TVector3	LocalToWorldVect (const TVector3 &local) const
	Transform direction vector from local to world. More...
geo::Vector_t	toWorldCoords (LocalVector_t const &local) const
	Transform direction vector from local to world. More...
void	WorldToLocal (const double *world, double *plane) const
	Transform point from world frame to local plane frame. More...
TVector3	WorldToLocal (TVector3 const &world) const
	Transform point from world frame to local plane frame. More...
LocalPoint_t	toLocalCoords (geo::Point_t const &world) const
	Transform point from world frame to local plane frame. More...
void	WorldToLocalVect (const double *world, double *plane) const
	Transform direction vector from world to local. More...
TVector3	WorldToLocalVect (TVector3 const &world) const
	Transform direction vector from world to local. More...
LocalVector_t	toLocalCoords (geo::Vector_t const &world) const
	Transform direction vector from world to local. More...
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	DefaultVector_t = TVector3
using	DefaultPoint_t = TVector3
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 . 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...

Static Private Member Functions
template<typename T >
static T	boundedValue (T v, T min, T max)
	Returns min if v < min, max if v > max, v otherwise. 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 . More...
double	fCosPhiZ
	Cosine of . 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 82 of file PlaneGeo.h.

Member Typedef Documentation

using geo::PlaneGeo::DefaultPoint_t = TVector3

private

Definition at line 85 of file PlaneGeo.h.

using geo::PlaneGeo::DefaultVector_t = TVector3

private

Definition at line 84 of file PlaneGeo.h.

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

Type returned by IterateElements().

Definition at line 93 of file PlaneGeo.h.

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

Definition at line 90 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 115 of file PlaneGeo.h.

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

private

Definition at line 1466 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 118 of file PlaneGeo.h.

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

Type for description of rectangles.

Definition at line 169 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 163 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 159 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 155 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 151 of file PlaneGeo.h.

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

Definition at line 89 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 130 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 137 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 134 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 435 of file PlaneGeo.cxx.

    : 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 758 of file PlaneGeo.h.

{ return fActiveArea; }

template<typename T >

static T geo::PlaneGeo::boundedValue ( T  v, T  min, T  max  )

inlinestaticprivate

Returns min if v < min, max if v > max, v otherwise.

Definition at line 1508 of file PlaneGeo.h.

      { return std::min(max, std::max(min, v)); }

geo::BoxBoundedGeo geo::PlaneGeo::BoundingBox

(

)

const

Returns the world coordinates of the box containing the plane.

See Also

GetBoxCenter()

Definition at line 469 of file PlaneGeo.cxx.

                                               {

    //
    // 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()
        << "['" << fVolume->GetName() << "'] has a shape which is a "
        << pShape->IsA()->GetName()
        << ", 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 1520 of file PlaneGeo.h.

{
  return { ID(), boundedValue<geo::WireID::WireID_t>(wireNo, 0, 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 1525 of file PlaneGeo.h.

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

template<typename Point >

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

inline

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

Template Parameters

Point

the type of point to return (current default: TVector3)

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 1024 of file PlaneGeo.h.

      { return geo::vect::convertTo<Point>(fDecompWire.ComposePoint(decomp)); }

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

inline

Definition at line 1026 of file PlaneGeo.h.

      { return ComposePoint<DefaultPoint_t>(decomp); }

template<typename Point >

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

inline

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

Template Parameters

Point

the type of point to return (current default: TVector3)

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:

1. a vector parallel to the plane normal, with norm the input distance
2. 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 1054 of file PlaneGeo.h.

      { return geo::vect::convertTo<Point>(fDecompWire.ComposePoint(distance, proj)); }

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

inline

Definition at line 1057 of file PlaneGeo.h.

      { return ComposePoint<DefaultPoint_t>(distance, proj); }

template<typename Point >

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

inline

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

Template Parameters

Point

type of point to be produced (current default is TVector3)

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 1294 of file PlaneGeo.h.

      { return geo::vect::convertTo<Point>(fDecompFrame.ComposePoint(decomp)); }

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

inline

Definition at line 1296 of file PlaneGeo.h.

      { return ComposePoint<DefaultPoint_t>(decomp); }

template<typename Point >

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

inline

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

Template Parameters

Point

type of point to be produced (current default is TVector3)

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:

1. a vector parallel to the plane normal, with norm the input distance
2. 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 1322 of file PlaneGeo.h.

      { return geo::vect::convertTo<Point>(fDecompFrame.ComposePoint(distance, proj)); }

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

inline

Definition at line 1325 of file PlaneGeo.h.

      { return ComposePoint<DefaultPoint_t>(distance, proj); }

template<typename Vector >

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

inline

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

Template Parameters

Vector

the type of vector to return (current default: TVector3)

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 982 of file PlaneGeo.h.

      { return geo::vect::convertTo<Vector>(fDecompWire.ComposeVector(decomp)); }

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

inline

Definition at line 984 of file PlaneGeo.h.

      { return ComposeVector<DefaultVector_t>(decomp); }

template<typename Vector >

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

inline

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

Template Parameters

Vector

the type of vector to return (current default: TVector3)

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:

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

Definition at line 1005 of file PlaneGeo.h.

      { return geo::vect::convertTo<Vector>(fDecompWire.ComposeVector(distance, proj)); }

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

inline

Definition at line 1008 of file PlaneGeo.h.

      { return ComposeVector<DefaultVector_t>(distance, proj); }

double geo::PlaneGeo::CosPhiZ ( ) const

inline

Cosine of PhiZ()

Definition at line 200 of file PlaneGeo.h.

{ return fCosPhiZ; }

lar::util::simple_geo::Volume geo::PlaneGeo::Coverage

(

)

const

Returns a volume including all the wires in the plane.

Definition at line 532 of file PlaneGeo.cxx.

                                                     {

    // add both coordinates of first and last wire
    std::array<double, 3> A, B;

    FirstWire().GetStart(A.data());
    LastWire().GetEnd(B.data());

    return { A.data(), B.data() };
  } // PlaneGeo::Coverage()

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:

1. a component orthogonal to the plane, expressed as a signed real number
2. 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 901 of file PlaneGeo.h.

      { return fDecompWire.DecomposePoint(point); }

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

inline

Definition at line 903 of file PlaneGeo.h.

      { return DecomposePoint(geo::vect::toPoint(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:

1. a component orthogonal to the plane, expressed as a signed real number
2. 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 1088 of file PlaneGeo.h.

      { return fDecompFrame.DecomposePoint(point); }

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

inline

Definition at line 1090 of file PlaneGeo.h.

      { return DecomposePointWidthDepth(geo::vect::toPoint(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 569 of file PlaneGeo.cxx.

  {

    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 1242 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 556 of file PlaneGeo.cxx.

  {

    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 1194 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 254 of file PlaneGeo.h.

{ return fFrameSize.Depth(); }

template<typename Vector >

Vector geo::PlaneGeo::DepthDir ( ) const

inline

Return the direction of plane depth.

Template Parameters

Vector

the type of vector to return (current default: TVector3)

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 236 of file PlaneGeo.h.

{ return geo::vect::convertTo<Vector>(fDecompFrame.SecondaryDir()); }

DefaultVector_t geo::PlaneGeo::DepthDir ( ) const

inline

Definition at line 237 of file PlaneGeo.h.

{ return DepthDir<DefaultVector_t>(); }

void geo::PlaneGeo::DetectGeometryDirections ( )

private

Sets the geometry directions.

Definition at line 788 of file PlaneGeo.cxx.

                                          {

    //
    // 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() << "['" << fVolume->GetName()
        << "'] has a shape which is a " << pShape->IsA()->GetName()
        << ", 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;
      TVector3 dir;

      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 621 of file PlaneGeo.h.

      { return fDecompWire.PointNormalComponent(point); }

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

inline

Definition at line 623 of file PlaneGeo.h.

      { return DistanceFromPlane(geo::vect::toPoint(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 643 of file PlaneGeo.h.

      { position -= distance * GetNormalDirection<geo::Vector_t>(); }

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

inline

Definition at line 645 of file PlaneGeo.h.

      { 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 659 of file PlaneGeo.h.

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

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

inline

Definition at line 661 of file PlaneGeo.h.

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

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

inline

Return the first wire in the plane.

Definition at line 344 of file PlaneGeo.h.

{ return Wire(0);        }

template<typename Point >

Point geo::PlaneGeo::GetBoxCenter ( ) const

inline

Returns the centre of the box representing the plane.

Template Parameters

Point

type of point to be returned (current default: TVector3)

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 498 of file PlaneGeo.h.

      { return geo::vect::convertTo<Point>(toWorldCoords(LocalPoint_t{ 0.0, 0.0, 0.0 })); }

DefaultPoint_t geo::PlaneGeo::GetBoxCenter ( ) const

inline

Definition at line 500 of file PlaneGeo.h.

      { return GetBoxCenter<DefaultPoint_t>(); }

template<typename Point >

Point 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 479 of file PlaneGeo.h.

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

DefaultPoint_t geo::PlaneGeo::GetCenter ( ) const

inline

Definition at line 481 of file PlaneGeo.h.

{ return GetCenter<DefaultPoint_t>(); }

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

inline

Definition at line 315 of file PlaneGeo.h.

      { return Wire(wireid); }

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

inline

Definition at line 338 of file PlaneGeo.h.

      { return WirePtr(wireid); }

template<typename Vector >

Vector geo::PlaneGeo::GetIncreasingWireDirection ( ) const

inline

Returns the direction of increasing wires.

Template Parameters

Vector

the type of vector to return (current default: TVector3)

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 457 of file PlaneGeo.h.

      { return geo::vect::convertTo<Vector>(fDecompWire.SecondaryDir()); }

DefaultVector_t geo::PlaneGeo::GetIncreasingWireDirection ( ) const

inline

Definition at line 459 of file PlaneGeo.h.

      { return GetIncreasingWireDirection<DefaultVector_t>(); }

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

private

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

Definition at line 871 of file PlaneGeo.cxx.

                                            {
    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<geo::Vector_t>();

    // 2) get the direction between the middle wire and the next one
    auto const ToNextWire = Wire(NWires / 2 + 1).GetCenter<geo::Point_t>()
      - Wire(NWires / 2).GetCenter<geo::Point_t>();

    // 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()

template<typename Vector >

Vector geo::PlaneGeo::GetNormalDirection ( ) const

inline

Returns the direction normal to the plane.

Template Parameters

Vector

the type of vector to return (current default: TVector3)

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 442 of file PlaneGeo.h.

{ return geo::vect::convertTo<Vector>(fNormal); }

DefaultVector_t geo::PlaneGeo::GetNormalDirection ( ) const

inline

Definition at line 443 of file PlaneGeo.h.

      { return GetNormalDirection<DefaultVector_t>(); }

template<typename Vector >

Vector geo::PlaneGeo::GetWireDirection ( ) const

inline

Returns the direction of the wires.

Template Parameters

Vector

the type of vector to return (current default: TVector3)

Returns

a unit vector following the direction of the wires

All wires in the plane are assumed parallel.

Definition at line 513 of file PlaneGeo.h.

{ return geo::vect::convertTo<Vector>(fDecompWire.MainDir()); }

DefaultVector_t geo::PlaneGeo::GetWireDirection ( ) const

inline

Definition at line 514 of file PlaneGeo.h.

      { return GetWireDirection<DefaultVector_t>(); }

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

inline

Definition at line 280 of file PlaneGeo.h.

{ return HasWire(iwire); }

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

inline

Definition at line 294 of file PlaneGeo.h.

      { return HasWire(wireid); }

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 279 of file PlaneGeo.h.

{ return iwire < Nwires(); }

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 292 of file PlaneGeo.h.

      { return HasWire(wireid.Wire); }

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

inline

Returns the identifier of this plane.

Definition at line 203 of file PlaneGeo.h.

{ return fID; }

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 713 of file PlaneGeo.cxx.

                                                                 {
    // 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::InterWireDistance ( TVector3 const &  dir ) const

inline

Definition at line 714 of file PlaneGeo.h.

      { return InterWireDistance(geo::vect::toVector(dir)); }

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 705 of file PlaneGeo.cxx.

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

template<typename Vector >

std::enable_if_t<geo::vect::dimension<Vector>) == 3U, double> geo::PlaneGeo::InterWireProjectedDistance ( Vector const &  dir ) const

inline

Returns the distance between wires along the specified direction.

Template Parameters

Vector

type of 3D vector

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 741 of file PlaneGeo.h.

      { return InterWireProjectedDistance(VectorProjection(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 581 of file PlaneGeo.cxx.

                                                                  {

    auto const deltaProj
      = DeltaFromPlane(PointWidthDepthProjection(point));

    return (deltaProj.X() == 0.) && (deltaProj.Y() == 0.);

  } // PlaneGeo::isProjectionOnPlane()

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

inline

Definition at line 1147 of file PlaneGeo.h.

      { return isProjectionOnPlane(geo::vect::toPoint(point)); }

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 400 of file PlaneGeo.h.

{ return fWire; }

ElementIteratorBox geo::PlaneGeo::IterateWires ( ) const

inline

Definition at line 401 of file PlaneGeo.h.

{ return IterateElements(); }

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

inline

Return the last wire in the plane.

Definition at line 350 of file PlaneGeo.h.

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

void geo::PlaneGeo::LocalToWorld ( const double *  plane, double *  world  ) const

inline

Transform point from local plane frame to world frame.

Definition at line 1343 of file PlaneGeo.h.

      { fTrans.LocalToWorld(plane, world); }

TVector3 geo::PlaneGeo::LocalToWorld ( const TVector3 &  local ) const

inline

Transform point from local plane frame to world frame.

Definition at line 1347 of file PlaneGeo.h.

      { return fTrans.LocalToWorld<TVector3>(local); }

void geo::PlaneGeo::LocalToWorldVect ( const double *  plane, double *  world  ) const

inline

Transform direction vector from local to world.

Definition at line 1355 of file PlaneGeo.h.

      { fTrans.LocalToWorldVect(plane, world); }

TVector3 geo::PlaneGeo::LocalToWorldVect ( const TVector3 &  local ) const

inline

Transform direction vector from local to world.

Definition at line 1359 of file PlaneGeo.h.

      { return fTrans.LocalToWorldVect<TVector3>(local); }

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

inline

Return the middle wire in the plane.

Definition at line 347 of file PlaneGeo.h.

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

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 633 of file PlaneGeo.cxx.

                                                                       {

    //
    // 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<geo::Vector_t>() + deltaProj.Y() * DepthDir<geo::Vector_t>();

  } // PlaneGeo::MovePointOverPlane()

TVector3 geo::PlaneGeo::MovePointOverPlane

(

TVector3 const &

point

)

const

Definition at line 619 of file PlaneGeo.cxx.

                                                                   {

    //
    // 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 range and the depth component into , with and the width and depth of the wire plane.

Definition at line 593 of file PlaneGeo.cxx.

  {
    //
    // 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 681 of file PlaneGeo.cxx.

                                                                       {

    //
    // 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 649 of file PlaneGeo.cxx.

                                                               {

    //
    // 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()

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

inline

Definition at line 545 of file PlaneGeo.h.

      { return NearestWireID(geo::vect::toPoint(pos)); }

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

inline

Definition at line 270 of file PlaneGeo.h.

{ return Nwires();       }

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

inline

Number of wires in this plane.

Definition at line 269 of file PlaneGeo.h.

{ return fWire.size();   }

Orient_t geo::PlaneGeo::Orientation ( ) const

inline

What is the orientation of the plane.

Definition at line 187 of file PlaneGeo.h.

{ return fOrientation;   }

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

static

Returns the name of the specified orientation.

Definition at line 778 of file PlaneGeo.cxx.

                                                             {
    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 193 of file PlaneGeo.h.

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

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 861 of file PlaneGeo.h.

      { return fDecompWire.PointSecondaryComponent(point); }

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

inline

Definition at line 863 of file PlaneGeo.h.

      { return PlaneCoordinate(geo::vect::toPoint(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 834 of file PlaneGeo.h.

      {
        return
          fDecompWire.VectorSecondaryComponent(point - geo::vect::toPoint(refWire.GetCenter()));
      }

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

inline

Definition at line 840 of file PlaneGeo.h.

      { return PlaneCoordinateFrom(geo::vect::toPoint(point), refWire); }

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 546 of file PlaneGeo.cxx.

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

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

inline

Definition at line 942 of file PlaneGeo.h.

      { return Projection(point); }

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

inline

Definition at line 944 of file PlaneGeo.h.

      { return PointProjection(geo::vect::toPoint(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 , components following the width direction (WidthDir()) and the depth direction (DepthDir()) respectively. The origin point is the center of the plane.

Definition at line 1107 of file PlaneGeo.h.

      { return fDecompFrame.ProjectPointOnPlane(point); }

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

inline

Definition at line 1110 of file PlaneGeo.h.

      { return PointWidthDepthProjection(geo::vect::toPoint(point)); }

template<typename Stream >

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

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 1539 of file PlaneGeo.h.

        {

  //----------------------------------------------------------------------------
  out << "plane " << std::string(ID());

  if (verbosity-- <= 0) return; // 0

  //----------------------------------------------------------------------------
  out
    << " at " << GetCenter<geo::Vector_t>() << " 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<geo::Vector_t>();
  auto const& incrZdir = GetIncreasingWireDirection<geo::Vector_t>();
  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<geo::Vector_t>();
  auto const& widthDir = WidthDir<geo::Vector_t>();
  auto const& depthDir = DepthDir<geo::Vector_t>();
  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 . The component is measured on the direction of the first wire (see WireGeo::Direction()), using its center (see WireGeo::GetCenter()) as reference point. The component 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 940 of file PlaneGeo.h.

      { 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 . The component is measured on the direction of the first wire (see WireGeo::Direction()). The component is defined on the wire coordinate direction (see GetIncreasingWireDirection()).

Definition at line 961 of file PlaneGeo.h.

      { return fDecompWire.ProjectVectorOnPlane(v); }

template<typename Point >

Point geo::PlaneGeo::ProjectionReferencePoint ( ) const

inline

Returns the reference point used by PointProjection().

Template Parameters

Point

the type of point to return (current default: TVector3)

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

Definition at line 917 of file PlaneGeo.h.

      { return geo::vect::convertTo<Point>(fDecompWire.ReferencePoint()); }

DefaultPoint_t geo::PlaneGeo::ProjectionReferencePoint ( ) const

inline

Definition at line 919 of file PlaneGeo.h.

      { return ProjectionReferencePoint<DefaultPoint_t>(); }

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

inline

Set the signal view (for TPCGeo).

Definition at line 1398 of file PlaneGeo.h.

{ fView = view; }

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

private

Whether the specified wire should have start and end swapped.

Definition at line 1212 of file PlaneGeo.cxx.

                                                            {
    //
    // 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 197 of file PlaneGeo.h.

{ return fSinPhiZ; }

void geo::PlaneGeo::SortWires

(

geo::GeoObjectSorter const &

sorter

)

Apply sorting to WireGeo objects.

Definition at line 518 of file PlaneGeo.cxx.

  {
    sorter.SortWires(fWire);
  }

double geo::PlaneGeo::ThetaZ

(

)

const

Angle of the wires from positive z axis; .

Definition at line 726 of file PlaneGeo.cxx.

{ 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 1375 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 1387 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 1351 of file PlaneGeo.h.

      { 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 1363 of file PlaneGeo.h.

      { return fTrans.toWorldCoords(local); }

void geo::PlaneGeo::UpdateActiveArea ( )

private

Updates the internally used active area.

Definition at line 1167 of file PlaneGeo.cxx.

                                  {

    //
    // 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 731 of file PlaneGeo.cxx.

  {
    // 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 1157 of file PlaneGeo.cxx.

                                        {

    //
    // 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 1087 of file PlaneGeo.cxx.

                                         {

    //
    // 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 = geo::vect::toVector(refWire.Direction()); // we only rely on the axis


    // 2) get the axis perpendicular to it on the wire plane
    //    (arbitrary direction)
    auto wireCoordDir = GetNormalDirection<geo::Vector_t>().Cross(WireDir).Unit();

    // 3) where is the next wire?
    auto toNextWire
      = geo::vect::toVector(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 891 of file PlaneGeo.cxx.

                                   {

    //
    // 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<geo::Vector_t>();

    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 .

Definition at line 935 of file PlaneGeo.cxx.

                            {
    TVector3 const& wire_coord_dir = GetIncreasingWireDirection();
  /*
    TVector3 const& normal = GetNormalDirection();
    TVector3 z(0., 0., 1.);

    // being defined in absolute terms as angle respect to z axis,
    // we take the z component as cosine, and all the rest as sine
    fCosPhiZ = wire_coord_dir.Dot(z);
    fSinPhiZ = wire_coord_dir.Cross(z).Dot(normal);
  */
    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 1046 of file PlaneGeo.cxx.

                                                                 {

    //
    // 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
      = geo::vect::convertTo<TVector3>(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 950 of file PlaneGeo.cxx.

  {
    /*
     * 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<geo::Vector_t>();
    auto const& wireDir = GetWireDirection<geo::Vector_t>();

    // 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 1067 of file PlaneGeo.cxx.

                                     {

    //
    // 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 1121 of file PlaneGeo.cxx.

                               {

    fDecompWire.SetMainDir(geo::vect::rounded01(geo::vect::toVector(FirstWire().Direction()), 1e-4));

    //
    // check that the resulting normal matches the plane one
    //
    assert(lar::util::makeVector3DComparison(1e-5)
      .equal(fDecompWire.NormalDir(), GetNormalDirection<geo::Vector_t>()));

  } // PlaneGeo::UpdateWireDir()

void geo::PlaneGeo::UpdateWirePitch ( )

private

Updates the stored wire pitch.

Definition at line 923 of file PlaneGeo.cxx.

                                 {
    // 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 1135 of file PlaneGeo.cxx.

                                     {

    //
    // 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 1183 of file PlaneGeo.cxx.

                                       {

    //
    // 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<geo::Point_t>();

    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()

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

inline

Definition at line 963 of file PlaneGeo.h.

      { return Projection(v); }

WireCoordProjection_t geo::PlaneGeo::VectorProjection ( TVector3 const &  v ) const

inline

Definition at line 965 of file PlaneGeo.h.

      { return VectorProjection(geo::vect::toVector(v)); }

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 , components following the width direction (WidthDir()) and the depth direction (DepthDir()) respectively.

Definition at line 1127 of file PlaneGeo.h.

      { return fDecompFrame.ProjectVectorOnPlane(v); }

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

inline

Definition at line 1130 of file PlaneGeo.h.

      { return VectorWidthDepthProjection(geo::vect::toVector(v)); }

View_t geo::PlaneGeo::View ( ) const

inline

Which coordinate does this plane measure.

Definition at line 184 of file PlaneGeo.h.

{ return fView;          }

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

static

Returns the name of the specified view.

Definition at line 763 of file PlaneGeo.cxx.

                                             {
    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 246 of file PlaneGeo.h.

{ return fFrameSize.Width(); }

template<typename Vector >

Vector geo::PlaneGeo::WidthDir ( ) const

inline

Return the direction of plane width.

Template Parameters

Vector

the type of vector to return (current default: TVector3)

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 221 of file PlaneGeo.h.

{ return geo::vect::convertTo<Vector>(fDecompFrame.MainDir()); }

DefaultVector_t geo::PlaneGeo::WidthDir ( ) const

inline

Definition at line 222 of file PlaneGeo.h.

{ return WidthDir<DefaultVector_t>(); }

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 506 of file PlaneGeo.cxx.

                                                           {
    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 313 of file PlaneGeo.h.

      { return Wire(wireid.Wire); }

template<typename Point >

double geo::PlaneGeo::WireCoordinate ( Point 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 882 of file PlaneGeo.h.

      { 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 525 of file PlaneGeo.cxx.

                                            {
    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 411 of file PlaneGeo.h.

{ return fWirePitch; }

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 324 of file PlaneGeo.h.

      { 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 336 of file PlaneGeo.h.

      { return WirePtr(wireid.Wire); }

void geo::PlaneGeo::WorldToLocal ( const double *  world, double *  plane  ) const

inline

Transform point from world frame to local plane frame.

Definition at line 1367 of file PlaneGeo.h.

      { fTrans.WorldToLocal(world, plane); }

TVector3 geo::PlaneGeo::WorldToLocal ( TVector3 const &  world ) const

inline

Transform point from world frame to local plane frame.

Definition at line 1371 of file PlaneGeo.h.

      { return fTrans.WorldToLocal<TVector3>(world); }

void geo::PlaneGeo::WorldToLocalVect ( const double *  world, double *  plane  ) const

inline

Transform direction vector from world to local.

Definition at line 1379 of file PlaneGeo.h.

      { fTrans.WorldToLocalVect(world, plane); }

TVector3 geo::PlaneGeo::WorldToLocalVect ( TVector3 const &  world ) const

inline

Transform direction vector from world to local.

Definition at line 1383 of file PlaneGeo.h.

      { return fTrans.WorldToLocalVect<TVector3>(world); }

Friends And Related Function Documentation

friend struct details::ActiveAreaCalculator

friend

Definition at line 1504 of file PlaneGeo.h.

Member Data Documentation

Rect geo::PlaneGeo::fActiveArea

private

Area covered by wires in frame base.

Definition at line 1498 of file PlaneGeo.h.

geo::Point_t geo::PlaneGeo::fCenter

private

Center of the plane, lying on the wire plane.

Definition at line 1500 of file PlaneGeo.h.

double geo::PlaneGeo::fCosPhiZ

private

Cosine of .

Definition at line 1485 of file PlaneGeo.h.

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 1495 of file PlaneGeo.h.

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 1491 of file PlaneGeo.h.

RectSpecs geo::PlaneGeo::fFrameSize

private

Size of the frame of the plane.

Definition at line 1496 of file PlaneGeo.h.

geo::PlaneID geo::PlaneGeo::fID

private

ID of this plane.

Definition at line 1502 of file PlaneGeo.h.

geo::Vector_t geo::PlaneGeo::fNormal

private

Normal to the plane, inward in TPC.

Definition at line 1487 of file PlaneGeo.h.

Orient_t geo::PlaneGeo::fOrientation

private

Is the plane vertical or horizontal?

Definition at line 1481 of file PlaneGeo.h.

double geo::PlaneGeo::fSinPhiZ

private

Sine of .

Definition at line 1484 of file PlaneGeo.h.

LocalTransformation_t geo::PlaneGeo::fTrans

private

Plane to world transform.

Definition at line 1478 of file PlaneGeo.h.

View_t geo::PlaneGeo::fView

private

Does this plane measure U, V, or W?

Definition at line 1480 of file PlaneGeo.h.

TGeoVolume const* geo::PlaneGeo::fVolume

private

Plane volume description.

Definition at line 1479 of file PlaneGeo.h.

WireCollection_t geo::PlaneGeo::fWire

private

List of wires in this plane.

Definition at line 1482 of file PlaneGeo.h.

double geo::PlaneGeo::fWirePitch

private

Pitch of wires in this plane.

Definition at line 1483 of file PlaneGeo.h.

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

static

Maximum value for print verbosity.

Definition at line 802 of file PlaneGeo.h.

---

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

• PlaneGeo.h
• PlaneGeo.cxx