Skip to content

Commit

Permalink
fix
Browse files Browse the repository at this point in the history
  • Loading branch information
FaroutYLq committed Apr 22, 2024
1 parent 423fa3a commit 7c27670
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions saltax/match/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
## Scope
Functionality for matching salt and simu, with some regular follow-up analysis functions.
## Structure
`match.py`: core functions for matching simulation and sprinkled dataset. The core functions to use are `match_peaks` or `match_events`.
`utils.py`: useful functions for analysis after matching is finished. Check tutorial notebooks for usage.
`visual.py`: a toy non-interactive event viewer. The core functinos to use are `plot_event_wf_w_data` or `plot_event_wf_wo_data`. (The only discrepancy is whether you want to show data-only reconstruction result)
- `match.py`: core functions for matching simulation and sprinkled dataset. The core functions to use are `match_peaks` or `match_events`.
- `utils.py`: useful functions for analysis after matching is finished. Check tutorial notebooks for usage.
- `visual.py`: a toy non-interactive event viewer. The core functinos to use are `plot_event_wf_w_data` or `plot_event_wf_wo_data`. (The only discrepancy is whether you want to show data-only reconstruction result)

0 comments on commit 7c27670

Please sign in to comment.