TwiceAsNice  2019-02-18
Public Member Functions | Public Attributes | List of all members
laospy.metapupil_I9.MetaPupilDisplay Class Reference
Collaboration diagram for laospy.metapupil_I9.MetaPupilDisplay:
Collaboration graph

Public Member Functions

def __init__ (self, metapupil)
 
def update (self)
 
def continuous_update (self, ccd, nframes=1, boxSize=20, medianSubtract=True, gauss=False)
 
def show_centers (self, display=True)
 
def show_zernike_coefficients (self, display=True)
 
def show_mask (self, display=True)
 
def __init__ (self, metapupil)
 
def update (self)
 
def continuous_update (self, ccd, nframes=1, boxSize=20, medianSubtract=True, gauss=False)
 
def show_centers (self, display=True)
 
def show_zernike_coefficients (self, display=True)
 
def show_mask (self, display=True)
 

Public Attributes

 metapupil
 
 quadImg
 
 crossHairs
 
 fig
 
 grid
 
 coordAnnotation
 
 meanCoordAnnotation
 
 pyramidAngleAnnotation
 
 zernikeAnnotation
 

Detailed Description

Displays metapupil image and statistics

Constructor & Destructor Documentation

◆ __init__() [1/2]

def laospy.metapupil_I9.MetaPupilDisplay.__init__ (   self,
  metapupil 
)
Creates a new metapupil display

Parameters
----------
metapupil : MetaPupil object

◆ __init__() [2/2]

def laospy.metapupil_I9.MetaPupilDisplay.__init__ (   self,
  metapupil 
)
Creates a new metapupil display

Parameters
----------
metapupil : MetaPupil object

Member Function Documentation

◆ continuous_update() [1/2]

def laospy.metapupil_I9.MetaPupilDisplay.continuous_update (   self,
  ccd,
  nframes = 1,
  boxSize = 20,
  medianSubtract = True,
  gauss = False 
)
Continuously updates the metapuil display.  

The live view is stopped with ctrl-c

Parameters
----------
ccd : LittleJoeCamera object
    used to retrieve the images

nFrames : integer
    number of frames over which the returned image is averaged
boxSize : positive integer
    the size of the box to compute the centroid. default value is 40
medianSubtract : bool
    to subtract the median from the image or each quadrant
gauss : bool
    if given will find the gaussian fit of the image passed and return the center 
    coordinates

◆ continuous_update() [2/2]

def laospy.metapupil_I9.MetaPupilDisplay.continuous_update (   self,
  ccd,
  nframes = 1,
  boxSize = 20,
  medianSubtract = True,
  gauss = False 
)
Continuously updates the metapuil display.  

The live view is stopped with ctrl-c

Parameters
----------
ccd : LittleJoeCamera object
    used to retrieve the images

nFrames : integer
    number of frames over which the returned image is averaged
boxSize : positive integer
    the size of the box to compute the centroid. default value is 40
medianSubtract : bool
    to subtract the median from the image or each quadrant
gauss : bool
    if given will find the gaussian fit of the image passed and return the center 
    coordinates

◆ show_centers() [1/2]

def laospy.metapupil_I9.MetaPupilDisplay.show_centers (   self,
  display = True 
)
Display the center coordinates of the brightness distribution in each quadrant

Parameters
----------
display : Boolean
    True if the center coordinates should be visible, false otherwise

◆ show_centers() [2/2]

def laospy.metapupil_I9.MetaPupilDisplay.show_centers (   self,
  display = True 
)
Display the center coordinates of the brightness distribution in each quadrant

Parameters
----------
display : Boolean
    True if the center coordinates should be visible, false otherwise

◆ show_mask() [1/2]

def laospy.metapupil_I9.MetaPupilDisplay.show_mask (   self,
  display = True 
)
Displays the metapupil mask 

Parameters
----------
display : Boolean
    True if the metapupil mask should be visible, false otherwise

◆ show_mask() [2/2]

def laospy.metapupil_I9.MetaPupilDisplay.show_mask (   self,
  display = True 
)
Displays the metapupil mask 

Parameters
----------
display : Boolean
    True if the metapupil mask should be visible, false otherwise

◆ show_zernike_coefficients() [1/2]

def laospy.metapupil_I9.MetaPupilDisplay.show_zernike_coefficients (   self,
  display = True 
)
Displays the Zernike coefficients or the tip tilt, if no metapupil mask is defined.

Parameters
----------
display : Boolean
    True if the tip-tilt should be visible, false otherwise

◆ show_zernike_coefficients() [2/2]

def laospy.metapupil_I9.MetaPupilDisplay.show_zernike_coefficients (   self,
  display = True 
)
Displays the Zernike coefficients or the tip tilt, if no metapupil mask is defined.

Parameters
----------
display : Boolean
    True if the tip-tilt should be visible, false otherwise

◆ update() [1/2]

def laospy.metapupil_I9.MetaPupilDisplay.update (   self)

◆ update() [2/2]

def laospy.metapupil_I9.MetaPupilDisplay.update (   self)

Member Data Documentation

◆ coordAnnotation

laospy.metapupil_I9.MetaPupilDisplay.coordAnnotation

◆ crossHairs

laospy.metapupil_I9.MetaPupilDisplay.crossHairs

◆ fig

laospy.metapupil_I9.MetaPupilDisplay.fig

◆ grid

laospy.metapupil_I9.MetaPupilDisplay.grid

◆ meanCoordAnnotation

laospy.metapupil_I9.MetaPupilDisplay.meanCoordAnnotation

◆ metapupil

laospy.metapupil_I9.MetaPupilDisplay.metapupil

◆ pyramidAngleAnnotation

laospy.metapupil_I9.MetaPupilDisplay.pyramidAngleAnnotation

◆ quadImg

laospy.metapupil_I9.MetaPupilDisplay.quadImg

◆ zernikeAnnotation

laospy.metapupil_I9.MetaPupilDisplay.zernikeAnnotation

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