LightPath¶
- class nsb2.core.lightpath.LightPath[source]¶
Bases:
ABCBase class for physical light paths from a source to a pixel.
- Variables:
name (str) – Human-readable identifier, carried through to
nsb2.core.dtypes.Prediction.
Attributes Summary
Methods Summary
compile(source, instrument, atmosphere, **kwargs)Pre-compute whatever the path's solver needs.
compute(source, instrument, atmosphere, ...)Compute the pixel rates from one source along this path.
Attributes Documentation
- name = ''¶
Methods Documentation
- compile(source, instrument, atmosphere, **kwargs)[source]¶
Pre-compute whatever the path’s solver needs.
- Parameters:
source (nsb2.core.sources.Source) – Source the pre-computation applies to.
instrument (nsb2.core.instrument.Instrument) – Instrument whose passband the spectra are restricted to.
atmosphere (nsb2.core.atmosphere.Atmosphere) – Atmosphere model to tabulate.
**kwargs – Solver-specific compilation options.
- Returns:
Compilation cost metric; zero when nothing was compiled.
- Return type:
- abstractmethod compute(source, instrument, atmosphere, observation)[source]¶
Compute the pixel rates from one source along this path.
- Parameters:
source (nsb2.core.sources.Source) – Source to trace.
instrument (nsb2.core.instrument.Instrument) – Instrument collecting the light.
atmosphere (nsb2.core.atmosphere.Atmosphere) – Atmosphere the light travels through.
observation (astropy.coordinates.BaseCoordinateFrame) – The telescope pointing frame.
- Returns:
Per-pixel rates for this source and path.
- Return type:
- __init__()¶
- classmethod __new__(*args, **kwargs)¶