From f0c776c62ba436a253f8a2331ff39420957da20b Mon Sep 17 00:00:00 2001
From: "Documenter.jl" <documenter@juliadocs.github.io>
Date: Mon, 9 Oct 2023 12:12:59 +0000
Subject: [PATCH] build based on 434d86d
---
dev/.documenter-siteinfo.json | 2 +-
dev/fit/index.html | 22 +++++++++++-----------
dev/hits/index.html | 32 ++++++++++++++++----------------
3 files changed, 28 insertions(+), 28 deletions(-)
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json
index 6cdb865..1158c35 100644
--- a/dev/.documenter-siteinfo.json
+++ b/dev/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.9.1","generation_timestamp":"2023-10-09T12:12:32","documenter_version":"1.1.0"}}
\ No newline at end of file
+{"documenter":{"julia_version":"1.9.1","generation_timestamp":"2023-10-09T12:12:55","documenter_version":"1.1.0"}}
\ No newline at end of file
diff --git a/dev/fit/index.html b/dev/fit/index.html
index 824f139..86e395a 100644
--- a/dev/fit/index.html
+++ b/dev/fit/index.html
@@ -1,10 +1,10 @@
<!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>ROyFit · NeRCA.jl</title><meta name="title" content="ROyFit · NeRCA.jl"/><meta property="og:title" content="ROyFit · NeRCA.jl"/><meta property="twitter:title" content="ROyFit · NeRCA.jl"/><meta name="description" content="Documentation for NeRCA.jl."/><meta property="og:description" content="Documentation for NeRCA.jl."/><meta property="twitter:description" content="Documentation for NeRCA.jl."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script><link href="../assets/custom.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../io/">I/O</a></li><li><a class="tocitem" href="../hits/">Hits</a></li><li class="is-active"><a class="tocitem" href>ROyFit</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>ROyFit</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>ROyFit</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://git.km3net.de/tgal/NeRCA.jl" title="View the repository"><span class="docs-icon fa-brands">ï¡</span><span class="docs-label is-hidden-touch">Repository</span></a><a class="docs-navbar-link" href="https://git.km3net.de/tgal/NeRCA.jl/blob/master/docs/src/fit.md#L" title="Edit source"><span class="docs-icon fa-solid">ï„</span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="ROyFit"><a class="docs-heading-anchor" href="#ROyFit">ROyFit</a><a id="ROyFit-1"></a><a class="docs-heading-anchor-permalink" href="#ROyFit" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.DirectionSet" href="#NeRCA.DirectionSet"><code>NeRCA.DirectionSet</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct DirectionSet</code></pre><p>A container of directions with additionial information about their median angular separation.</p><p><strong>Fields</strong></p><ul><li><p><code>directions::Vector{Direction{Float64}}</code></p></li><li><p><code>angular_separation::Float64</code></p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/scanfit.jl#LL14">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.Line1Z" href="#NeRCA.Line1Z"><code>NeRCA.Line1Z</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct Line1Z <: NeRCA.EstimatorModel</code></pre><p>A straight line parallel to the z-axis.</p><p><strong>Fields</strong></p><ul><li><p><code>pos::Position{Float64}</code></p></li><li><p><code>t::Float64</code></p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/scanfit.jl#LL117">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.MuonScanfit-Tuple{KM3io.DAQEvent}" href="#NeRCA.MuonScanfit-Tuple{KM3io.DAQEvent}"><code>NeRCA.MuonScanfit</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Performs a Muon track fit for a given event.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/scanfit.jl#LL40">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.MuonScanfit-Union{Tuple{Vector{T}}, Tuple{T}} where T<:KM3io.AbstractHit" href="#NeRCA.MuonScanfit-Union{Tuple{Vector{T}}, Tuple{T}} where T<:KM3io.AbstractHit"><code>NeRCA.MuonScanfit</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Performs a Muon track fit for a given set of hits (usually snapshot hits).</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/scanfit.jl#LL45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.XYTSolver" href="#NeRCA.XYTSolver"><code>NeRCA.XYTSolver</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct XYTSolver</code></pre><p>A task worker whichs solves for x, y an t for a given set of hits and a direction.</p><p><strong>Fields</strong></p><ul><li><p><code>hits_buffer::Vector{HitR1}</code></p></li><li><p><code>covmatrix::NeRCA.CovMatrix</code></p></li><li><p><code>timeresvec::Vector{Float64}</code></p></li><li><p><code>nmaxhits::Int64</code></p></li><li><p><code>matcher::Match1D</code></p></li><li><p><code>est::Line1ZEstimator</code></p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/scanfit.jl#LL347">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.Libc.time-Tuple{Line1Z, Position}" href="#Base.Libc.time-Tuple{Line1Z, Position}"><code>Base.Libc.time</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">time(lz::Line1Z, pos::Position) -> Any
-</code></pre><p>Calculate the Chernkov arrival tive for a given position.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/scanfit.jl#LL132">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.dumandfit-Union{Tuple{Vector{T}}, Tuple{T}} where T<:KM3io.AbstractCalibratedHit" href="#NeRCA.dumandfit-Union{Tuple{Vector{T}}, Tuple{T}} where T<:KM3io.AbstractCalibratedHit"><code>NeRCA.dumandfit</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">dumandfit(
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>ROyFit · NeRCA.jl</title><meta name="title" content="ROyFit · NeRCA.jl"/><meta property="og:title" content="ROyFit · NeRCA.jl"/><meta property="twitter:title" content="ROyFit · NeRCA.jl"/><meta name="description" content="Documentation for NeRCA.jl."/><meta property="og:description" content="Documentation for NeRCA.jl."/><meta property="twitter:description" content="Documentation for NeRCA.jl."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script><link href="../assets/custom.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../io/">I/O</a></li><li><a class="tocitem" href="../hits/">Hits</a></li><li class="is-active"><a class="tocitem" href>ROyFit</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>ROyFit</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>ROyFit</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://git.km3net.de/tgal/NeRCA.jl" title="View the repository"><span class="docs-icon fa-brands">ï¡</span><span class="docs-label is-hidden-touch">Repository</span></a><a class="docs-navbar-link" href="https://git.km3net.de/tgal/NeRCA.jl/blob/master/docs/src/fit.md#L" title="Edit source"><span class="docs-icon fa-solid">ï„</span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="ROyFit"><a class="docs-heading-anchor" href="#ROyFit">ROyFit</a><a id="ROyFit-1"></a><a class="docs-heading-anchor-permalink" href="#ROyFit" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.DirectionSet" href="#NeRCA.DirectionSet"><code>NeRCA.DirectionSet</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct DirectionSet</code></pre><p>A container of directions with additionial information about their median angular separation.</p><p><strong>Fields</strong></p><ul><li><p><code>directions::Vector{Direction{Float64}}</code></p></li><li><p><code>angular_separation::Float64</code></p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/scanfit.jl#LL14">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.Line1Z" href="#NeRCA.Line1Z"><code>NeRCA.Line1Z</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct Line1Z <: NeRCA.EstimatorModel</code></pre><p>A straight line parallel to the z-axis.</p><p><strong>Fields</strong></p><ul><li><p><code>pos::Position{Float64}</code></p></li><li><p><code>t::Float64</code></p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/scanfit.jl#LL117">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.MuonScanfit-Tuple{KM3io.DAQEvent}" href="#NeRCA.MuonScanfit-Tuple{KM3io.DAQEvent}"><code>NeRCA.MuonScanfit</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Performs a Muon track fit for a given event.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/scanfit.jl#LL40">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.MuonScanfit-Union{Tuple{Vector{T}}, Tuple{T}} where T<:KM3io.AbstractHit" href="#NeRCA.MuonScanfit-Union{Tuple{Vector{T}}, Tuple{T}} where T<:KM3io.AbstractHit"><code>NeRCA.MuonScanfit</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Performs a Muon track fit for a given set of hits (usually snapshot hits).</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/scanfit.jl#LL45">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.XYTSolver" href="#NeRCA.XYTSolver"><code>NeRCA.XYTSolver</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct XYTSolver</code></pre><p>A task worker whichs solves for x, y an t for a given set of hits and a direction.</p><p><strong>Fields</strong></p><ul><li><p><code>hits_buffer::Vector{HitR1}</code></p></li><li><p><code>covmatrix::NeRCA.CovMatrix</code></p></li><li><p><code>timeresvec::Vector{Float64}</code></p></li><li><p><code>nmaxhits::Int64</code></p></li><li><p><code>matcher::Match1D</code></p></li><li><p><code>est::Line1ZEstimator</code></p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/scanfit.jl#LL347">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Base.Libc.time-Tuple{Line1Z, Position}" href="#Base.Libc.time-Tuple{Line1Z, Position}"><code>Base.Libc.time</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">time(lz::Line1Z, pos::Position) -> Any
+</code></pre><p>Calculate the Chernkov arrival tive for a given position.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/scanfit.jl#LL132">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.dumandfit-Union{Tuple{Vector{T}}, Tuple{T}} where T<:KM3io.AbstractCalibratedHit" href="#NeRCA.dumandfit-Union{Tuple{Vector{T}}, Tuple{T}} where T<:KM3io.AbstractCalibratedHit"><code>NeRCA.dumandfit</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">dumandfit(
hits::Array{T<:KM3io.AbstractCalibratedHit, 1}
) -> KM3io.Track
-</code></pre><p>Performs the prefit algorithm which was used in DUMAND II.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/dumandfit.jl#LL1">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.invert!-Tuple{Any, Any}" href="#NeRCA.invert!-Tuple{Any, Any}"><code>NeRCA.invert!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">invert!(V, precision) -> Any
-</code></pre><p>Invert matrix in-place with a given precision (clamps eigenvalues to 0 below that).</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/scanfit.jl#LL252">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.make_cherenkov_calculator-NTuple{5, Any}" href="#NeRCA.make_cherenkov_calculator-NTuple{5, Any}"><code>NeRCA.make_cherenkov_calculator</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">make_cherenkov_calculator(
+</code></pre><p>Performs the prefit algorithm which was used in DUMAND II.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/dumandfit.jl#LL1">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.invert!-Tuple{Any, Any}" href="#NeRCA.invert!-Tuple{Any, Any}"><code>NeRCA.invert!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">invert!(V, precision) -> Any
+</code></pre><p>Invert matrix in-place with a given precision (clamps eigenvalues to 0 below that).</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/scanfit.jl#LL252">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.make_cherenkov_calculator-NTuple{5, Any}" href="#NeRCA.make_cherenkov_calculator-NTuple{5, Any}"><code>NeRCA.make_cherenkov_calculator</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">make_cherenkov_calculator(
d_closest,
t_closest,
z_closest,
@@ -12,17 +12,17 @@
tâ‚€;
n
) -> Tuple{NeRCA.var"#d_γ#34"{Float64}, NeRCA.var"#t#35"{Float64, _A, _B, _C, _D, Float64} where {_A, _B, _C, _D}}
-</code></pre><p>Returns a function which calculates the arrival time of a Cherenkov photon at a given position.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/royfit.jl#LL62">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.make_cherenkov_calculator-Tuple{KM3io.Track}" href="#NeRCA.make_cherenkov_calculator-Tuple{KM3io.Track}"><code>NeRCA.make_cherenkov_calculator</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">make_cherenkov_calculator(track::KM3io.Track; v, n)
-</code></pre><p>Returns a function which calculates the arrival time of a Cherenkov photon at a given position.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/royfit.jl#LL29">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.make_cherenkov_calculator-Tuple{SingleDUParams}" href="#NeRCA.make_cherenkov_calculator-Tuple{SingleDUParams}"><code>NeRCA.make_cherenkov_calculator</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">make_cherenkov_calculator(
+</code></pre><p>Returns a function which calculates the arrival time of a Cherenkov photon at a given position.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/royfit.jl#LL62">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.make_cherenkov_calculator-Tuple{KM3io.Track}" href="#NeRCA.make_cherenkov_calculator-Tuple{KM3io.Track}"><code>NeRCA.make_cherenkov_calculator</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">make_cherenkov_calculator(track::KM3io.Track; v, n)
+</code></pre><p>Returns a function which calculates the arrival time of a Cherenkov photon at a given position.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/royfit.jl#LL29">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.make_cherenkov_calculator-Tuple{SingleDUParams}" href="#NeRCA.make_cherenkov_calculator-Tuple{SingleDUParams}"><code>NeRCA.make_cherenkov_calculator</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">make_cherenkov_calculator(
sdp::SingleDUParams;
n
) -> Tuple{NeRCA.var"#d_γ#37"{Float64, SingleDUParams}, NeRCA.var"#t#38"{Float64, SingleDUParams, NeRCA.var"#d_γ#37"{Float64, SingleDUParams}, Float64}}
-</code></pre><p>Returns a function which calculates the arrival time of a Cherenkov photon at a given position.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/royfit.jl#LL73">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.quality-Tuple{Any, Any, Any}" href="#NeRCA.quality-Tuple{Any, Any, Any}"><code>NeRCA.quality</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">quality(χ², N, NDF) -> Any
-</code></pre><p>The quality of the fit, the larger the better, as used in e.g. Jpp.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/scanfit.jl#LL110">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.scanfit-Union{Tuple{T}, Tuple{MuonScanfitParameters, Vector{T}, NeRCA.DirectionSet}} where T<:NeRCA.AbstractReducedHit" href="#NeRCA.scanfit-Union{Tuple{T}, Tuple{MuonScanfitParameters, Vector{T}, NeRCA.DirectionSet}} where T<:NeRCA.AbstractReducedHit"><code>NeRCA.scanfit</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">scanfit(
+</code></pre><p>Returns a function which calculates the arrival time of a Cherenkov photon at a given position.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/royfit.jl#LL73">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.quality-Tuple{Any, Any, Any}" href="#NeRCA.quality-Tuple{Any, Any, Any}"><code>NeRCA.quality</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">quality(χ², N, NDF) -> Any
+</code></pre><p>The quality of the fit, the larger the better, as used in e.g. Jpp.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/scanfit.jl#LL110">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.scanfit-Union{Tuple{T}, Tuple{MuonScanfitParameters, Vector{T}, NeRCA.DirectionSet}} where T<:NeRCA.AbstractReducedHit" href="#NeRCA.scanfit-Union{Tuple{T}, Tuple{MuonScanfitParameters, Vector{T}, NeRCA.DirectionSet}} where T<:NeRCA.AbstractReducedHit"><code>NeRCA.scanfit</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">scanfit(
params::MuonScanfitParameters,
rhits::Array{T<:NeRCA.AbstractReducedHit, 1},
directionset::NeRCA.DirectionSet
) -> Any
-</code></pre><p>Performs the scanfit for each given direction and returns a <code>Vector{MuonScanfitCandidate}</code> with all successful fits. The resulting vector can be empty if none of the directions had enough hits to perform the algorithm.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/scanfit.jl#LL80">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.select_hits-Tuple{Any, Any}" href="#NeRCA.select_hits-Tuple{Any, Any}"><code>NeRCA.select_hits</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">select_hits(du_hits, hit_pool; Δt₋, Δz, new_hits) -> Any
-</code></pre><p>Returns the seed hits suited for a Cherenkov hit time residual based reconstruction algorithm.</p><p>The <code>du_hits</code> should only contain hits for a single DU. The hit<em>pool holds all other hit candidates (e.g. created by `create</em>hit_pool()<code>).</code>Δt₋<code>is the allowed negative time error for the arrival time,</code>Δz` distance between two floors.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/royfit.jl#LL116">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.single_du_params-Tuple{KM3io.Track}" href="#NeRCA.single_du_params-Tuple{KM3io.Track}"><code>NeRCA.single_du_params</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">single_du_params(track::KM3io.Track)
-</code></pre><p>Calculates five parameters to describe a track for a single DU case.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/royfit.jl#LL86">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../hits/">« Hits</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.0 on <span class="colophon-date" title="Monday 9 October 2023 12:12">Monday 9 October 2023</span>. Using Julia version 1.9.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</code></pre><p>Performs the scanfit for each given direction and returns a <code>Vector{MuonScanfitCandidate}</code> with all successful fits. The resulting vector can be empty if none of the directions had enough hits to perform the algorithm.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/scanfit.jl#LL80">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.select_hits-Tuple{Any, Any}" href="#NeRCA.select_hits-Tuple{Any, Any}"><code>NeRCA.select_hits</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">select_hits(du_hits, hit_pool; Δt₋, Δz, new_hits) -> Any
+</code></pre><p>Returns the seed hits suited for a Cherenkov hit time residual based reconstruction algorithm.</p><p>The <code>du_hits</code> should only contain hits for a single DU. The hit<em>pool holds all other hit candidates (e.g. created by `create</em>hit_pool()<code>).</code>Δt₋<code>is the allowed negative time error for the arrival time,</code>Δz` distance between two floors.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/royfit.jl#LL116">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.single_du_params-Tuple{KM3io.Track}" href="#NeRCA.single_du_params-Tuple{KM3io.Track}"><code>NeRCA.single_du_params</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">single_du_params(track::KM3io.Track)
+</code></pre><p>Calculates five parameters to describe a track for a single DU case.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/royfit.jl#LL86">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../hits/">« Hits</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.0 on <span class="colophon-date" title="Monday 9 October 2023 12:12">Monday 9 October 2023</span>. Using Julia version 1.9.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
diff --git a/dev/hits/index.html b/dev/hits/index.html
index d33c6c0..cfb9bba 100644
--- a/dev/hits/index.html
+++ b/dev/hits/index.html
@@ -1,46 +1,46 @@
<!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Hits · NeRCA.jl</title><meta name="title" content="Hits · NeRCA.jl"/><meta property="og:title" content="Hits · NeRCA.jl"/><meta property="twitter:title" content="Hits · NeRCA.jl"/><meta name="description" content="Documentation for NeRCA.jl."/><meta property="og:description" content="Documentation for NeRCA.jl."/><meta property="twitter:description" content="Documentation for NeRCA.jl."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script><link href="../assets/custom.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../io/">I/O</a></li><li class="is-active"><a class="tocitem" href>Hits</a></li><li><a class="tocitem" href="../fit/">ROyFit</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Hits</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Hits</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://git.km3net.de/tgal/NeRCA.jl" title="View the repository"><span class="docs-icon fa-brands">ï¡</span><span class="docs-label is-hidden-touch">Repository</span></a><a class="docs-navbar-link" href="https://git.km3net.de/tgal/NeRCA.jl/blob/master/docs/src/hits.md#L" title="Edit source"><span class="docs-icon fa-solid">ï„</span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Hits"><a class="docs-heading-anchor" href="#Hits">Hits</a><a id="Hits-1"></a><a class="docs-heading-anchor-permalink" href="#Hits" title="Permalink"></a></h1><p>The hit type hierarchy is currently being redesigned!</p><p><code>NeRCA.jl</code> has three main types of hits: <code>AbstractDAQHit</code>, <code>AbstractMCHit</code> and <code>CalibratedHit</code>.</p><table><tr><th style="text-align: right">hit type</th><th style="text-align: right">supertype</th><th style="text-align: right">guaranteed attributes</th></tr><tr><td style="text-align: right"><code>Hit</code> (in future <code>SnapshotHit</code>)</td><td style="text-align: right"><code>AbstractDAQHit</code></td><td style="text-align: right"><code>channel_id</code>, <code>dom_id</code>, <code>t</code>, <code>tot</code></td></tr><tr><td style="text-align: right"><code>TriggeredHit</code></td><td style="text-align: right"><code>AbstractDAQHit</code></td><td style="text-align: right"><code>channel_id</code>, <code>dom_id</code>, <code>t</code>, <code>tot</code>, <code>trigger_mask</code></td></tr><tr><td style="text-align: right"><code>MCHit</code></td><td style="text-align: right"><code>AbstractMCHit</code></td><td style="text-align: right"><code>a</code>, <code>origin</code>, <code>pmt_id</code>, <code>t</code></td></tr></table><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.Clique" href="#NeRCA.Clique"><code>NeRCA.Clique</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct Clique{T<:NeRCA.AbstractMatcher}</code></pre><p>Clique clusterizer which takes a matcher algorithm like <code>Match3B</code> as input.</p><p><strong>Fields</strong></p><ul><li><p><code>match::NeRCA.AbstractMatcher</code></p></li><li><p><code>weights::Vector{Float64}</code></p></li><li><p><code>times::Vector{Float64}</code></p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/hits.jl#LL590">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.L1Builder-Union{Tuple{H}, Tuple{T}, Tuple{Type{H}, Detector, Vector{T}}} where {T, H}" href="#NeRCA.L1Builder-Union{Tuple{H}, Tuple{T}, Tuple{Type{H}, Detector, Vector{T}}} where {T, H}"><code>NeRCA.L1Builder</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">L1Builder(params) -> L1Builder
-</code></pre><p>Find coincidences within the time window <code>Δt</code> of the initialised <code>params</code>. The return value is a vector of <code>L1Hit</code>s.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/hits.jl#LL356">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.Match1D" href="#NeRCA.Match1D"><code>NeRCA.Match1D</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">mutable struct Match1D <: NeRCA.AbstractMatcher</code></pre><p>Simple Cherenkov matcher for muon signals. The muon is assumed to travel parallel to the Z-axis.</p><p><strong>Fields</strong></p><ul><li><p><code>roadwidth::Float64</code></p></li><li><p><code>tmaxextra::Float64</code></p></li><li><p><code>tmax::Float64</code></p></li><li><p><code>x::Float64</code></p></li><li><p><code>y::Float64</code></p></li><li><p><code>z::Float64</code></p></li><li><p><code>d::Float64</code></p></li><li><p><code>t::Float64</code></p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/hits.jl#LL541">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.Match1D-NTuple{4, Any}" href="#NeRCA.Match1D-NTuple{4, Any}"><code>NeRCA.Match1D</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Optimised version of Match1D which avoids the usage of calling <code>time(hit)</code> multiple times.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/hits.jl#LL562">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.Match3B" href="#NeRCA.Match3B"><code>NeRCA.Match3B</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">mutable struct Match3B <: NeRCA.AbstractMatcher</code></pre><p>3D match criterion with road width, intended for muon signals.</p><p>Origin: B. Bakker, "Trigger studies for the Antares and KM3NeT detector.", Master thesis, University of Amsterdam. With modifications from Jpp (M. de Jong).</p><p><strong>Fields</strong></p><ul><li><p><code>roadwidth::Float64</code></p></li><li><p><code>tmaxextra::Float64</code></p></li><li><p><code>x::Float64</code></p></li><li><p><code>y::Float64</code></p></li><li><p><code>z::Float64</code></p></li><li><p><code>d::Float64</code></p></li><li><p><code>t::Float64</code></p></li><li><p><code>dmin::Float64</code></p></li><li><p><code>dmax::Float64</code></p></li><li><p><code>d₂::Float64</code></p></li><li><p><code>D0::Float64</code></p></li><li><p><code>D1::Float64</code></p></li><li><p><code>D2::Float64</code></p></li><li><p><code>D02::Float64</code></p></li><li><p><code>D12::Float64</code></p></li><li><p><code>D22::Float64</code></p></li><li><p><code>Rs2::Float64</code></p></li><li><p><code>Rst::Float64</code></p></li><li><p><code>Rt::Float64</code></p></li><li><p><code>R2::Float64</code></p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/hits.jl#LL449">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.Match3B-NTuple{4, Any}" href="#NeRCA.Match3B-NTuple{4, Any}"><code>NeRCA.Match3B</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Optimised version which avoids the usage of calling <code>time(hit)</code> multiple times.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/hits.jl#LL512">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.Match3B-Tuple{Any, Any}" href="#NeRCA.Match3B-Tuple{Any, Any}"><code>NeRCA.Match3B</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Match3B(roadwidth, tmaxextra) -> Match3B
-</code></pre><p>The Match3B algorithm.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/hits.jl#LL506">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="KM3io.calibrate-Tuple{Type{HitR1}, Detector, Any}" href="#KM3io.calibrate-Tuple{Type{HitR1}, Detector, Any}"><code>KM3io.calibrate</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">calibrate(
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Hits · NeRCA.jl</title><meta name="title" content="Hits · NeRCA.jl"/><meta property="og:title" content="Hits · NeRCA.jl"/><meta property="twitter:title" content="Hits · NeRCA.jl"/><meta name="description" content="Documentation for NeRCA.jl."/><meta property="og:description" content="Documentation for NeRCA.jl."/><meta property="twitter:description" content="Documentation for NeRCA.jl."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script><link href="../assets/custom.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../io/">I/O</a></li><li class="is-active"><a class="tocitem" href>Hits</a></li><li><a class="tocitem" href="../fit/">ROyFit</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Hits</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Hits</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://git.km3net.de/tgal/NeRCA.jl" title="View the repository"><span class="docs-icon fa-brands">ï¡</span><span class="docs-label is-hidden-touch">Repository</span></a><a class="docs-navbar-link" href="https://git.km3net.de/tgal/NeRCA.jl/blob/master/docs/src/hits.md#L" title="Edit source"><span class="docs-icon fa-solid">ï„</span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Hits"><a class="docs-heading-anchor" href="#Hits">Hits</a><a id="Hits-1"></a><a class="docs-heading-anchor-permalink" href="#Hits" title="Permalink"></a></h1><p>The hit type hierarchy is currently being redesigned!</p><p><code>NeRCA.jl</code> has three main types of hits: <code>AbstractDAQHit</code>, <code>AbstractMCHit</code> and <code>CalibratedHit</code>.</p><table><tr><th style="text-align: right">hit type</th><th style="text-align: right">supertype</th><th style="text-align: right">guaranteed attributes</th></tr><tr><td style="text-align: right"><code>Hit</code> (in future <code>SnapshotHit</code>)</td><td style="text-align: right"><code>AbstractDAQHit</code></td><td style="text-align: right"><code>channel_id</code>, <code>dom_id</code>, <code>t</code>, <code>tot</code></td></tr><tr><td style="text-align: right"><code>TriggeredHit</code></td><td style="text-align: right"><code>AbstractDAQHit</code></td><td style="text-align: right"><code>channel_id</code>, <code>dom_id</code>, <code>t</code>, <code>tot</code>, <code>trigger_mask</code></td></tr><tr><td style="text-align: right"><code>MCHit</code></td><td style="text-align: right"><code>AbstractMCHit</code></td><td style="text-align: right"><code>a</code>, <code>origin</code>, <code>pmt_id</code>, <code>t</code></td></tr></table><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.Clique" href="#NeRCA.Clique"><code>NeRCA.Clique</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct Clique{T<:NeRCA.AbstractMatcher}</code></pre><p>Clique clusterizer which takes a matcher algorithm like <code>Match3B</code> as input.</p><p><strong>Fields</strong></p><ul><li><p><code>match::NeRCA.AbstractMatcher</code></p></li><li><p><code>weights::Vector{Float64}</code></p></li><li><p><code>times::Vector{Float64}</code></p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/hits.jl#LL590">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.L1Builder-Union{Tuple{H}, Tuple{T}, Tuple{Type{H}, Detector, Vector{T}}} where {T, H}" href="#NeRCA.L1Builder-Union{Tuple{H}, Tuple{T}, Tuple{Type{H}, Detector, Vector{T}}} where {T, H}"><code>NeRCA.L1Builder</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">L1Builder(params) -> L1Builder
+</code></pre><p>Find coincidences within the time window <code>Δt</code> of the initialised <code>params</code>. The return value is a vector of <code>L1Hit</code>s.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/hits.jl#LL356">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.Match1D" href="#NeRCA.Match1D"><code>NeRCA.Match1D</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">mutable struct Match1D <: NeRCA.AbstractMatcher</code></pre><p>Simple Cherenkov matcher for muon signals. The muon is assumed to travel parallel to the Z-axis.</p><p><strong>Fields</strong></p><ul><li><p><code>roadwidth::Float64</code></p></li><li><p><code>tmaxextra::Float64</code></p></li><li><p><code>tmax::Float64</code></p></li><li><p><code>x::Float64</code></p></li><li><p><code>y::Float64</code></p></li><li><p><code>z::Float64</code></p></li><li><p><code>d::Float64</code></p></li><li><p><code>t::Float64</code></p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/hits.jl#LL541">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.Match1D-NTuple{4, Any}" href="#NeRCA.Match1D-NTuple{4, Any}"><code>NeRCA.Match1D</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Optimised version of Match1D which avoids the usage of calling <code>time(hit)</code> multiple times.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/hits.jl#LL562">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.Match3B" href="#NeRCA.Match3B"><code>NeRCA.Match3B</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">mutable struct Match3B <: NeRCA.AbstractMatcher</code></pre><p>3D match criterion with road width, intended for muon signals.</p><p>Origin: B. Bakker, "Trigger studies for the Antares and KM3NeT detector.", Master thesis, University of Amsterdam. With modifications from Jpp (M. de Jong).</p><p><strong>Fields</strong></p><ul><li><p><code>roadwidth::Float64</code></p></li><li><p><code>tmaxextra::Float64</code></p></li><li><p><code>x::Float64</code></p></li><li><p><code>y::Float64</code></p></li><li><p><code>z::Float64</code></p></li><li><p><code>d::Float64</code></p></li><li><p><code>t::Float64</code></p></li><li><p><code>dmin::Float64</code></p></li><li><p><code>dmax::Float64</code></p></li><li><p><code>d₂::Float64</code></p></li><li><p><code>D0::Float64</code></p></li><li><p><code>D1::Float64</code></p></li><li><p><code>D2::Float64</code></p></li><li><p><code>D02::Float64</code></p></li><li><p><code>D12::Float64</code></p></li><li><p><code>D22::Float64</code></p></li><li><p><code>Rs2::Float64</code></p></li><li><p><code>Rst::Float64</code></p></li><li><p><code>Rt::Float64</code></p></li><li><p><code>R2::Float64</code></p></li></ul></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/hits.jl#LL449">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.Match3B-NTuple{4, Any}" href="#NeRCA.Match3B-NTuple{4, Any}"><code>NeRCA.Match3B</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Optimised version which avoids the usage of calling <code>time(hit)</code> multiple times.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/hits.jl#LL512">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.Match3B-Tuple{Any, Any}" href="#NeRCA.Match3B-Tuple{Any, Any}"><code>NeRCA.Match3B</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Match3B(roadwidth, tmaxextra) -> Match3B
+</code></pre><p>The Match3B algorithm.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/hits.jl#LL506">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="KM3io.calibrate-Tuple{Type{HitR1}, Detector, Any}" href="#KM3io.calibrate-Tuple{Type{HitR1}, Detector, Any}"><code>KM3io.calibrate</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">calibrate(
T::Type{HitR1},
det::Detector,
hits
) -> Vector{HitR1}
-</code></pre><p>Calibrates hits.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/hits.jl#LL300">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.clusterize!-Union{Tuple{T}, Tuple{AbstractArray{T}, NeRCA.AbstractMatcher}} where T<:NeRCA.AbstractSpecialHit" href="#NeRCA.clusterize!-Union{Tuple{T}, Tuple{AbstractArray{T}, NeRCA.AbstractMatcher}} where T<:NeRCA.AbstractSpecialHit"><code>NeRCA.clusterize!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">clusterize!(
+</code></pre><p>Calibrates hits.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/hits.jl#LL300">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.clusterize!-Union{Tuple{T}, Tuple{AbstractArray{T}, NeRCA.AbstractMatcher}} where T<:NeRCA.AbstractSpecialHit" href="#NeRCA.clusterize!-Union{Tuple{T}, Tuple{AbstractArray{T}, NeRCA.AbstractMatcher}} where T<:NeRCA.AbstractSpecialHit"><code>NeRCA.clusterize!</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">clusterize!(
hits::AbstractArray{T<:NeRCA.AbstractSpecialHit},
m::NeRCA.AbstractMatcher
) -> Any
-</code></pre><p>Applies the clique clusterization algorithm and leaves only the best matching hits in the input array.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/hits.jl#LL600">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.combine-Tuple{Vector{KM3io.SnapshotHit}, Vector{KM3io.TriggeredHit}}" href="#NeRCA.combine-Tuple{Vector{KM3io.SnapshotHit}, Vector{KM3io.TriggeredHit}}"><code>NeRCA.combine</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">combine(
+</code></pre><p>Applies the clique clusterization algorithm and leaves only the best matching hits in the input array.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/hits.jl#LL600">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.combine-Tuple{Vector{KM3io.SnapshotHit}, Vector{KM3io.TriggeredHit}}" href="#NeRCA.combine-Tuple{Vector{KM3io.SnapshotHit}, Vector{KM3io.TriggeredHit}}"><code>NeRCA.combine</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">combine(
snapshot_hits::Vector{KM3io.SnapshotHit},
triggered_hits::Vector{KM3io.TriggeredHit}
) -> Vector{KM3io.TriggeredHit}
-</code></pre><p>Combine snapshot and triggered hits to a single hits-vector.</p><p>This should be used to transfer the trigger information to the snapshot hits from a DAQEvent. The triggered hits are a subset of the snapshot hits.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/hits.jl#LL92">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.combine-Union{Tuple{Vector{T}}, Tuple{T}} where T<:KM3io.AbstractHit" href="#NeRCA.combine-Union{Tuple{Vector{T}}, Tuple{T}} where T<:KM3io.AbstractHit"><code>NeRCA.combine</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">combine(hits::Array{T<:KM3io.AbstractHit, 1}) -> Hit
-</code></pre><p>Combines several hits into a single one by taking the earliest start time, then latest endtime and a ToT which spans over the time range.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/hits.jl#LL323">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.count_multiplicities!" href="#NeRCA.count_multiplicities!"><code>NeRCA.count_multiplicities!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">count_multiplicities!(hits::Vector{KM3io.XCalibratedHit})
+</code></pre><p>Combine snapshot and triggered hits to a single hits-vector.</p><p>This should be used to transfer the trigger information to the snapshot hits from a DAQEvent. The triggered hits are a subset of the snapshot hits.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/hits.jl#LL92">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.combine-Union{Tuple{Vector{T}}, Tuple{T}} where T<:KM3io.AbstractHit" href="#NeRCA.combine-Union{Tuple{Vector{T}}, Tuple{T}} where T<:KM3io.AbstractHit"><code>NeRCA.combine</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">combine(hits::Array{T<:KM3io.AbstractHit, 1}) -> Hit
+</code></pre><p>Combines several hits into a single one by taking the earliest start time, then latest endtime and a ToT which spans over the time range.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/hits.jl#LL323">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.count_multiplicities!" href="#NeRCA.count_multiplicities!"><code>NeRCA.count_multiplicities!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">count_multiplicities!(hits::Vector{KM3io.XCalibratedHit})
count_multiplicities!(
hits::Vector{KM3io.XCalibratedHit},
tmax
)
-</code></pre><p>Counts the multiplicities and modifies the .multiplicity field of the hits. Important: the hits have to be sorted by time and then by DOM ID first.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/hits.jl#LL188">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.count_multiplicities-Union{Tuple{Vector{T}}, Tuple{T}, Tuple{Vector{T}, Any}} where T<:KM3io.AbstractHit" href="#NeRCA.count_multiplicities-Union{Tuple{Vector{T}}, Tuple{T}, Tuple{Vector{T}, Any}} where T<:KM3io.AbstractHit"><code>NeRCA.count_multiplicities</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">count_multiplicities(
+</code></pre><p>Counts the multiplicities and modifies the .multiplicity field of the hits. Important: the hits have to be sorted by time and then by DOM ID first.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/hits.jl#LL188">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.count_multiplicities-Union{Tuple{Vector{T}}, Tuple{T}, Tuple{Vector{T}, Any}} where T<:KM3io.AbstractHit" href="#NeRCA.count_multiplicities-Union{Tuple{Vector{T}}, Tuple{T}, Tuple{Vector{T}, Any}} where T<:KM3io.AbstractHit"><code>NeRCA.count_multiplicities</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">count_multiplicities(
hits::Array{T<:KM3io.AbstractHit, 1}
) -> Tuple{Vector{Int32}, Vector{Int32}}
count_multiplicities(
hits::Array{T<:KM3io.AbstractHit, 1},
tmax
) -> Tuple{Vector{Int32}, Vector{Int32}}
-</code></pre><p>Calculate the multiplicities for a given time window. Two arrays are are returned, one contains the multiplicities, the second one the IDs of the coincidence groups. The hits should be sorted by time and then by dom_id.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/hits.jl#LL145">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.duhits-Union{Tuple{Vector{T}}, Tuple{T}} where T<:KM3io.XCalibratedHit" href="#NeRCA.duhits-Union{Tuple{Vector{T}}, Tuple{T}} where T<:KM3io.XCalibratedHit"><code>NeRCA.duhits</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">duhits(hits::Array{T<:KM3io.XCalibratedHit, 1}) -> Dict
-</code></pre><p>Categorise hits by DU and put them into a dictionary of DU=>Vector{Hit}.</p><p>Caveat: this function is not typesafe, only suited for high-level analysis (like plots).</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/hits.jl#LL246">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.hitcount-Union{Tuple{AbstractArray{T}}, Tuple{T}} where T<:NeRCA.AbstractReducedHit" href="#NeRCA.hitcount-Union{Tuple{AbstractArray{T}}, Tuple{T}} where T<:NeRCA.AbstractReducedHit"><code>NeRCA.hitcount</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">hitcount(
+</code></pre><p>Calculate the multiplicities for a given time window. Two arrays are are returned, one contains the multiplicities, the second one the IDs of the coincidence groups. The hits should be sorted by time and then by dom_id.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/hits.jl#LL145">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.duhits-Union{Tuple{Vector{T}}, Tuple{T}} where T<:KM3io.XCalibratedHit" href="#NeRCA.duhits-Union{Tuple{Vector{T}}, Tuple{T}} where T<:KM3io.XCalibratedHit"><code>NeRCA.duhits</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">duhits(hits::Array{T<:KM3io.XCalibratedHit, 1}) -> Dict
+</code></pre><p>Categorise hits by DU and put them into a dictionary of DU=>Vector{Hit}.</p><p>Caveat: this function is not typesafe, only suited for high-level analysis (like plots).</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/hits.jl#LL246">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.hitcount-Union{Tuple{AbstractArray{T}}, Tuple{T}} where T<:NeRCA.AbstractReducedHit" href="#NeRCA.hitcount-Union{Tuple{AbstractArray{T}}, Tuple{T}} where T<:NeRCA.AbstractReducedHit"><code>NeRCA.hitcount</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">hitcount(
hits::AbstractArray{T<:NeRCA.AbstractReducedHit}
) -> Any
-</code></pre><p>Return the total number of hits for a collection of reduced hits.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/hits.jl#LL87">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.modulemap-Union{Tuple{Vector{T}}, Tuple{T}} where T" href="#NeRCA.modulemap-Union{Tuple{Vector{T}}, Tuple{T}} where T"><code>NeRCA.modulemap</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">modulemap(hits::Array{T, 1}) -> Dict{Int32}
-</code></pre><p>Creates a map (<code>Dict{Int32, Vector{T}}</code>) from a flat <code>Vector{T}</code> split up based on the <code>dom_id</code> of each element. A typical use is to split up a vector of hits by their optical module IDs.</p><p>This function is similar to <code>categorize(:dom_id, Vector{T})</code> but this method is completely typesafe.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/hits.jl#LL279">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.nfoldhits-Union{Tuple{T}, Tuple{Vector{T}, Any, Any}} where T<:KM3io.AbstractDAQHit" href="#NeRCA.nfoldhits-Union{Tuple{T}, Tuple{Vector{T}, Any, Any}} where T<:KM3io.AbstractDAQHit"><code>NeRCA.nfoldhits</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">nfoldhits(
+</code></pre><p>Return the total number of hits for a collection of reduced hits.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/hits.jl#LL87">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.modulemap-Union{Tuple{Vector{T}}, Tuple{T}} where T" href="#NeRCA.modulemap-Union{Tuple{Vector{T}}, Tuple{T}} where T"><code>NeRCA.modulemap</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">modulemap(hits::Array{T, 1}) -> Dict{Int32}
+</code></pre><p>Creates a map (<code>Dict{Int32, Vector{T}}</code>) from a flat <code>Vector{T}</code> split up based on the <code>dom_id</code> of each element. A typical use is to split up a vector of hits by their optical module IDs.</p><p>This function is similar to <code>categorize(:dom_id, Vector{T})</code> but this method is completely typesafe.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/hits.jl#LL279">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.nfoldhits-Union{Tuple{T}, Tuple{Vector{T}, Any, Any}} where T<:KM3io.AbstractDAQHit" href="#NeRCA.nfoldhits-Union{Tuple{T}, Tuple{Vector{T}, Any, Any}} where T<:KM3io.AbstractDAQHit"><code>NeRCA.nfoldhits</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">nfoldhits(
hits::Array{T<:KM3io.AbstractDAQHit, 1},
Δt,
n
) -> Vector
-</code></pre><p>Create a <code>Vector</code> with hits contributing to <code>n</code>-fold coincidences within a time window of Δt.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/hits.jl#LL119">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.nphes-Tuple{Any}" href="#NeRCA.nphes-Tuple{Any}"><code>NeRCA.nphes</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">nphes(tot) -> Any
-</code></pre><p>Returns the estimated number of photoelectrons for a given ToT.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/hits.jl#LL262">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.timetoz-Tuple{Any}" href="#NeRCA.timetoz-Tuple{Any}"><code>NeRCA.timetoz</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">timetoz(hit) -> Any
-</code></pre><p>Calculates the time to reach the z-position of the <code>hit</code> along the z-axis.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/hits.jl#LL439">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.totcut-Union{Tuple{T}, Tuple{Vector{T}, Any}} where T<:KM3io.AbstractDAQHit" href="#NeRCA.totcut-Union{Tuple{T}, Tuple{Vector{T}, Any}} where T<:KM3io.AbstractDAQHit"><code>NeRCA.totcut</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">totcut(
+</code></pre><p>Create a <code>Vector</code> with hits contributing to <code>n</code>-fold coincidences within a time window of Δt.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/hits.jl#LL119">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.nphes-Tuple{Any}" href="#NeRCA.nphes-Tuple{Any}"><code>NeRCA.nphes</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">nphes(tot) -> Any
+</code></pre><p>Returns the estimated number of photoelectrons for a given ToT.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/hits.jl#LL262">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.timetoz-Tuple{Any}" href="#NeRCA.timetoz-Tuple{Any}"><code>NeRCA.timetoz</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">timetoz(hit) -> Any
+</code></pre><p>Calculates the time to reach the z-position of the <code>hit</code> along the z-axis.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/hits.jl#LL439">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="NeRCA.totcut-Union{Tuple{T}, Tuple{Vector{T}, Any}} where T<:KM3io.AbstractDAQHit" href="#NeRCA.totcut-Union{Tuple{T}, Tuple{Vector{T}, Any}} where T<:KM3io.AbstractDAQHit"><code>NeRCA.totcut</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">totcut(
hits::Array{T<:KM3io.AbstractDAQHit, 1},
tot
) -> Vector
-</code></pre><p>Return a vector of hits with ToT >= <code>tot</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/d9a1e95348ac85a89b7d96840d02786dd9b2b3df/src/hits.jl#LL254">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../io/">« I/O</a><a class="docs-footer-nextpage" href="../fit/">ROyFit »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.0 on <span class="colophon-date" title="Monday 9 October 2023 12:12">Monday 9 October 2023</span>. Using Julia version 1.9.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</code></pre><p>Return a vector of hits with ToT >= <code>tot</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://git.km3net.de/tgal/NeRCA.jl/blob/434d86d1e8174a712a578cd065df07e56cdf81dc/src/hits.jl#LL254">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../io/">« I/O</a><a class="docs-footer-nextpage" href="../fit/">ROyFit »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.0 on <span class="colophon-date" title="Monday 9 October 2023 12:12">Monday 9 October 2023</span>. Using Julia version 1.9.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
--
GitLab