`--new_bin`

Generate G4X-viewer `.bin` files from G4X Sample Output

This tool will create a new .bin segmentation file compatible with the G4X-Viewer using the processed output from a G4X run. This is typically only needed to update older outputs to newer versions of the .bin format.

usage

$ new_bin 
  --run_base /path/to/G4X_sample_output

  # ─── optional ───
  --out_dir <output_dir>
  --threads <n_threads>
  --verbose <level>

argument descriptions

required

`--run_base`: (type: `str`)

Path to the base directory containing G4X sample output. This folder should include adata and segmentation files generated by a previous G4X analysis run.

optional

`--out_dir`: (type: `str` default: `None`)

Output directory where the new .bin file will be saved. If not provided, the file will be written in-place to a default path within the run_base directory (g4x_viewer/{sample_id}.bin).

`--threads`: (type: `int` default: `4`)

Number of threads to use for processing. Increase this value to speed up the .bin generation process on multicore machines.

`--verbose`: (type: `int` default: `1`)

Logging verbosity level: - 0 = WARNING
- 1 = INFO
- 2 = DEBUG
This affects how much information is printed to the console during execution.