Skip to content
Snippets Groups Projects
Commit 4cdac747 authored by Stefan Reck's avatar Stefan Reck
Browse files

docs

parent ef661d46
No related branches found
No related tags found
1 merge request!23Jagged graph
......@@ -105,16 +105,12 @@ like this:
from orcasong.core import FileGraph
The FileGraph produces a list of nodes, each representing a hit.
The length of this list has to be fixed, i.e. be the same for each event.
Since the number of hits varies from event to event, some events will have to get
padded, while others might get hits removed. The parameter ``max_n_hits``
of FileGraph determines this fixed length:
.. code-block:: python
fg = FileGraph(max_n_hits=2000)
fg = FileGraph()
The FileGraph produces a list of nodes, each representing a hit.
Since the number of hits varies from event to event, the hits of all events are saved
in a long list (2d array), and a seperate datasets is saved that can be used
to identify which hits belong to which events.
General usage
-------------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment