Some Wire-Cell documents

This area holds some informal notes and presentations related to various aspects of Wire-Cell.

1. Technical Notes

These notes are mostly made as renderings of text files (in .org markup) provided in the WCT source. The primary render format is PDF with some also in HTML. HTML may lack some images or otherwise render sub-optimally.

1.1. Concepts, algorithms and data structures

raygrid.pdf
Description of the WCT "ray grid" based implementation of the titular "Wire-Cell tomographic inversion algorithm" including a walked through example. It also describes solving for blob charge, basic clustering and the resulting ICluster structure used for WCT 3D imaging stages.
sim-conv-down.pdf
Method for simultaneously convolving and downsampling. WCT sim upgrades to this method from inferior decimate-then-convolve for the \(FR \otimes ER\) convolution. Also as HTML. This became the "method" section of the LMN Resampling paper (links tbd).
nary-tree-node.pdf
A WCT note on the n-ary tree data structure.
doctest-pointtree-example.pdf
Description of point cloud trees with code examples.
depofluxsplat.pdf
Convert ionization electrons (depos) directly to signal-like ("true'ish") waveforms. Also in HTML.
pgraph.pdf
How to configure WCT data flow graphs (incomplete). Also in HTML.
noise-aux.pdf
WCT noise models. Also in HTML (also note specific to sim PDF and HTML).
tensor-data-model.pdf
The WCT "tensor data model" defines array-centric representations of various complex WCT data structures. Also in HTML.
BlobDepoFill.pdf
Describes the technique to replace blob charge with "true" charge. Also HTML.
blob-sampling.pdf
How blobs are sampled to produce point clouds. Also HTML.

1.2. Implementation details

logging.pdf
notes on how logging works with WCT, also in HTML.
wct-x-planes.pdf
Description of certain planes along the X axis that are important to WCT simulation, signal processing and depo flux waveforms.
depofluxwriter.pdf
Description of the DepoFluxWriter WCT component provided by the larwirecell package in LArSoft. See also depofluxsplat.
signal-bias-eff-vs-dir.pdf
Informal software specification for adding a process to WCT to provide "standard" SP performance metrics as a function of track direction. See also WCT PR #229.
imaging-overview.pdf
notes on the internals of WCT 3D imaging parts, also in HTML.
field-response-data.pdf
notes on one way to make a WCT field response file from output produced by GARFIELD.
ClusterArrays.pdf
Representation of ICluster in an array-based form. Includes the three types of file representation (cluster graph JSON, cluster array Numpy and cluster tensor JSON+Numpy). Note: these file formats are intended for use by experts for developing and debugging WCT and not intended for use by end-users. Also in HTML
frame-files.pdf
Note on WCT "frame files" which store IFrame as a set of .npy files in an archive (.zip/.npz or .tar.{gz,bz2}). Also HTML.
frame-tensor.pdf
Note on WCT "frame tensor files" which store IFrame in the WCT tensor data model.
cluster-shadow.pdf
Brief note on the cluster shadow algorithm and implementation.

1.3. Ecosystem

WCWC
the Wire-Cell workstation cluster documents

2. Presentations

2.1. Concepts

basics.pdf
Presentations of architectural aspects. Covers interfaces and their component implementations, the data flow graph and programming (configuration) paradigm, WCT applications, packaging, plugins, logging, configuration, etc.
config.pdf
Presentations of architectural aspects focusing on WCT configuration.
Point Clouds
Basic concepts of WCT point clouds
Noise
Noise modeling and generation.
fullchain.pdf
Essentially one slide giving a diagram that places WCT in the context of a "full chain" of DUNE processing. Though, it is still but one facet and not a whole picture.
Multi threading workshop
The WCT talk at the LArSoft Multi-threading and Acceleration Workshop. It describes how WCT uses multi-threading in the data flow programming paradigm and describes how WCT is integrated to art/larsoft. It also gives some strategies to exploit MT, in particular for DUNE scale, though it is generally accepted that it is better to exploit per-APA file streams and single-threaded, low-RAM jobs.
Framework workshop
The DUNE talk at the Fermilab Frameworks Workshop. This goes through scenarios for the DUNE processing stages showing high-level file-based flow. A lot of these ideas were put into a DUNE first stage processing use cases document developed as part of the DUNE framework task force.

2.2. Details

PC Tree speedup
Opimized representation of PC tree in tensor data model.

3. Elsewhere

https://wirecell.bnl.gov/
official home page for Wire-Cell Toolkit.
https://wirecell.bnl.gov/README.html
many of the PDF/HTML docs served here are available rendered in-source in a document tree defined via README.org files.

Created: 2024-09-04 Wed 16:16

Validate