From 1734bd7c4a6030873c7b023eabeebc7acf1df6dc Mon Sep 17 00:00:00 2001 From: Matthew Townson Date: Tue, 14 Jul 2020 14:08:01 +0100 Subject: [PATCH] Updated docstrings to state units of phase screen is radians Signed-off-by: Matthew Townson --- aotools/turbulence/infinitephasescreen.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/aotools/turbulence/infinitephasescreen.py b/aotools/turbulence/infinitephasescreen.py index 25e04d7..5f926ce 100644 --- a/aotools/turbulence/infinitephasescreen.py +++ b/aotools/turbulence/infinitephasescreen.py @@ -207,7 +207,7 @@ def add_row(self): @property def scrn(self): """ - The current phase map held in the PhaseScreen object. + The current phase map held in the PhaseScreen object in radians. """ return self._scrn[:self.requested_nx_size, :self.requested_nx_size] @@ -253,7 +253,7 @@ class PhaseScreenVonKarman(PhaseScreen): On initialisation an initial phase screen is calculated using an FFT based method. When ``add_row`` is called, a new vector of phase is added to the phase screen using `nCols` columns of previous phase. Assemat & Wilson claim that two columns are adequate for good - atmospheric statistics. The phase in the screen data is always accessed as ``.scrn``. + atmospheric statistics. The phase in the screen data is always accessed as ``.scrn`` and is in radians. Parameters: nx_size (int): Size of phase screen (NxN) @@ -361,7 +361,7 @@ class PhaseScreenKolmogorov(PhaseScreen): On initialisation an initial phase screen is calculated using an FFT based method. When ``add_row`` is called, a new vector of phase is added to the phase screen. The phase in the screen data - is always accessed as ``.scrn``. + is always accessed as ``.scrn`` and is in radians. Parameters: nx_size (int): Size of phase screen (NxN)