WireCellToolkit
Wire Cell Simulation, Signal Process and Reconstruction Toolki for Liquid Argon Detectors
WireCell::WireParams Class Reference

#include <WireParams.h>

Inheritance diagram for WireCell::WireParams:
Collaboration diagram for WireCell::WireParams:

Public Member Functions

void set (const Ray &bounds, const Ray &U, const Ray &V, const Ray &W)
 
void set (double dx=10 *units::mm, double dy=1 *units::meter, double dz=1 *units::meter, double pitch=10 *units::mm, double angle=60.0 *units::degree)
 
const Raybounds () const
 
const RaypitchU () const
 
const RaypitchV () const
 
const RaypitchW () const
 
virtual void configure (const WireCell::Configuration &config)
 
virtual WireCell::Configuration default_configuration () const
 Optional, override to return a hard-coded default configuration. More...
 
 WireParams ()
 
virtual ~WireParams ()
 
- Public Member Functions inherited from WireCell::IWireParameters
virtual ~IWireParameters ()
 
virtual const Raypitch (WireCell::WirePlaneLayer_t layer) const
 
- Public Member Functions inherited from WireCell::IComponent< IWireParameters >
virtual ~IComponent ()
 
- Public Member Functions inherited from WireCell::Interface
virtual ~Interface ()
 
- Public Member Functions inherited from WireCell::IConfigurable
virtual ~IConfigurable ()
 
- Public Member Functions inherited from WireCell::IComponent< IConfigurable >
virtual ~IComponent ()
 

Additional Inherited Members

- Public Types inherited from WireCell::IComponent< IWireParameters >
typedef std::shared_ptr< IWireParameterspointer
 Access subclass facet by pointer. More...
 
typedef std::vector< pointervector
 Vector of shared pointers. More...
 
- Public Types inherited from WireCell::Interface
typedef std::shared_ptr< Interfacepointer
 
- Public Types inherited from WireCell::IComponent< IConfigurable >
typedef std::shared_ptr< IConfigurablepointer
 Access subclass facet by pointer. More...
 
typedef std::vector< pointervector
 Vector of shared pointers. More...
 

Detailed Description

Embody parameters describing a triple of wire planes and provide a configurable interface.

Definition at line 12 of file WireParams.h.

Constructor & Destructor Documentation

◆ WireParams()

WireParams::WireParams ( )

Definition at line 17 of file WireParams.cxx.

◆ ~WireParams()

WireParams::~WireParams ( )
virtual

Definition at line 23 of file WireParams.cxx.

Member Function Documentation

◆ bounds()

const Ray & WireParams::bounds ( ) const
virtual

Provide access to the rays which were used to define the wires.

Implements WireCell::IWireParameters.

Definition at line 149 of file WireParams.cxx.

◆ configure()

void WireParams::configure ( const WireCell::Configuration config)
virtual

Configurable interface.

Implements WireCell::IConfigurable.

Definition at line 44 of file WireParams.cxx.

Here is the call graph for this function:

◆ default_configuration()

Configuration WireParams::default_configuration ( ) const
virtual

Optional, override to return a hard-coded default configuration.

Reimplemented from WireCell::IConfigurable.

Definition at line 29 of file WireParams.cxx.

Here is the call graph for this function:

◆ pitchU()

const Ray & WireParams::pitchU ( ) const
virtual

A ray going from the center of the first U wire to the second and perpendicular to both.

Implements WireCell::IWireParameters.

Definition at line 150 of file WireParams.cxx.

◆ pitchV()

const Ray & WireParams::pitchV ( ) const
virtual

A ray going from the center of the first V wire to the second and perpendicular to both.

Implements WireCell::IWireParameters.

Definition at line 151 of file WireParams.cxx.

◆ pitchW()

const Ray & WireParams::pitchW ( ) const
virtual

A ray going from the center of the first W wire to the second and perpendicular to both.

Implements WireCell::IWireParameters.

Definition at line 152 of file WireParams.cxx.

◆ set() [1/2]

void WireParams::set ( const Ray bounds,
const Ray U,
const Ray V,
const Ray W 
)

Directly set the fundamental parameters. See WireCell::IWireParameters.

Definition at line 100 of file WireParams.cxx.

Here is the call graph for this function:

◆ set() [2/2]

void WireCell::WireParams::set ( double  dx = 10 *units::mm,
double  dy = 1 *units::meter,
double  dz = 1 *units::meter,
double  pitch = 10 *units::mm,
double  angle = 60.0 *units::degree 
)

Set the wire parameters simply.

This method gives a simpler, more restricted interface to setting the wire parameter. It follows the same conventions as the one above but assumes:

  • The bounding box is centered on the origin.
  • One wire of each plane intersects the X-axis.
  • The magnitudes of the U and V angles are equal.
  • The pitches of all three planes are the same.
  • The X values W, V and U planes evening distributed on the positive half of the X covered by the bounding box.
Parameters
dx,dy,dzare the full widths of the bounding box in the associated direction.
pitchis the perpendicular distance between two adjacent wires in a plane.
angleis the absolute angular distance from the U and V wires and the Y-axis.

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