Documentation
This section collects technical notes and usage guides for StarNet and DeepSNR: command-line references, input behavior, data-quality guidance, and workflow examples.
DeepSNR command-line tool reference
This page describes the current DeepSNR command-line options, example commands, supported inputs, model selection, and output behavior.
Running options
USAGE:
deepsnr [-ehq] [--version] [-i <string>] [-m <int>]
[-o <string>] [-s <int>] [-w <string>]
Options:
-i <string>, --input <string>
Input image filename. Supported sample depths: 8-bit and 16-bit integer.
-o <string>, --output <string>
Output image filename. TIF/PNG default to 16-bit unless --eight is used.
-w <string>, --weights <string>
Override path to the model checkpoint. Normally omit this option.
-s <int>, --stride <int>
Stride value. Must be even and between 2 and 512.
-m <int>, --model <int>
Model version to use, 1 or 2. Default is 2. Not used if weights argument
is provided.
-q, --quiet
Run quietly with no terminal output.
-e, --eight
Write TIF and PNG output as 8-bit instead of the default 16-bit.
--, --ignore_rest
Ignores the rest of the labeled arguments following this flag.
--version
Displays version information and exits.
-h, --help
Displays usage information and exits.
CLI interface for DeepSNR w/ ONNX Runtime backend.
DeepSNR v1.2.0 Example commands
- Denoise with the default current model
deepsnr --input input.tif --output denoised.tif- Choose model 2 explicitly
deepsnr --input input.tif --output denoised.tif --model 2- Run the older RGB model line
deepsnr --input rgb-input.tif --output denoised.tif --model 1- Use a specific weights file
deepsnr --input input.tif --output denoised.tif --weights DeepSNR_weights_v2.onnx- Use quiet mode for scripts
deepsnr --input input.tif --output denoised.tif --quiet
Inputs and outputs
DeepSNR is intended for high-quality calibrated and integrated data where the remaining noise is mostly random and not strongly patterned. Correlated artifacts such as walking noise behave more like image structure and should be addressed before denoising.
- File formats
- The image reader accepts common OpenCV-readable formats including TIFF, PNG, JPEG, and BMP.
- Bit depth
- 8-bit and 16-bit integer inputs are supported. 16-bit TIFF/PNG input is preserved and normalized as 16-bit. Unsupported input depths, including 32-bit floating-point images, are rejected; convert them to 16-bit integer before running the tool.
- Color and grayscale
- RGB and grayscale inputs are accepted. Model 2 supports RGB and grayscale inputs; model 1 is intended for RGB inputs.
- Image size
- Images must be at least 512 × 512 pixels.
- Default output depth
- TIFF and PNG outputs are written as 16-bit integer images by default.
--eight- Use this only when you intentionally want 8-bit TIFF or PNG output.
DeepSNR-specific options
--model,-m- Chooses the built-in model line when
--weightsis not provided. Model 2 is the default current model line and supports RGB and grayscale inputs. Model 1 is the older model line and is intended for RGB inputs. - Automatic weights lookup
- When
--weightsis omitted, DeepSNR choosesDeepSNR_weights_v1.onnxorDeepSNR_weights_v2.onnxnext to the executable based on--model. --stride,-s- Tile stride. It must be even and between 2 and 512. DeepSNR defaults to 480.
- Short option clustering
- Short boolean switches can be combined. For example,
-eqis equivalent to-e -q. Options that take values, such as-i,-o,-m,-w, and-s, must be provided separately.