esbo_ds/ESBO-ETC
esbo_ds/ESBO-ETC
11
0
Fork 1
Code Issues 1 Pull Requests Releases 1 Wiki Activity

calcNoise() renamed to calcBackground()

Browse Source
This commit is contained in:
Lukas Klass 2020-04-24 17:11:53 +02:00
parent bfe7d4e917
commit 513eb6b1ae
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
esbo_etc/classes/IRadiant.py
View File

@ -4,7 +4,8 @@ from .SpectralQty import SpectralQty
class IRadiant(ABC):
"""
Interface for getting the signal and the noise of a emitting, reflecting or transmitting component in the beam.
Interface for getting the signal and the background radiation of a emitting, reflecting or transmitting component
in the beam.
"""
@abstractmethod
def calcSignal(self) -> SpectralQty:
@ -19,13 +20,13 @@ class IRadiant(ABC):
pass
@abstractmethod
def calcNoise(self) -> SpectralQty:
def calcBackground(self) -> SpectralQty:
"""
Calculate the noise coming from the component
Calculate the background radiation coming from the component
Returns
-------
signal : SpectralQty
The emitted, reflected or transmitted noise
The emitted, reflected or transmitted background radiation
"""
pass