LArSoft: geo::Decomposer< Vector, Point, ProjVector

PlaneDecomposer_t fPlaneDecomp

Manages the projection on the plane.

Definition: Decomposer.h:395

template<typename Vector, typename Point, typename ProjVector>

geo::Decomposer< Vector, Point, ProjVector >::Decomposer ( AffinePlaneBase_t const & base )

inline

Constructor: specifies a base (an origin and two direction vectors)

Definition at line 427 of file Decomposer.h.

427 : fPlaneDecomp(base) {}

PlaneDecomposer_t fPlaneDecomp

Manages the projection on the plane.

Definition: Decomposer.h:395

Member Function Documentation

template<typename Vector, typename Point, typename ProjVector>

double geo::Decomposer< Vector, Point, ProjVector >::Angle ( Vector_t const & v ) const

inline

Returns the angle of the projection from main direction.

Parameters

v	vector to get the angle of

Returns: the angle of the projection from main direction, in radians

The projection on the plane is taken, and its angle from the main direction is returned. That angle is defined in the range $\left[ -\pi, \pi \right]$ , so that it is 0 for a projection matching the main direction and $\pi/2$ for one matching the secondary direction.

Definition at line 580 of file Decomposer.h.

581 { return Plane().Angle(v); }

geo::PlaneDecomposer::Angle

PlaneDecomposer_t const & Plane() const

Returns the plane decomposer.

Definition: Decomposer.h:398

double Angle(Vector_t const &v) const

Returns the angle of the projection from main direction.

Definition: Decomposer.h:328

template<typename Vector, typename Point, typename ProjVector>

AffinePlaneBase_t const& geo::Decomposer< Vector, Point, ProjVector >::Base ( ) const

inline

Returns the base of the decomposition.

Definition at line 460 of file Decomposer.h.

460 { return Plane().Base(); }

geo::PlaneDecomposer::Base

PlaneDecomposer_t const & Plane() const

Returns the plane decomposer.

Definition: Decomposer.h:398

AffinePlaneBase_t const & Base() const

Returns the complete base representation.

Definition: Decomposer.h:250

template<typename Vector, typename Point, typename ProjVector>

Point_t geo::Decomposer< Vector, Point, ProjVector >::ComposePoint ( DecomposedVector_t const & decomp ) const

inline

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

Parameters

decomp decomposed point

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

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

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

Definition at line 611 of file Decomposer.h.

612 { return ComposePoint(decomp.distance, decomp.projection); }

geo::Decomposer::ComposePoint

Point_t ComposePoint(DecomposedVector_t const &decomp) const

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

Definition: Decomposer.h:611

template<typename Vector, typename Point, typename ProjVector>

Point_t geo::Decomposer< Vector, Point, ProjVector >::ComposePoint	(	double	distance,
		Projection_t const &	proj
	)		const

inline

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

Parameters

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

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

See also: DecomposePoint()

The returned point is the sum of two 3D contributions:

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

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

Definition at line 632 of file Decomposer.h.

633 { return ReferencePoint() + ComposeVector(distance, proj); }

geo::Decomposer::ComposeVector

Vector_t ComposeVector(DecomposedVector_t const &decomp) const

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

Definition: Decomposer.h:648

geo::Decomposer::ReferencePoint

Point_t ReferencePoint() const

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

Definition: Decomposer.h:457

proj

Float_t proj

Definition: plot.C:34

template<typename Vector, typename Point, typename ProjVector>

Vector_t geo::Decomposer< Vector, Point, ProjVector >::ComposeVector ( DecomposedVector_t const & decomp ) const

inline

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

Parameters

decomp decomposed vector

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

See also: DecomposeVector(), ComposeVector(double, Projection_t const&)

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

Definition at line 648 of file Decomposer.h.

649 { return ComposeVector(decomp.distance, decomp.projection); }

geo::Decomposer::ComposeVector

Vector_t ComposeVector(DecomposedVector_t const &decomp) const

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

Definition: Decomposer.h:648

template<typename Vector, typename Point, typename ProjVector>

Vector_t geo::Decomposer< Vector, Point, ProjVector >::ComposeVector	(	double	distance,
		Projection_t const &	proj
	)		const

inline

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

Parameters

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

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

See also: DecomposeVector()

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

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

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

Definition at line 669 of file Decomposer.h.

670 { return Plane().ComposeVector(proj) + distance * NormalDir(); }

geo::Decomposer::NormalDir

Vector_t const & NormalDir() const

Returns the plane normal axis direction.

Definition: Decomposer.h:469

geo::PlaneDecomposer::ComposeVector

PlaneDecomposer_t const & Plane() const

Returns the plane decomposer.

Definition: Decomposer.h:398

Vector_t ComposeVector(Projection_t const &projection) const

Returns the 3D vector from the specified projection.

Definition: Decomposer.h:351

proj

Float_t proj

Definition: plot.C:34

template<typename Vector, typename Point, typename ProjVector>

DecomposedVector_t geo::Decomposer< Vector, Point, ProjVector >::DecomposePoint ( Point_t const & point ) const

inline

Decomposes a 3D point in two components.

Parameters

point the point to be decomposed

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

The point is decomposed in:

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

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

Definition at line 517 of file Decomposer.h.

Referenced by geo::DriftPartitions::TPCat().

518 { return DecomposeVector(Base().ToVector(point)); }

geo::Decomposer::DecomposeVector

DecomposedVector_t DecomposeVector(Vector_t const &v) const

Decomposes a 3D vector in two components.

Definition: Decomposer.h:566

geo::Decomposer::VectorNormalComponent

AffinePlaneBase_t const & Base() const

Returns the base of the decomposition.

Definition: Decomposer.h:460

template<typename Vector, typename Point, typename ProjVector>

DecomposedVector_t geo::Decomposer< Vector, Point, ProjVector >::DecomposeVector ( Vector_t const & v ) const

inline

Decomposes a 3D vector in two components.

Parameters

v	the vector to be decomposed

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

The vector is decomposed in:

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

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

Definition at line 566 of file Decomposer.h.

567 { return { VectorNormalComponent(v), ProjectVectorOnPlane(v) }; }

auto VectorNormalComponent(Vector_t const &v) const

Returns the secondary component of a vector.

Definition: Decomposer.h:535

geo::Decomposer::ProjectVectorOnPlane

Projection_t ProjectVectorOnPlane(Vector_t const &v) const

Returns the projection of the specified vector on the plane.

Definition: Decomposer.h:549

template<typename Vector, typename Point, typename ProjVector>

auto geo::Decomposer< Vector, Point, ProjVector >::MainComponent ( Projection_t const & v ) const

inline

Returns the main component of a projection vector.

Definition at line 590 of file Decomposer.h.

591 { return Plane().MainComponent(v); }

geo::PlaneDecomposer::MainComponent

PlaneDecomposer_t const & Plane() const

Returns the plane decomposer.

Definition: Decomposer.h:398

auto MainComponent(Projection_t const &v) const

Returns the main component of a projection vector.

Definition: Decomposer.h:262

template<typename Vector, typename Point, typename ProjVector>

Vector_t const& geo::Decomposer< Vector, Point, ProjVector >::MainDir ( ) const

inline

Returns the plane main axis direction.

Definition at line 463 of file Decomposer.h.

463 { return Plane().MainDir(); }

geo::PlaneDecomposer::MainDir

Vector_t const & MainDir() const

Returns the plane main axis direction.

Definition: Decomposer.h:244

PlaneDecomposer_t const & Plane() const

Returns the plane decomposer.

Definition: Decomposer.h:398

template<typename Vector, typename Point, typename ProjVector>

Vector_t const& geo::Decomposer< Vector, Point, ProjVector >::NormalDir ( ) const

inline

Returns the plane normal axis direction.

Definition at line 469 of file Decomposer.h.

Referenced by geo::PlaneGeo::UpdateWireDir().

469 { return Base().NormalDir(); }

AffinePlaneBase_t const & Base() const

Returns the base of the decomposition.

Definition: Decomposer.h:460

template<typename Vector, typename Point, typename ProjVector>

PlaneDecomposer_t const& geo::Decomposer< Vector, Point, ProjVector >::Plane ( ) const

inlineprivate

Returns the plane decomposer.

Definition at line 398 of file Decomposer.h.

398 { return fPlaneDecomp; }

PlaneDecomposer_t fPlaneDecomp

Manages the projection on the plane.

Definition: Decomposer.h:395

template<typename Vector, typename Point, typename ProjVector>

auto geo::Decomposer< Vector, Point, ProjVector >::PointMainComponent ( Point_t const & point ) const

inline

Returns the main component of a point.

Definition at line 478 of file Decomposer.h.

479 { return VectorMainComponent(Base().ToVector(point)); }

geo::Decomposer::VectorMainComponent

AffinePlaneBase_t const & Base() const

Returns the base of the decomposition.

Definition: Decomposer.h:460

auto VectorMainComponent(Vector_t const &v) const

Returns the main component of a vector.

Definition: Decomposer.h:527

template<typename Vector, typename Point, typename ProjVector>

auto geo::Decomposer< Vector, Point, ProjVector >::PointNormalComponent ( Point_t const & point ) const

inline

Returns the secondary component of a point.

Definition at line 486 of file Decomposer.h.

Referenced by geo::DriftPartitions::computeCoverage(), geo::DriftPartitions::driftCoord(), and sortTPCsByDriftCoord().

487 { return VectorNormalComponent(Base().ToVector(point)); }

geo::Decomposer::VectorNormalComponent

auto VectorNormalComponent(Vector_t const &v) const

Returns the secondary component of a vector.

Definition: Decomposer.h:535

geo::Decomposer::VectorSecondaryComponent

AffinePlaneBase_t const & Base() const

Returns the base of the decomposition.

Definition: Decomposer.h:460

template<typename Vector, typename Point, typename ProjVector>

auto geo::Decomposer< Vector, Point, ProjVector >::PointSecondaryComponent ( Point_t const & point ) const

inline

Returns the secondary component of a point.

Definition at line 482 of file Decomposer.h.

483 { return VectorSecondaryComponent(Base().ToVector(point)); }

auto VectorSecondaryComponent(Vector_t const &v) const

Returns the secondary component of a vector.

Definition: Decomposer.h:531

geo::PlaneDecomposer::PointProjection

AffinePlaneBase_t const & Base() const

Returns the base of the decomposition.

Definition: Decomposer.h:460

template<typename Vector, typename Point, typename ProjVector>

Projection_t geo::Decomposer< Vector, Point, ProjVector >::ProjectPointOnPlane ( 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 plane. The vector is expressed as $ ( m, s ) $ , components following the main direction (MainDir()) and the secondary one (SecondaryDir()) respectively. The origin point is the one from ReferencePoint().

Definition at line 500 of file Decomposer.h.

Referenced by TPCarea().

501 { return Plane().PointProjection(point); }

Projection_t PointProjection(Point_t const &point) const

Returns the projection of the specified point on the plane.

Definition: Decomposer.h:292

geo::PlaneDecomposer::VectorProjection

PlaneDecomposer_t const & Plane() const

Returns the plane decomposer.

Definition: Decomposer.h:398

template<typename Vector, typename Point, typename ProjVector>

Projection_t geo::Decomposer< Vector, Point, ProjVector >::ProjectVectorOnPlane ( 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 $ ( m, s ) $ , components following the main direction (MainDir()) and the secondary one (SecondaryDir()) respectively.

Definition at line 549 of file Decomposer.h.

550 { return Plane().VectorProjection(v); }

Projection_t VectorProjection(Vector_t const &v) const

Returns the projection of the specified vector on the plane.

Definition: Decomposer.h:314

PlaneDecomposer_t const & Plane() const

Returns the plane decomposer.

Definition: Decomposer.h:398

template<typename Vector, typename Point, typename ProjVector>

Point_t geo::Decomposer< Vector, Point, ProjVector >::ReferencePoint ( ) const

inline

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

Definition at line 457 of file Decomposer.h.

457 { return Plane().ReferencePoint(); }

geo::PlaneDecomposer::ReferencePoint

PlaneDecomposer_t const & Plane() const

Returns the plane decomposer.

Definition: Decomposer.h:398

Point_t ReferencePoint() const

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

Definition: Decomposer.h:241

template<typename Vector, typename Point, typename ProjVector>

auto geo::Decomposer< Vector, Point, ProjVector >::SecondaryComponent ( Projection_t const & v ) const

inline

Returns the secondary component of a projection vector.

Definition at line 594 of file Decomposer.h.

595 { return Plane().SecondaryComponent(v); }

geo::PlaneDecomposer::SecondaryComponent

auto SecondaryComponent(Projection_t const &v) const

Returns the secondary component of a projection vector.

Definition: Decomposer.h:265

PlaneDecomposer_t const & Plane() const

Returns the plane decomposer.

Definition: Decomposer.h:398

template<typename Vector, typename Point, typename ProjVector>

Vector_t const& geo::Decomposer< Vector, Point, ProjVector >::SecondaryDir ( ) const

inline

Returns the plane secondary axis direction.

Definition at line 466 of file Decomposer.h.

Referenced by geo::PlaneGeo::UpdateWidthDepthDir().

466 { return Plane().SecondaryDir(); }

geo::PlaneDecomposer::SecondaryDir

PlaneDecomposer_t const & Plane() const

Returns the plane decomposer.

Definition: Decomposer.h:398

Vector_t const & SecondaryDir() const

Returns the plane secondary axis direction.

Definition: Decomposer.h:247

template<typename Vector, typename Point, typename ProjVector>

void geo::Decomposer< Vector, Point, ProjVector >::SetBase ( AffinePlaneBase_t && base )

inline

Change projection base.

Definition at line 433 of file Decomposer.h.

434 { fPlaneDecomp.SetBase(std::move(base)); }

geo::PlaneDecomposer::SetBase

PlaneDecomposer_t fPlaneDecomp

Manages the projection on the plane.

Definition: Decomposer.h:395

void SetBase(AffinePlaneBase_t &&base)

Change projection base.

Definition: Decomposer.h:220

template<typename Vector, typename Point, typename ProjVector>

void geo::Decomposer< Vector, Point, ProjVector >::SetBase ( AffinePlaneBase_t const & base )

inline

Change projection base.

Definition at line 437 of file Decomposer.h.

438 { fPlaneDecomp.SetBase(base); }

geo::PlaneDecomposer::SetBase

PlaneDecomposer_t fPlaneDecomp

Manages the projection on the plane.

Definition: Decomposer.h:395

void SetBase(AffinePlaneBase_t &&base)

Change projection base.

Definition: Decomposer.h:220

template<typename Vector, typename Point, typename ProjVector>

void geo::Decomposer< Vector, Point, ProjVector >::SetMainDir ( Vector_t const & dir )

inline

Change the main direction of the projection base.

Definition at line 444 of file Decomposer.h.

Referenced by geo::PlaneGeo::DetectGeometryDirections(), and geo::PlaneGeo::UpdateWireDir().

444 { fPlaneDecomp.SetMainDir(dir); }

geo::PlaneDecomposer::SetMainDir

void SetMainDir(Vector_t const &dir)

Change the main direction of the projection base.

Definition: Decomposer.h:229

geo::PlaneDecomposer::SetOrigin

PlaneDecomposer_t fPlaneDecomp

Manages the projection on the plane.

Definition: Decomposer.h:395

dir

TDirectory * dir

Definition: macro.C:5

template<typename Vector, typename Point, typename ProjVector>

void geo::Decomposer< Vector, Point, ProjVector >::SetOrigin ( Point_t const & point )

inline

Change the 3D point of the reference frame origin.

Definition at line 441 of file Decomposer.h.

Referenced by geo::PlaneGeo::DetectGeometryDirections(), geo::PlaneGeo::UpdateDecompWireOrigin(), and geo::PlaneGeo::UpdateWirePlaneCenter().

441 { fPlaneDecomp.SetOrigin(point); }

void SetOrigin(Point_t const &point)

Change the 3D point of the reference frame origin.

Definition: Decomposer.h:226

geo::PlaneDecomposer::SetSecondaryDir

PlaneDecomposer_t fPlaneDecomp

Manages the projection on the plane.

Definition: Decomposer.h:395

template<typename Vector, typename Point, typename ProjVector>

void geo::Decomposer< Vector, Point, ProjVector >::SetSecondaryDir ( Vector_t const & dir )

inline

Change the secondary direction of the projection base.

Definition at line 447 of file Decomposer.h.

Referenced by geo::PlaneGeo::DetectGeometryDirections(), geo::PlaneGeo::UpdateIncreasingWireDir(), and geo::PlaneGeo::UpdateWidthDepthDir().

448 { fPlaneDecomp.SetSecondaryDir(dir); }

void SetSecondaryDir(Vector_t const &dir)

Change the secondary direction of the projection base.

Definition: Decomposer.h:232

geo::PlaneDecomposer::VectorMainComponent

PlaneDecomposer_t fPlaneDecomp

Manages the projection on the plane.

Definition: Decomposer.h:395

dir

TDirectory * dir

Definition: macro.C:5

template<typename Vector, typename Point, typename ProjVector>

auto geo::Decomposer< Vector, Point, ProjVector >::VectorMainComponent ( Vector_t const & v ) const

inline

Returns the main component of a vector.

Definition at line 527 of file Decomposer.h.

528 { return Plane().VectorMainComponent(v); }

auto VectorMainComponent(Vector_t const &v) const

Returns the main component of a projection vector.

Definition: Decomposer.h:297

geo::Decomposer::NormalDir

PlaneDecomposer_t const & Plane() const

Returns the plane decomposer.

Definition: Decomposer.h:398

template<typename Vector, typename Point, typename ProjVector>

auto geo::Decomposer< Vector, Point, ProjVector >::VectorNormalComponent ( Vector_t const & v ) const

inline

Returns the secondary component of a vector.

Definition at line 535 of file Decomposer.h.

536 { return geo::vect::dot(v, NormalDir()); }

geo::vect::dot

constexpr auto dot(Vector const &a, Vector const &b)

Return cross product of two vectors.

Definition: geo_vectors_utils.h:990

Vector_t const & NormalDir() const

Returns the plane normal axis direction.

Definition: Decomposer.h:469

template<typename Vector, typename Point, typename ProjVector>

auto geo::Decomposer< Vector, Point, ProjVector >::VectorSecondaryComponent ( Vector_t const & v ) const

inline

Returns the secondary component of a vector.

Definition at line 531 of file Decomposer.h.

532 { return Plane().VectorSecondaryComponent(v); }