wirecell.util.wires.apa.Description Class Reference

Inheritance diagram for wirecell.util.wires.apa.Description:

Public Member Functions
def	__init__ (self, params=default_params)
def	wire_index_by_wip (self, face, plane, wip)
def	iconductor_by_face_plane_spot (self, face, plane_in_face, spot_in_plane)
def	iconductor_chip_chan (self, face, board_in_face, layer_in_face, wire_spot_in_layer)
def	iface_board (self, iboard)
def	iplane (self, iface, plane_in_face)

Public Attributes
	p
	nfaces
	nplanes
	nwibs
	nboards
	nchips
	nchannels
	nconductors
	iboard_by_face_board
	iboard_by_conn_slot
	ichip_by_face_board_chip
	iconductor_by_face_board_chip_chan
	ccls
	nch_in_board_by_layer
	points
	wires_by_face_plane
	wires ### More...
	nwires_by_plane
	nwires_per_face
	nwires
	npoints

Detailed Description

Provide data methods to describe an APA and enumerate its connectivity.

Definition at line 120 of file apa.py.

Constructor & Destructor Documentation

def wirecell.util.wires.apa.Description.__init__	(		self,
			params = default_params
	)

Definition at line 124 of file apa.py.

    def __init__(self,  params = default_params):
        self.p = params

        # Total numbers of things in one APA.
        # Some of this is just a copy in order to present a flat namespace
        self.nfaces = self.p.nfaces
        self.nplanes = self.nfaces * self.p.face.nlayers
        self.nwibs = self.p.daq.nwibs
        self.nboards = self.p.face.nboards*self.nfaces
        self.nchips = self.nboards * self.p.board.nchips
        self.nchannels = self.nchips*self.p.board.nchanperchip
        self.nconductors = self.nchannels
        #self.nwires, see below 

        # List of indicies to boards in two ways: [face,board] and WIB
        # [conn,slot].  A very smart layout convention adopted by the
        # engineers let us do this so cleanly!
        bi = numpy.array(range(self.nboards))
        self.iboard_by_face_board = bi.reshape(self.p.nfaces, self.p.face.nboards)
        self.iboard_by_conn_slot = bi.reshape(self.p.daq.nconnperwib, self.p.daq.nwibs)

        # List of indices to chips, accessed by [face,board_in_face,chip_on_board]
        ci = numpy.array(range(self.nchips))
        self.ichip_by_face_board_chip = ci.reshape(self.p.nfaces, self.p.face.nboards, self.p.board.nchips)


        # List of indices to  all conductors (or all channels) in an APA
        # accessed by [face, board_in_face, chip_in_board, chan_in_chip]
        # nominal: 2x10x8x16
        ci = numpy.array(range(self.nchannels))
        self.iconductor_by_face_board_chip_chan = ci.reshape(self.p.nfaces, self.p.face.nboards,
                                                             self.p.board.nchips, self.p.board.nchanperchip)

        # Flattened (layer-conductor)->(chip,channel) dictionary
        self.ccls = flatten_cclsm()
        counter = Counter()
        for k,v in self.ccls:
            counter[k[0]] += 1
        # nominal: (40,40,48)
        self.nch_in_board_by_layer = tuple([kv[1] for kv in sorted(counter.items())])


        self.points = list()

        ### wires ###
        #
        # Caution: wires are a bit tricky.  While each wire is
        # physically unique, each also shares a conceptual twin on the
        # other side of the APA, given rotational symmetry about the Y
        # axis.  These twins share the same points but these points
        # are expressed in two different coordinate systems, one for
        # each face!  When drawing a 2D representation of wires using
        # these points a rotation must be taken into account.
        self.wires_by_face_plane = [list(), list()]
        for iplane, geom in enumerate(self.p.geom):
            rect = generator.Rectangle(geom.width, geom.height)
            # (ap, side, spot, seg, p1, p2)
            raw_wires = generator.wrapped_from_top_oneside(geom.offset, geom.angle, geom.pitch, rect)
            raw_wires.sort()
            gwires_front = list()
            gwires_back = list()
            for wip, raw_wire in enumerate(raw_wires):
                ap, side, spot, seg, zy1, zy2 = raw_wire
                ip1 = len(self.points)
                p1 = GeomPoint(geom.planex, zy1[1], zy1[0])
                self.points.append(p1)
                ip2 = len(self.points)
                p2 = GeomPoint(geom.planex, zy2[1], zy2[0])
                self.points.append(p2)
                wf = GeomWire(ap, wip, spot, seg, ip1, ip2)
                wb = GeomWire(ap, wip, spot, seg, ip1, ip2)
                gwires_front.append(wf)
                gwires_back.append(wb)
            self.wires_by_face_plane[0].append(gwires_front)
            self.wires_by_face_plane[1].append(gwires_back)

        self.nwires_by_plane = [len(l) for l in self.wires_by_face_plane[0]]
        self.nwires_per_face = sum(self.nwires_by_plane)
        self.nwires = self.nfaces * self.nwires_per_face
        self.npoints = len(self.points)

Member Function Documentation

def wirecell.util.wires.apa.Description.iconductor_by_face_plane_spot	(		self,
			face,
			plane_in_face,
			spot_in_plane
	)

Return the global conductor index based on the face, plane and spot.

Definition at line 213 of file apa.py.

    def iconductor_by_face_plane_spot(self, face, plane_in_face, spot_in_plane):
        '''
        Return the global conductor index based on the face, plane and spot.
        '''
        nch = self.nch_in_board_by_layer[plane_in_face] # 40,40,48
        board_in_face = spot_in_plane//nch
        spot_in_layer = spot_in_plane%nch
        return self.iconductor_chip_chan(face, board_in_face, plane_in_face, spot_in_layer)[0]

def wirecell.util.wires.apa.Description.iconductor_chip_chan	(		self,
			face,
			board_in_face,
			layer_in_face,
			wire_spot_in_layer
	)

Given the paramers return information about the associated
conductor as a triple:

    - iconductor :: the apa-global index for the conductor

    - chip :: the board-local index for the chip

    - chan :: the chip-local index for the channel

Definition at line 223 of file apa.py.

    def iconductor_chip_chan(self, face, board_in_face, layer_in_face, wire_spot_in_layer):
        '''
        Given the paramers return information about the associated
        conductor as a triple:

            - iconductor :: the apa-global index for the conductor

            - chip :: the board-local index for the chip

            - chan :: the chip-local index for the channel
        '''
        # must +1 the spot to match the matrix assumption
        nchip,nch = self.ccls[("uvw"[layer_in_face], wire_spot_in_layer+1)]
        # must -1 the returns to match our assumption
        ichip,ich = nchip-1, nch-1
        icond = self.iconductor_by_face_board_chip_chan[face, board_in_face, ichip, ich]
        return (icond, ichip, ich)

def wirecell.util.wires.apa.Description.iface_board	(		self,
			iboard
	)

Given a global board index, return tuple of:

- iface :: the apa-global face index
- board : the face-local board index

Definition at line 241 of file apa.py.

    def iface_board(self, iboard):
        '''
        Given a global board index, return tuple of:

        - iface :: the apa-global face index
        - board : the face-local board index
        '''
        if not iboard in range(self.nboards):
            raise ValueError("iboard is out of range: %d" % iboard)
        iface = iboard//self.p.face.nboards
        board = iboard%self.p.face.nboards
        return (iface,board)

def wirecell.util.wires.apa.Description.iplane	(		self,
			iface,
			plane_in_face
	)

Definition at line 254 of file apa.py.

    def iplane(self, iface, plane_in_face):
        'Return global plane index given global face and plane in face'
        # trivial...
        return iface*self.p.face.nlayers + plane_in_face

    

def wirecell.util.wires.apa.Description.wire_index_by_wip	(		self,
			face,
			plane,
			wip
	)

Return a tuple of a global wire index and the gwire

Definition at line 205 of file apa.py.

    def wire_index_by_wip(self, face, plane, wip):
        '''
        Return a tuple of a global wire index and the gwire
        '''
        index = face*self.nwires_per_face + sum(self.nwires_by_plane[:plane]) + wip
        wire = self.wires_by_face_plane[face][plane][wip]
        return (index,wire)

Member Data Documentation

wirecell.util.wires.apa.Description.ccls

Definition at line 158 of file apa.py.

wirecell.util.wires.apa.Description.iboard_by_conn_slot

Definition at line 143 of file apa.py.

wirecell.util.wires.apa.Description.iboard_by_face_board

Definition at line 142 of file apa.py.

wirecell.util.wires.apa.Description.ichip_by_face_board_chip

Definition at line 147 of file apa.py.

wirecell.util.wires.apa.Description.iconductor_by_face_board_chip_chan

Definition at line 154 of file apa.py.

wirecell.util.wires.apa.Description.nboards

Definition at line 132 of file apa.py.

wirecell.util.wires.apa.Description.nch_in_board_by_layer

Definition at line 163 of file apa.py.

wirecell.util.wires.apa.Description.nchannels

Definition at line 134 of file apa.py.

wirecell.util.wires.apa.Description.nchips

Definition at line 133 of file apa.py.

wirecell.util.wires.apa.Description.nconductors

Definition at line 135 of file apa.py.

wirecell.util.wires.apa.Description.nfaces

Definition at line 129 of file apa.py.

wirecell.util.wires.apa.Description.nplanes

Definition at line 130 of file apa.py.

wirecell.util.wires.apa.Description.npoints

Definition at line 203 of file apa.py.

wirecell.util.wires.apa.Description.nwibs

Definition at line 131 of file apa.py.

wirecell.util.wires.apa.Description.nwires

Definition at line 202 of file apa.py.

wirecell.util.wires.apa.Description.nwires_by_plane

Definition at line 200 of file apa.py.

wirecell.util.wires.apa.Description.nwires_per_face

Definition at line 201 of file apa.py.

wirecell.util.wires.apa.Description.p

Definition at line 125 of file apa.py.

wirecell.util.wires.apa.Description.points

Definition at line 166 of file apa.py.

wirecell.util.wires.apa.Description.wires_by_face_plane

wires ###

Caution: wires are a bit tricky. While each wire is physically unique, each also shares a conceptual twin on the other side of the APA, given rotational symmetry about the Y axis. These twins share the same points but these points are expressed in two different coordinate systems, one for each face! When drawing a 2D representation of wires using these points a rotation must be taken into account.

Definition at line 177 of file apa.py.

---

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

• wire-cell-build/python/wirecell/util/wires/apa.py