Skip to content

snr_check

Quick data-quality check on an already-loaded spectrum: normalise the continuum, then report the signal-to-noise ratio with two independent estimators.
Kind analysis
Status reference - reviewed and adopted as the reference way to make this measurement
Version 1.0.0
Source bundled

Variables

This recipe declares no variables: it runs as is.

Steps

# Algorithm Parameters
1 normalize_polynomial Normalise continuum order=3, sigma_clip=3.0
2 snr_der SNR (derivative method) -
3 snr_edge SNR (edge method) region_fraction=0.1

Run it

spectro pipeline snr_check --input spectrum.fits
spectro preset show snr_check      # variables and steps

from spectro_kernel import WorkContext
from spectro_kernel.pipeline import PipelineBuilder

pipeline = PipelineBuilder().from_preset("snr_check").build()
result = pipeline.execute(ctx)        # ctx holds the spectrum / frames
print(result.history[-1])             # pipeline:<name> vX.Y.Z + variables

{
  "tool": "run_preset",
  "arguments": {
    "session_id": "<session_id>",
    "preset_name": "snr_check"
  }
}