Files
Jungfraujoch/docs/TOOLS.md
T
leonarski_f c49bd2ac3b
Build Packages / XDS test (neggia plugin) (push) Successful in 6m2s
Build Packages / Unit tests (push) Successful in 1h37m1s
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 12m4s
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 13m30s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Successful in 12m52s
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Successful in 11m53s
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 12m38s
Build Packages / build:rpm (rocky9_sls9) (push) Successful in 13m30s
Build Packages / build:rpm (rocky8) (push) Successful in 10m47s
Build Packages / build:rpm (rocky9) (push) Successful in 11m48s
Build Packages / build:rpm (ubuntu2204) (push) Successful in 10m40s
Build Packages / build:rpm (ubuntu2404) (push) Successful in 9m44s
Build Packages / DIALS test (push) Successful in 12m59s
Build Packages / XDS test (durin plugin) (push) Successful in 8m33s
Build Packages / Generate python client (push) Successful in 16s
Build Packages / XDS test (JFJoch plugin) (push) Successful in 6m24s
Build Packages / Build documentation (push) Successful in 57s
Build Packages / Create release (push) Skipped
v1.0.0-rc.152 (#62)
* jfjoch_broker: Fix bounds for azimuthal integration for Q spacing (allow Q of 1e-5)
* jfjoch_viewer: Adjust Q bounds for azimuthal integration
* jfjoch_azint: Add tool to do quick azimuthal integration

Reviewed-on: #62
2026-06-17 20:36:24 +02:00

84 lines
3.3 KiB
Markdown

# Tools
## jfjoch_pcie_status
Prints detailed status information about the card. Execute by adding device path, e.g.:
```
./jfjoch_pcie_status /dev/jfjoch0
```
The program is safe to execute during a running data collection.
## jfjoch_pcie_clear_net_counters
Network counters in the card give information about Ethernet, UDP and ICMP packets encountered by the network stack prior to Jungfraujoch logic.
These counters are running from the moment card is powered on. They can be reset by running the program with device name, e.g.:
```
./jfjoch_pcie_clear_net_counters /dev/jfjoch0
```
## jfjoch_pcie_net_cfg
Network configuration can be retrieved and modified with `jfjoch_pcie_net_cfg` tool. Usage:
```
jfjoch_pcie_net_cfg <device name>
Read configuration for all network interface of a device
jfjoch_pcie_net_cfg <device name> <if number>|fgen
Read configuration for a particular network interface / internal frame generator"
jfjoch_pcie_net_cfg <device name> <if number>|fgen ipv4 <IPv4 address>
Set IPv4 address for a particular network interface / internal frame generator
jfjoch_pcie_net_cfg <device name> <if number>|fgen direct 0|1
Set direct mode for a particular network interface / internal frame generator
jfjoch_pcie_net_cfg <device name> <if number>|fgen clear
Clear Ethernet counter for a particular network interface / internal frame generator
```
## jfjoch_hdf5_tools
Tool to test single threaded HDF5 writer performance
## jfjoch_offline_process
Tool to run offline processing on existing HDF5 dataset
## jfjoch_udp_simulator
UDP simulator to test Jungfraujoch FPGA
## jfjoch_pcie_read_register
Tool to read verbatim Jungfraujoch FPGA registers
## jfjoch_azint
Runs CPU azimuthal integration on an existing Jungfraujoch HDF5 file using `N` threads and writes the
result to `<prefix>_process.h5`. Example:
```
./jfjoch_azint -o output -N 8 input.h5
```
The integration settings and geometry default to the values stored in the input file; any of them can be
overridden on the command line:
```
jfjoch_azint {<options>} <input.h5>
-o, --output-prefix <txt> Output file prefix (default: output)
-N, --threads <num> Number of threads (default: 1)
-s, --start-image <num> Start image number (default: 0)
-e, --end-image <num> End image number (default: all)
-t, --stride <num> Image stride (default: 1)
-v, --verbose Verbose output
Azimuthal integration:
--min-q <num> Minimum Q for integration (1/A)
--max-q <num> Maximum Q for integration (1/A)
--q-spacing <num> Q bin spacing (1/A)
--azimuthal-bins <num> Number of azimuthal bins (default: 1)
--polarization-correction <on|off> Enable/disable polarization correction
--solid-angle-correction <on|off> Enable/disable solid angle correction
Geometry overrides:
--beam-x <num> Beam center X (pixel)
--beam-y <num> Beam center Y (pixel)
--detector-distance <num> Detector distance (mm)
--wavelength <num> Wavelength (A)
--rot1 <num> PONI rotation 1 (rad)
--rot2 <num> PONI rotation 2 (rad)
--polarization <num> Polarization factor
```