WireCell::Gen::PlaneImpactResponse Class Reference

#include <PlaneImpactResponse.h>

Inheritance diagram for WireCell::Gen::PlaneImpactResponse:

Collaboration diagram for WireCell::Gen::PlaneImpactResponse:

Public Types
typedef std::vector< int >	region_indices_t
typedef std::vector< region_indices_t >	wire_region_indicies_t
Public Types inherited from WireCell::IComponent< IPlaneImpactResponse >
typedef std::shared_ptr< IPlaneImpactResponse >	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...

Public Member Functions
	PlaneImpactResponse (int plane_ident=0, size_t nbins=10000, double tick=0.5 *units::us)
	~PlaneImpactResponse ()
virtual void	configure (const WireCell::Configuration &cfg)
	Accept a configuration. More...
virtual WireCell::Configuration	default_configuration () const
	Optional, override to return a hard-coded default configuration. More...
virtual IImpactResponse::pointer	closest (double relpitch) const
virtual TwoImpactResponses	bounded (double relpitch) const
double	pitch_range () const
double	pitch () const
double	impact () const
int	nwires () const
	The number of wires that span the pitch range. More...
size_t	nbins () const
int	nimp_per_wire () const
	not in the interface More...
const wire_region_indicies_t &	bywire_map () const
std::pair< int, int >	closest_wire_impact (double relpitch) const
Public Member Functions inherited from WireCell::IPlaneImpactResponse
virtual	~IPlaneImpactResponse ()
Public Member Functions inherited from WireCell::IComponent< IPlaneImpactResponse >
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 ()

Detailed Description

Collection of all impact responses for a plane

Definition at line 53 of file PlaneImpactResponse.h.

Member Typedef Documentation

region_indices_t

typedef std::vector<int> WireCell::Gen::PlaneImpactResponse::region_indices_t

Definition at line 99 of file PlaneImpactResponse.h.

wire_region_indicies_t

typedef std::vector<region_indices_t> WireCell::Gen::PlaneImpactResponse::wire_region_indicies_t

Definition at line 100 of file PlaneImpactResponse.h.

Constructor & Destructor Documentation

PlaneImpactResponse()

Gen::PlaneImpactResponse::PlaneImpactResponse	(	int	plane_ident = 0,
		size_t	nbins = 10000,
		double	tick = 0.5*units::us
	)

Create a PlaneImpactResponse.

Field response is assumed to be normalized in units of current.

Pre-amplifier gain and peaking time is that of the FE electronics. The preamp gain should be in units consistent with the field response. If 0.0 then no electronics response will be convolved.

A flat post-FEE amplifier gain can also be given to provide a global scaling of the output of the electronics.

Fixme: field response should be provided by a component.

Definition at line 34 of file PlaneImpactResponse.cxx.

~PlaneImpactResponse()

Gen::PlaneImpactResponse::~PlaneImpactResponse

(

)

Definition at line 253 of file PlaneImpactResponse.cxx.

Member Function Documentation

bounded()

TwoImpactResponses Gen::PlaneImpactResponse::bounded ( double  relpitch ) const

virtual

Return the two responses which are associated with the impact positions on either side of the given pitch location (measured relative to the wire of interest).

Implements WireCell::IPlaneImpactResponse.

Definition at line 302 of file PlaneImpactResponse.cxx.

Here is the call graph for this function:

bywire_map()

const wire_region_indicies_t& WireCell::Gen::PlaneImpactResponse::bywire_map ( ) const

inline

Definition at line 101 of file PlaneImpactResponse.h.

closest()

IImpactResponse::pointer Gen::PlaneImpactResponse::closest ( double  relpitch ) const

virtual

Return the response at the impact position closest to the given relative pitch location (measured relative to the wire of interest).

Implements WireCell::IPlaneImpactResponse.

Definition at line 275 of file PlaneImpactResponse.cxx.

Here is the call graph for this function:

closest_wire_impact()

std::pair< int, int > Gen::PlaneImpactResponse::closest_wire_impact

(

double

relpitch

)

const

Definition at line 262 of file PlaneImpactResponse.cxx.

Here is the call graph for this function:

Here is the caller graph for this function:

configure()

void Gen::PlaneImpactResponse::configure ( const WireCell::Configuration &  config )

virtual

Accept a configuration.

Implements WireCell::IConfigurable.

Definition at line 64 of file PlaneImpactResponse.cxx.

Here is the call graph for this function:

default_configuration()

WireCell::Configuration Gen::PlaneImpactResponse::default_configuration ( ) const

virtual

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

Reimplemented from WireCell::IConfigurable.

Definition at line 44 of file PlaneImpactResponse.cxx.

impact()

double WireCell::Gen::PlaneImpactResponse::impact ( ) const

inlinevirtual

Implements WireCell::IPlaneImpactResponse.

Definition at line 91 of file PlaneImpactResponse.h.

nbins()

size_t WireCell::Gen::PlaneImpactResponse::nbins ( ) const

inlinevirtual

Implements WireCell::IPlaneImpactResponse.

Definition at line 95 of file PlaneImpactResponse.h.

nimp_per_wire()

int WireCell::Gen::PlaneImpactResponse::nimp_per_wire ( ) const

inline

not in the interface

Definition at line 98 of file PlaneImpactResponse.h.

Here is the caller graph for this function:

nwires()

int WireCell::Gen::PlaneImpactResponse::nwires ( ) const

inlinevirtual

The number of wires that span the pitch range.

Implements WireCell::IPlaneImpactResponse.

Definition at line 93 of file PlaneImpactResponse.h.

Here is the caller graph for this function:

pitch()

double WireCell::Gen::PlaneImpactResponse::pitch ( ) const

inlinevirtual

Implements WireCell::IPlaneImpactResponse.

Definition at line 90 of file PlaneImpactResponse.h.

pitch_range()

double WireCell::Gen::PlaneImpactResponse::pitch_range ( ) const

inlinevirtual

The extent in pitch covered by the impact positions. This extent is relative to and centered on the "wire of interest" for which the PIR is associated.

Implements WireCell::IPlaneImpactResponse.

Definition at line 89 of file PlaneImpactResponse.h.

---

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

• gen/inc/WireCellGen/PlaneImpactResponse.h
• gen/src/PlaneImpactResponse.cxx