LightPath

class nsb2.core.lightpath.LightPath[source]

Bases: ABC

Base 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:
Returns:

Compilation cost metric; zero when nothing was compiled.

Return type:

float

abstractmethod compute(source, instrument, atmosphere, observation)[source]

Compute the pixel rates from one source along this path.

Parameters:
Returns:

Per-pixel rates for this source and path.

Return type:

nsb2.core.dtypes.Prediction

__init__()
classmethod __new__(*args, **kwargs)