WireCell::WireParams Class Reference

#include <WireParams.h>

Inheritance 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 Ray &	bounds () const
const Ray &	pitchU () const
const Ray &	pitchV () const
const Ray &	pitchW () 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 Ray &	pitch (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 ()

Private Attributes
Ray	m_bounds
Ray	m_pitchU
Ray	m_pitchV
Ray	m_pitchW

Additional Inherited Members
Public Types inherited from WireCell::IComponent< IWireParameters >
typedef std::shared_ptr< IWireParameters >	pointer
	Access subclass facet by pointer. More...
typedef std::vector< pointer >	vector
	Vector of shared pointers. More...
Public Types inherited from WireCell::Interface
typedef std::shared_ptr< Interface >	pointer
Public Types inherited from WireCell::IComponent< IConfigurable >
typedef std::shared_ptr< IConfigurable >	pointer
	Access subclass facet by pointer. More...
typedef std::vector< pointer >	vector
	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

(

)

Definition at line 17 of file WireParams.cxx.

{
    //++n_wireparams;
    //cerr << "WireParams(" << n_wireparams << ")" << endl;
    this->set();
}

WireParams::~WireParams ( )

virtual

Definition at line 23 of file WireParams.cxx.

{
    //--n_wireparams;
    //cerr << "~WireParams(" << n_wireparams << ")" << endl;
}

Member Function Documentation

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.

{ return m_bounds; }

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

virtual

Configurable interface.

Implements WireCell::IConfigurable.

Definition at line 44 of file WireParams.cxx.

{
    // The local origin about which all else is measured.
    double cx = get<double>(cfg, "center_mm.x")*units::mm;
    double cy = get<double>(cfg,"center_mm.y")*units::mm;
    double cz = get<double>(cfg, "center_mm.z")*units::mm;
    const Point center(cx,cy,cz);
    
    // The full width sizes
    double dx = get<double>(cfg, "size_mm.x")*units::mm;
    double dy = get<double>(cfg, "size_mm.y")*units::mm;
    double dz = get<double>(cfg, "size_mm.z")*units::mm;
    const Point deltabb(dx,dy,dz);
    const Point bbmax = center + 0.5*deltabb;
    const Point bbmin = center - 0.5*deltabb;

    // The angles of the wires w.r.t. the positive Y axis
    double angU = get<double>(cfg, "angle_deg.u")*units::degree;
    double angV = get<double>(cfg, "angle_deg.v")*units::degree;
    double angW = get<double>(cfg, "angle_deg.w")*units::degree;

    const Vector wU(0, std::cos(angU), std::sin(angU));
    const Vector wV(0, std::cos(angV), std::sin(angV));
    const Vector wW(0, std::cos(angW), std::sin(angW));

    // The pitch magnitudes.
    double pitU = get<double>(cfg, "pitch_mm.u")*units::mm;
    double pitV = get<double>(cfg, "pitch_mm.v")*units::mm;
    double pitW = get<double>(cfg, "pitch_mm.w")*units::mm;

    // Pitch vectors
    const Vector xaxis(1,0,0);
    const Vector pU = pitU*xaxis.cross(wU);
    const Vector pV = pitV*xaxis.cross(wV);
    const Vector pW = pitW*xaxis.cross(wW);

    // The offset in the pitch direction from the center to a wire
    double offU = get<double>(cfg, "offset_mm.u")*units::mm;
    double offV = get<double>(cfg, "offset_mm.v")*units::mm;
    double offW = get<double>(cfg, "offset_mm.w")*units::mm;

    Point oU = center + pU.norm() * offU;
    Point oV = center + pV.norm() * offV;
    Point oW = center + pW.norm() * offW;

    // Force X location of plane along the X axis.
    oU.x(get<double>(cfg, "plane_mm.u")*units::mm);
    oV.x(get<double>(cfg, "plane_mm.v")*units::mm);
    oW.x(get<double>(cfg, "plane_mm.w")*units::mm);


    const Ray bounds(bbmin, bbmax);
    const Ray U(oU, oU+pU), V(oV, oV+pV), W(oW, oW+pW);
    this->set(bounds, U, V, W);
}

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.

{
    std::string json = R"(
{
"center_mm":{"x":0.0, "y":0.0, "z":0.0},
"size_mm":{"x":10.0, "y":1000.0, "z":1000.0},
"pitch_mm":{"u":3.0, "v":3.0, "w":3.0},
"angle_deg":{"u":60.0, "v":-60.0, "w":0.0},
"offset_mm":{"u":0.0, "v":0.0, "w":0.0},
"plane_mm":{"u":3.0, "v":2.0, "w":1.0}
}
)";
    return Persist::loads(json);
}

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.

{ return m_pitchU; }

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.

{ return m_pitchV; }

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.

{ return m_pitchW; }

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.

{
    // save for posterity
    m_bounds = bounds;
    m_pitchU = U;
    m_pitchV = V;
    m_pitchW = W;
}

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,dz	are the full widths of the bounding box in the associated direction.
pitch	is the perpendicular distance between two adjacent wires in a plane.
angle	is the absolute angular distance from the U and V wires and the Y-axis.

Member Data Documentation

Ray WireCell::WireParams::m_bounds

private

Definition at line 71 of file WireParams.h.

Ray WireCell::WireParams::m_pitchU

private

Definition at line 71 of file WireParams.h.

Ray WireCell::WireParams::m_pitchV

private

Definition at line 71 of file WireParams.h.

Ray WireCell::WireParams::m_pitchW

private

Definition at line 71 of file WireParams.h.

---

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

• wire-cell-build/gen/inc/WireCellGen/WireParams.h
• wire-cell-build/gen/src/WireParams.cxx