wirecell.sigproc.response.ResponseFunction Class Reference

Inheritance diagram for wirecell.sigproc.response.ResponseFunction:

Public Member Functions
def	__init__ (self, plane, region, pos, domainls, response, impact=None)
def	__call__ (self, time)
def	resample (self, nbins)
def	dup (self, kwds)
def	nbins (self)
def	asdict (self)
def	shaped (self, gain=14 *units.mV/units.fC, shaping=2.0 *units.us, nbins=None)
def	__str__ (self)

Public Attributes
	plane
	region
	pos
	domainls
	response
	times
	impact

Detailed Description

A response function object holds the response wave function and metadata.

Note: time is assumed to be in Wire Cell system of units (ns).  This is NOT seconds.

Definition at line 88 of file __init__.py.

Constructor & Destructor Documentation

def wirecell.sigproc.response.ResponseFunction.__init__	(		self,
			plane,
			region,
			pos,
			domainls,
			response,
			impact = None
	)

Definition at line 94 of file __init__.py.

    def __init__(self, plane, region, pos, domainls, response, impact=None):
        plane = plane.lower()
        assert plane in 'uvw'
        self.plane = plane
        self.region = region
        self.pos = tuple(pos)
        self.domainls = domainls
        self.response = response
        self.times = numpy.linspace(*self.domainls)
        self.impact = impact

Member Function Documentation

def wirecell.sigproc.response.ResponseFunction.__call__	(		self,
			time
	)

Definition at line 106 of file __init__.py.

    def __call__(self, time):
        return numpy.interp(time, self.times, self.response)

def wirecell.sigproc.response.ResponseFunction.__str__

(

self

)

Definition at line 153 of file __init__.py.

    def __str__(self):
        blah = "<ResponseFunction plane=%s region=%d domainls=%s pos=%s" % \
               (self.plane, self.region, self.domainls, self.pos)
        if self.impact is not None:
            blah += " impact=%f" % self.impact
        blah += ">"
        return blah

def wirecell.sigproc.response.ResponseFunction.asdict

(

self

)

Object as a dictionary.

Definition at line 127 of file __init__.py.

    def asdict(self):
        '''
        Object as a dictionary.
        '''
        return dict(plane=self.plane, region=self.region, pos=self.pos,
                    domainls=self.domainls, response=self.response.tolist(),
                    impact=self.impact)

def wirecell.sigproc.response.ResponseFunction.dup	(		self,
			kwds
	)

Return a new ResponseFunction which is a copy of this one and
with any values in kwds overriding.

Definition at line 115 of file __init__.py.

    def dup(self, **kwds):
        '''
        Return a new ResponseFunction which is a copy of this one and
        with any values in kwds overriding.
        '''
        return ResponseFunction(**dict(self.asdict, **kwds))

def wirecell.sigproc.response.ResponseFunction.nbins

(

self

)

Definition at line 123 of file __init__.py.

    def nbins(self):
        return self.domainls[2]

def wirecell.sigproc.response.ResponseFunction.resample	(		self,
			nbins
	)

Definition at line 109 of file __init__.py.

    def resample(self, nbins):
        newls = (self.times[0], self.times[-1], nbins)
        newtimes = numpy.linspace(*newls)
        newresps = numpy.interp(newtimes, self.times, self.response)
        return self.dup(domainls=newls, response=newresps)

def wirecell.sigproc.response.ResponseFunction.shaped	(		self,
			gain = 14*units.mV/units.fC,
			shaping = 2.0*units.us,
			nbins = None
	)

Convolve electronics shaping/peaking response, returning a new
ResponseFunction.

Definition at line 135 of file __init__.py.

    def shaped(self, gain=14*units.mV/units.fC, shaping=2.0*units.us, nbins=None):
        '''
        Convolve electronics shaping/peaking response, returning a new
        ResponseFunction.
        '''
        # use version defined above
        # from scipy.signal import fftconvolve
        if nbins is None:
            newfr = self.dup()
        else:
            newfr = self.resample(nbins)
        # integrate the current over the sample to get charge
        dt = newfr.times[1]-newfr.times[0]
        newfr.response = [r*dt for r in newfr.response]
        elecr = electronics(newfr.times, gain, shaping)
        newfr.response = convolve(elecr, newfr.response)
        return newfr

Member Data Documentation

wirecell.sigproc.response.ResponseFunction.domainls

Definition at line 100 of file __init__.py.

wirecell.sigproc.response.ResponseFunction.impact

Definition at line 103 of file __init__.py.

wirecell.sigproc.response.ResponseFunction.plane

Definition at line 97 of file __init__.py.

wirecell.sigproc.response.ResponseFunction.pos

Definition at line 99 of file __init__.py.

wirecell.sigproc.response.ResponseFunction.region

Definition at line 98 of file __init__.py.

wirecell.sigproc.response.ResponseFunction.response

Definition at line 101 of file __init__.py.

wirecell.sigproc.response.ResponseFunction.times

Definition at line 102 of file __init__.py.

---

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

• wire-cell-build/python/wirecell/sigproc/response/__init__.py