SubsamplingPolicy

The rule for turning smear into a sub-sample count.

Usage

Source

SubsamplingPolicy(
    pixels_per_subsample=1.0,
    minimum=NT_FLOOR,
    maximum=33,
)

Parameters

pixels_per_subsample: float = 1.0

Target spacing of sample points along the smear track, in detector pixels. Smaller means finer time sampling and a larger product: every backplane column scales linearly with NT.

minimum: int = NT_FLOOR

Floor. Must be at least 3; v2 fixes that, so lowering it is refused rather than silently honoured.

maximum: int = 33
Ceiling, to stop a pathological product from exploding. Backplane volume is 5 * NY * NZ * NT floats per column, so this is a real constraint rather than a formality.

Methods

Name Description
describe() One-line provenance, short enough to fit a FITS card with its comment.
recommend() NT for an integration that smears smear_pixels across the slit.
validate() Return nt unchanged, or raise if it is outside the policy.

describe()

One-line provenance, short enough to fit a FITS card with its comment.

Usage

Source

describe()

recommend()

NT for an integration that smears smear_pixels across the slit.

Usage

Source

recommend(smear_pixels)

validate()

Return nt unchanged, or raise if it is outside the policy.

Usage

Source

validate(nt)