cesm_hawc.noise¶
The ALI instrument noise model used throughout cesm-hawc.
Every caller in this package uses default_noise_model() rather than
constructing hawcsimulator.noise.ALINoiseModel directly, so the noise
settings are defined in one place.
default_noise_model¶
def default_noise_model(seed: int | None = None)Return the ALINoiseModel used for every cesm-hawc simulation.
Parameters¶
seed(int, optional) — Seed for the noise. With a seed, every simulation with the same inputs draws the same noise. Default: unseeded.
Returns¶
hawcsimulator.noise.ALINoiseModel — Noise model with
straylight_fraction=0.0and thehawcsimulatordefaults for every other setting.
Notes¶
straylight_fraction is fixed at 0.0. It is deliberately not a
config option or CLI flag.
Without seed, repeated runs draw different noise.