COMPASS  5.4.4
End-to-end AO simulation tool using GPU acceleration
sutraWrap.Dms Class Reference
Collaboration diagram for sutraWrap.Dms:

Public Member Functions

None __init__ (self)
 Create a void DMS object. More...
 
str __str__ (self)
 
int add_dm (self, carmaWrap.context context, str type, float alt, int dim, int nactus, int influsize, int ninflupos, int n_npoints, float push4imat, int nord, float dx, float dy, float thetaML, float G, int device)
 Add a SutraDm in the SutraDms vector. More...
 
int add_dm (self, carmaWrap.context context, str type, float alt, int dim, int nactus, int influsize, int ninflupos, int n_npoints, float push4imat, int nord, int device)
 
int insert_dm (self, carmaWrap.context context, str type, float alt, int dim, int nactus, int influsize, int ninflupos, int n_npoints, float push4imat, int nord, float dx, float dy, float theta, float G, int device, int idx)
 Add a SutraDm in the SutraDms vector at the specified index. More...
 
int remove_dm (self, int idx)
 Remove and delete the selected DM from SutraDms. More...
 
None set_full_com (self, numpy.ndarray[numpy.float32] com, bool shape_dm=True)
 Set the command vector of all DM in SutraDms, and computes the DMs shapes. More...
 

Properties

 d_dms = property
 Vector of SutraDm. More...
 
 nact_total = property
 Total number of actuators in SutraDms. More...
 
 ndm = property
 Number of SutraDm in SutraDms. More...
 

Detailed Description

Definition at line 5049 of file sutraWrap.py.

Constructor & Destructor Documentation

◆ __init__()

None sutraWrap.Dms.__init__ (   self)

Create a void DMS object.

Definition at line 5053 of file sutraWrap.py.

Member Function Documentation

◆ __str__()

str sutraWrap.Dms.__str__ (   self)

Definition at line 5054 of file sutraWrap.py.

◆ add_dm() [1/2]

int sutraWrap.Dms.add_dm (   self,
carmaWrap.context  context,
str  type,
float  alt,
int  dim,
int  nactus,
int  influsize,
int  ninflupos,
int  n_npoints,
float  push4imat,
int  nord,
float  dx,
float  dy,
float  thetaML,
float  G,
int  device 
)

Add a SutraDm in the SutraDms vector.

Parameters
context(CarmaContext) : current carma context
type(str): DM type ("pzt", "kl", or "tt")
alt(float): Conjugaison altitude in meters
dim(long): Support dimension
nactus(long): Number of actuators
influsize(long): Influenction function support size
ninflupos(long): Size of _influpos array
n_npoints(long): Size of _ninflu array
push4imat(float): Voltage to apply for imat computation
nord(long): Number of radial order for kl dm (0 if not kl)
dx(float): X axis misregistration [pixels]
dy(float): Y axis misregistration [pixels]
theta(float): Rotation angle misregistration [radians]
G(float): Magnification factor
device(int): Device index
    Add a SutraDm in the SutraDms vector
Parameters
context(CarmaContext) : current carma context
type(str): DM type ("pzt", "kl", or "tt")
alt(float): Conjugaison altitude in meters
dim(long): Support dimension
nactus(long): Number of actuators
influsize(long): Influenction function support size
ninflupos(long): Size of _influpos array
n_npoints(long): Size of _ninflu array
push4imat(float): Voltage to apply for imat computation
nord(long): Number of radial order for kl dm (0 if not kl)
device(int): Device index

Definition at line 5118 of file sutraWrap.py.

Here is the caller graph for this function:

◆ add_dm() [2/2]

int sutraWrap.Dms.add_dm (   self,
carmaWrap.context  context,
str  type,
float  alt,
int  dim,
int  nactus,
int  influsize,
int  ninflupos,
int  n_npoints,
float  push4imat,
int  nord,
int  device 
)

Definition at line 5120 of file sutraWrap.py.

Here is the call graph for this function:

◆ insert_dm()

int sutraWrap.Dms.insert_dm (   self,
carmaWrap.context  context,
str  type,
float  alt,
int  dim,
int  nactus,
int  influsize,
int  ninflupos,
int  n_npoints,
float  push4imat,
int  nord,
float  dx,
float  dy,
float  theta,
float  G,
int  device,
int  idx 
)

Add a SutraDm in the SutraDms vector at the specified index.

Parameters
context(CarmaContext) : current carma context
type(str): DM type ("pzt", "kl", or "tt")
alt(float): Conjugaison altitude in meters
dim(long): Support dimension
nactus(long): Number of actuators
influsize(long): Influenction function support size
ninflupos(long): Size of _influpos array
n_npoints(long): Size of _ninflu array
push4imat(float): Voltage to apply for imat computation
nord(long): Number of radial order for kl dm (0 if not kl)
dx(float): X axis misregistration [pixels]
dy(float): Y axis misregistration [pixels]
theta(float): Rotation angle misregistration [radians]
G(float): Magnification factor
device(int): Device index
idx(int) : DM index in the vector dms

Definition at line 5158 of file sutraWrap.py.

◆ remove_dm()

int sutraWrap.Dms.remove_dm (   self,
int  idx 
)

Remove and delete the selected DM from SutraDms.

Parameters
idx(int): index of DM

Definition at line 5166 of file sutraWrap.py.

◆ set_full_com()

None sutraWrap.Dms.set_full_com (   self,
numpy.ndarray[numpy.float32]  com,
bool   shape_dm = True 
)

Set the command vector of all DM in SutraDms, and computes the DMs shapes.

Parameters
com(np.array(ndim=1, dtype=np.float32)): Concatened command vectors
shape_dm(bool): (optionnal, default=True) Computes the DM shape

Definition at line 5176 of file sutraWrap.py.

Property Documentation

◆ d_dms

sutraWrap.Dms.d_dms = property
static

Vector of SutraDm.

   @n type of :  typing.List[SutraDm]

Definition at line 5183 of file sutraWrap.py.

◆ nact_total

sutraWrap.Dms.nact_total = property
static

Total number of actuators in SutraDms.

   @n type of :  int

Definition at line 5192 of file sutraWrap.py.

◆ ndm

sutraWrap.Dms.ndm = property
static

Number of SutraDm in SutraDms.

   @n type of :  int

Definition at line 5201 of file sutraWrap.py.


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