P-Class (parametres) Param_atmos. More...

Collaboration diagram for shesha.config.PATMOS.Param_atmos:

Public Member Functions
def	__init__ (self)
	Number of turbulent layers. More...

def	get_nscreens (self)
	Set the number of turbulent layers. More...

def	set_nscreens (self, n)
	Set the number of turbulent layers. More...

def	get_r0 (self)
	Get the global r0. More...

def	set_r0 (self, r)
	Set the global r0. More...

def	get_pupixsize (self)
	Get the pupil pixel size. More...

def	set_pupixsize (self, xsize)
	Set the pupil pixel size. More...

def	get_L0 (self)
	Get the L0 per layers. More...

def	set_L0 (self, l)
	Set the L0 per layers. More...

def	get_dim_screens (self)
	Get the size of the phase screens. More...

def	set_dim_screens (self, l)
	Set the size of the phase screens. More...

def	get_alt (self)
	Get the altitudes of each layer. More...

def	set_alt (self, h)
	Set the altitudes of each layer. More...

def	get_winddir (self)
	Get the wind direction for each layer. More...

def	set_winddir (self, l)
	Set the wind direction for each layer. More...

def	get_windspeed (self)
	Get the the wind speed for each layer. More...

def	set_windspeed (self, l)
	Set the the wind speed for each layer. More...

def	get_frac (self)
	Get the fraction of r0 for each layers. More...

def	set_frac (self, l)
	Set the fraction of r0 for each layers. More...

def	get_deltax (self)
	Get the translation speed on axis x for each layer. More...

def	set_deltax (self, l)
	Set the translation speed on axis x for each layer. More...

def	get_deltay (self)
	Get the translation speed on axis y for each layer. More...

def	set_deltay (self, l)
	Set the translation speed on axis y for each layer. More...

def	get_seeds (self)
	Get the seed for each layer. More...

def	set_seeds (self, l)
	Set the seed for each layer. More...

Properties
	nscreens = property(get_nscreens, set_nscreens)

	r0 = property(get_r0, set_r0)

	pupixsize = property(get_pupixsize, set_pupixsize)

	L0 = property(get_L0, set_L0)

	dim_screens = property(get_dim_screens, set_dim_screens)

	alt = property(get_alt, set_alt)

	winddir = property(get_winddir, set_winddir)

	windspeed = property(get_windspeed, set_windspeed)

	frac = property(get_frac, set_frac)

	seeds = property(get_seeds, set_seeds)

Detailed Description

P-Class (parametres) Param_atmos.

Definition at line 46 of file PATMOS.py.

Constructor & Destructor Documentation

◆ init()

def shesha.config.PATMOS.Param_atmos.__init__ ( self )

Number of turbulent layers.

Definition at line 49 of file PATMOS.py.

         """ Number of turbulent layers."""
         self.__nscreens = 0
         """ Global r0."""
         self.__r0 = None
         """ Pupil pixel size (in meters)."""
         self.__pupixsize = None
         """ L0 per layers in meters."""
         self.__L0 = None
         """ Linear size of phase screens."""
         self.__dim_screens = None
         """ Altitudes of each layer."""
         self.__alt = None
         """ Wind directions of each layer."""
         self.__winddir = None
         """ Wind speeds of each layer."""
         self.__windspeed = None
         """ Fraction of r0 for each layer."""
         self.__frac = None
         """ x translation speed (in pix / iteration) for each layer."""
         self.__deltax = None
         """ y translation speed (in pix / iteration) for each layer."""
         self.__deltay = None
         """ RNG Seeds for each layer."""
         self.__seeds = None
  

Member Function Documentation

◆ get_alt()

def shesha.config.PATMOS.Param_atmos.get_alt ( self )

Get the altitudes of each layer.

   :return: (lit of float) : altitudes

Definition at line 160 of file PATMOS.py.

160 """

161 return self.__alt

162

◆ get_deltax()

def shesha.config.PATMOS.Param_atmos.get_deltax ( self )

Get the translation speed on axis x for each layer.

   :return: (lit of float) : translation speed

Definition at line 228 of file PATMOS.py.

228 """

229 return self.__deltax

230

◆ get_deltay()

def shesha.config.PATMOS.Param_atmos.get_deltay ( self )

Get the translation speed on axis y for each layer.

   :return: (lit of float) : translation speed

Definition at line 248 of file PATMOS.py.

248 def set_deltay(self, l):

249 """ Set the translation speed on axis y for each layer

250

◆ get_dim_screens()

def shesha.config.PATMOS.Param_atmos.get_dim_screens ( self )

Get the size of the phase screens.

   :return: (lit of float) : phase screens sizes

Definition at line 143 of file PATMOS.py.

143 """

144 return self.__dim_screens

145

◆ get_frac()

def shesha.config.PATMOS.Param_atmos.get_frac ( self )

Get the fraction of r0 for each layers.

   :return: (lit of float) : fraction of r0

Definition at line 211 of file PATMOS.py.

211 """

212 return self.__frac

213

◆ get_L0()

def shesha.config.PATMOS.Param_atmos.get_L0 ( self )

Get the L0 per layers.

   :return: (lit of float) : L0 for each layers

Definition at line 126 of file PATMOS.py.

126 """

127 return self.__L0

128

◆ get_nscreens()

def shesha.config.PATMOS.Param_atmos.get_nscreens ( self )

Set the number of turbulent layers.

   :return: (long) number of screens.

Definition at line 78 of file PATMOS.py.

78 """

79 return self.__nscreens

80

◆ get_pupixsize()

def shesha.config.PATMOS.Param_atmos.get_pupixsize ( self )

Get the pupil pixel size.

   :return: (float) : pupil pixel size

Definition at line 110 of file PATMOS.py.

110 """

111 return self.__pupixsize

112

◆ get_r0()

def shesha.config.PATMOS.Param_atmos.get_r0 ( self )

Get the global r0.

   :return: (float) : global r0

Definition at line 94 of file PATMOS.py.

94 """

95 return self.__r0

96

◆ get_seeds()

def shesha.config.PATMOS.Param_atmos.get_seeds ( self )

Get the seed for each layer.

   :return: (lit of int) : seed

Definition at line 268 of file PATMOS.py.

268 :param l: (lit of int) : seed

269 """

270 self.__seeds = csu.enforce_array(l, size=self.nscreens, dtype=np.int64,

◆ get_winddir()

def shesha.config.PATMOS.Param_atmos.get_winddir ( self )

Get the wind direction for each layer.

   :return: (lit of float) : wind directions

Definition at line 177 of file PATMOS.py.

177 """

178 return self.__winddir

179

◆ get_windspeed()

def shesha.config.PATMOS.Param_atmos.get_windspeed ( self )

Get the the wind speed for each layer.

   :return: (list of float) : wind speeds

Definition at line 194 of file PATMOS.py.

194 """

195 return self.__windspeed

196

◆ set_alt()

def shesha.config.PATMOS.Param_atmos.set_alt	(	self,
		h
	)

Set the altitudes of each layer.

   :param h: (lit of float) : altitudes

Definition at line 167 of file PATMOS.py.

167 """

168 self.__alt = csu.enforce_array(h, size=self.nscreens, dtype=np.float32,

169 scalar_expand=False)

170

◆ set_deltax()

def shesha.config.PATMOS.Param_atmos.set_deltax	(	self,
		l
	)

Set the translation speed on axis x for each layer.

   :param l: (lit of float) : translation speed

Definition at line 235 of file PATMOS.py.

235 """

236 self.__deltax = csu.enforce_array(l, size=self.nscreens, dtype=np.float32,

237 scalar_expand=True)

238

◆ set_deltay()

def shesha.config.PATMOS.Param_atmos.set_deltay	(	self,
		l
	)

Set the translation speed on axis y for each layer.

   :param l: (lit of float) : translation speed

Definition at line 255 of file PATMOS.py.

  
     _deltay = property(get_deltay, set_deltay)
  
     def get_seeds(self):

◆ set_dim_screens()

def shesha.config.PATMOS.Param_atmos.set_dim_screens	(	self,
		l
	)

Set the size of the phase screens.

   :param l: (lit of float) : phase screens sizes

Definition at line 150 of file PATMOS.py.

150 """

151 self.__dim_screens = csu.enforce_array(l, size=self.nscreens, dtype=np.int64,

152 scalar_expand=False)

153

◆ set_frac()

def shesha.config.PATMOS.Param_atmos.set_frac	(	self,
		l
	)

Set the fraction of r0 for each layers.

   :param l: (lit of float) : fraction of r0

Definition at line 218 of file PATMOS.py.

218 """

219 self.__frac = csu.enforce_array(l, size=self.nscreens, dtype=np.float32,

220 scalar_expand=True)

221

◆ set_L0()

def shesha.config.PATMOS.Param_atmos.set_L0	(	self,
		l
	)

Set the L0 per layers.

   :param l: (lit of float) : L0 for each layers

Definition at line 133 of file PATMOS.py.

133 """

134 self.__L0 = csu.enforce_array(l, size=self.nscreens, dtype=np.float32,

135 scalar_expand=True)

136

◆ set_nscreens()

def shesha.config.PATMOS.Param_atmos.set_nscreens	(	self,
		n
	)

Set the number of turbulent layers.

   :param n: (long) number of screens.

Definition at line 85 of file PATMOS.py.

85 """

86 self.__nscreens = csu.enforce_int(n)

87

◆ set_pupixsize()

def shesha.config.PATMOS.Param_atmos.set_pupixsize	(	self,
		xsize
	)

Set the pupil pixel size.

   :param xsize: (float) : pupil pixel size

Definition at line 117 of file PATMOS.py.

117 """

118 self.__pupixsize = csu.enforce_float(xsize)

119

◆ set_r0()

def shesha.config.PATMOS.Param_atmos.set_r0	(	self,
		r
	)

Set the global r0.

   :param r: (float) : global r0

Definition at line 101 of file PATMOS.py.

101 """

102 self.__r0 = csu.enforce_float(r)

103

◆ set_seeds()

def shesha.config.PATMOS.Param_atmos.set_seeds	(	self,
		l
	)

Set the seed for each layer.

   :param l: (lit of int) : seed

Definition at line 275 of file PATMOS.py.

◆ set_winddir()

def shesha.config.PATMOS.Param_atmos.set_winddir	(	self,
		l
	)

Set the wind direction for each layer.

   :param l: (lit of float) : wind directions

Definition at line 184 of file PATMOS.py.

184 """

185 self.__winddir = csu.enforce_array(l, size=self.nscreens, dtype=np.float32,

186 scalar_expand=True)

187

◆ set_windspeed()

def shesha.config.PATMOS.Param_atmos.set_windspeed	(	self,
		l
	)

Set the the wind speed for each layer.

   :param l: (list of float) : wind speeds

Definition at line 201 of file PATMOS.py.

201 """

202 self.__windspeed = csu.enforce_array(l, size=self.nscreens, dtype=np.float32,

203 scalar_expand=True)

204

Property Documentation

◆ alt

shesha.config.PATMOS.Param_atmos.alt = property(get_alt, set_alt)

static

Definition at line 171 of file PATMOS.py.

◆ dim_screens

shesha.config.PATMOS.Param_atmos.dim_screens = property(get_dim_screens, set_dim_screens)

static

Definition at line 154 of file PATMOS.py.

◆ frac

shesha.config.PATMOS.Param_atmos.frac = property(get_frac, set_frac)

static

Definition at line 222 of file PATMOS.py.

◆ L0

shesha.config.PATMOS.Param_atmos.L0 = property(get_L0, set_L0)

static

Definition at line 137 of file PATMOS.py.

◆ nscreens

shesha.config.PATMOS.Param_atmos.nscreens = property(get_nscreens, set_nscreens)

static

Definition at line 88 of file PATMOS.py.

◆ pupixsize

shesha.config.PATMOS.Param_atmos.pupixsize = property(get_pupixsize, set_pupixsize)

static

Definition at line 120 of file PATMOS.py.

◆ r0

shesha.config.PATMOS.Param_atmos.r0 = property(get_r0, set_r0)

static

Definition at line 104 of file PATMOS.py.

◆ seeds

shesha.config.PATMOS.Param_atmos.seeds = property(get_seeds, set_seeds)

static

Definition at line 279 of file PATMOS.py.

◆ winddir

shesha.config.PATMOS.Param_atmos.winddir = property(get_winddir, set_winddir)

static

Definition at line 188 of file PATMOS.py.

◆ windspeed

shesha.config.PATMOS.Param_atmos.windspeed = property(get_windspeed, set_windspeed)

static

Definition at line 205 of file PATMOS.py.

The documentation for this class was generated from the following file:

PATMOS.py

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_alt()

◆ get_deltax()

◆ get_deltay()

◆ get_dim_screens()

◆ get_frac()

◆ get_L0()

◆ get_nscreens()

◆ get_pupixsize()

◆ get_r0()

◆ get_seeds()

◆ get_winddir()

◆ get_windspeed()

◆ set_alt()

◆ set_deltax()

◆ set_deltay()

◆ set_dim_screens()

◆ set_frac()

◆ set_L0()

◆ set_nscreens()

◆ set_pupixsize()

◆ set_r0()

◆ set_seeds()

◆ set_winddir()

◆ set_windspeed()

Property Documentation

◆ alt

◆ dim_screens

◆ frac

◆ L0

◆ nscreens

◆ pupixsize

◆ r0

◆ seeds

◆ winddir

◆ windspeed

◆ init()