TwiceAsNice  2019-02-18
Public Member Functions | Public Attributes | Static Public Attributes | Private Member Functions | List of all members
laospy.acquisition.Acquisition Class Reference
Collaboration diagram for laospy.acquisition.Acquisition:
Collaboration graph

Public Member Functions

def __init__ (self, _cfg)
 
def findReferenceStars (self, _targetPositionMap)
 
def spiralSearch (self, _seName, _targetPosition, _biasFrame=None)
 
def centering (self, _seName, _biasFrame=None)
 
def computeTiltToStepsMatrix (self, _seName)
 
def __init__ (self, _cfg)
 
def findReferenceStars (self, _targetPositionMap)
 
def spiralSearch (self, _seName, _targetPosition, _biasFrame=None)
 
def centering (self, _seName, _biasFrame=None)
 
def computeTiltToStepsMatrix (self, _seName)
 

Public Attributes

 config
 
 propertyName
 
 nodeCCD
 
 nodeSE
 
 nodeWFC
 
 camera
 
 ctrlSE
 
 calibrationStepsSizeInUM
 
 gridDimensionInUM
 
 gridSizeX
 
 gridSizeY
 
 abort
 
 centerGain
 
 minTiltX
 
 minTiltY
 
 imageIterationCentering
 
 imageIterationSpiralSearch
 
 seUnit
 
 seCoordSys
 
 illuminationLevel
 
 tiltToUMConvertion
 
 pup
 
 SEMaskBin1
 
 SEMaskBin2
 
 SEMaskBin4
 
 CCDbinning
 
 MetapupilMask
 
 positions
 

Static Public Attributes

 img = self.camera.get_image(self.imageIterationSpiralSearch)
 
 a = a - init_a
 
 b = b - init_b
 
 c = c - init_c
 
 d = d - init_d
 
 best_a
 
 best_b
 
 best_c
 
 best_d
 
 highestFlux = a
 
 bestPosition = positions[_seName]
 
 stepsdx
 
 stepsdy
 
 s
 
 ds
 
 stepsX
 
 stepsY
 

Private Member Functions

def __measureTilt (self, _seName, _distance)
 
def __convertTiltToSteps (self, _tiltX, _tiltY)
 
def __measureTilt (self, _seName, _distance)
 
def __convertTiltToSteps (self, _tiltX, _tiltY)
 

Constructor & Destructor Documentation

◆ __init__() [1/2]

def laospy.acquisition.Acquisition.__init__ (   self,
  _cfg 
)

◆ __init__() [2/2]

def laospy.acquisition.Acquisition.__init__ (   self,
  _cfg 
)

Member Function Documentation

◆ __convertTiltToSteps() [1/2]

def laospy.acquisition.Acquisition.__convertTiltToSteps (   self,
  _tiltX,
  _tiltY 
)
private

◆ __convertTiltToSteps() [2/2]

def laospy.acquisition.Acquisition.__convertTiltToSteps (   self,
  _tiltX,
  _tiltY 
)
private

◆ __measureTilt() [1/2]

def laospy.acquisition.Acquisition.__measureTilt (   self,
  _seName,
  _distance 
)
private

◆ __measureTilt() [2/2]

def laospy.acquisition.Acquisition.__measureTilt (   self,
  _seName,
  _distance 
)
private

◆ centering() [1/2]

def laospy.acquisition.Acquisition.centering (   self,
  _seName,
  _biasFrame = None 
) 
The centering routine will center the SE till the measured tilt is below
the required value. In case the the required tilt value is not reachable
the routine stops when the maximal number of iterations is reached.

needed Properties
-----------------
_seName                      the name of the StarEnlarger
CFG.CCD.MIN_TILTX            the required tilt in X direction (have to be greater than 0)
CFG.CCD.MIN_TILTY            the required tilt in Y direction (have to be greater than 0)
CFG.CCD.IMAGE_ITERATION      the number of image that should be take to compute the image mean value (have to be greater than 0)
CFG.SE.CENTERING_ITERATION   maximal number of iteration till the routine aboard (have to be greater than 0)

◆ centering() [2/2]

def laospy.acquisition.Acquisition.centering (   self,
  _seName,
  _biasFrame = None 
) 
The centering routine will center the SE till the measured tilt is below
the required value. In case the the required tilt value is not reachable
the routine stops when the maximal number of iterations is reached.

needed Properties
-----------------
_seName                      the name of the StarEnlarger
CFG.CCD.MIN_TILTX            the required tilt in X direction (have to be greater than 0)
CFG.CCD.MIN_TILTY            the required tilt in Y direction (have to be greater than 0)
CFG.CCD.IMAGE_ITERATION      the number of image that should be take to compute the image mean value (have to be greater than 0)
CFG.SE.CENTERING_ITERATION   maximal number of iteration till the routine aboard (have to be greater than 0)

◆ computeTiltToStepsMatrix() [1/2]

def laospy.acquisition.Acquisition.computeTiltToStepsMatrix (   self,
  _seName 
) 
This routine measures the tilt at a certain distance in X direction and
Y direction from the current position. The current position have to be 
the SE position where the reference star is well centered and all pupils
are equal illuminated. The tilt to steps matrix will be returned after the
measurement.

needed Properties
----------------- 
_seName                              the name of the StarEnlarger
CFG.SE.calibrationStepsSizeInUM      step size in X (have to be greater than 0)
CFG.CCD.ILLUMINATION_LEVEL           collected light above that threshold will abort that method (have to be greater than 0)

◆ computeTiltToStepsMatrix() [2/2]

def laospy.acquisition.Acquisition.computeTiltToStepsMatrix (   self,
  _seName 
) 
This routine measures the tilt at a certain distance in X direction and
Y direction from the current position. The current position have to be 
the SE position where the reference star is well centered and all pupils
are equal illuminated. The tilt to steps matrix will be returned after the
measurement.

needed Properties
----------------- 
_seName                              the name of the StarEnlarger
CFG.SE.calibrationStepsSizeInUM      step size in X (have to be greater than 0)
CFG.CCD.ILLUMINATION_LEVEL           collected light above that threshold will abort that method (have to be greater than 0)

◆ findReferenceStars() [1/2]

def laospy.acquisition.Acquisition.findReferenceStars (   self,
  _targetPositionMap 
) 
This method will move all SE's of the VAR.SE.TARGET_POSITION_MAP to its 
target position and starts the spiralSearch as well as the centering routing.

needed Properties
-----------------
_targetPositionMap           the SE's with the corresponding target positions
CFG.SE.STEP_SIZE_IN_UM       step size in UM (have to be greater than 0)
CFG.SE.GRID_SIZE_X           the amount of iteration on X axis (have to be greater than 0)
CFG.SE.GRID_SIZE_Y           the amount of iteration on Y axis (have to be greater than 0)
CFG.SE.CENTERING_ITERATION   maximal number of iteration till the routine aboard (have to be greater than 0)       
CFG.CCD.ILLUMINATION_LEVEL   collected light above that threshold will aboard that method (have to be greater than 0)
CFG.CCD.IMAGE_ITERATION      the number of image that should be take to compute the image mean value (have to be greater than 0)
CFG.CCD.MIN_TILTX            the required tilt in X direction (have to be greater than 0)
CFG.CCD.MIN_TILTY            the required tilt in Y direction (have to be greater than 0)

◆ findReferenceStars() [2/2]

def laospy.acquisition.Acquisition.findReferenceStars (   self,
  _targetPositionMap 
) 
This method will move all SE's of the VAR.SE.TARGET_POSITION_MAP to its 
target position and starts the spiralSearch as well as the centering routing.

needed Properties
-----------------
_targetPositionMap           the SE's with the corresponding target positions
CFG.SE.STEP_SIZE_IN_UM       step size in UM (have to be greater than 0)
CFG.SE.GRID_SIZE_X           the amount of iteration on X axis (have to be greater than 0)
CFG.SE.GRID_SIZE_Y           the amount of iteration on Y axis (have to be greater than 0)
CFG.SE.CENTERING_ITERATION   maximal number of iteration till the routine aboard (have to be greater than 0)       
CFG.CCD.ILLUMINATION_LEVEL   collected light above that threshold will aboard that method (have to be greater than 0)
CFG.CCD.IMAGE_ITERATION      the number of image that should be take to compute the image mean value (have to be greater than 0)
CFG.CCD.MIN_TILTX            the required tilt in X direction (have to be greater than 0)
CFG.CCD.MIN_TILTY            the required tilt in Y direction (have to be greater than 0)

◆ spiralSearch() [1/2]

def laospy.acquisition.Acquisition.spiralSearch (   self,
  _seName,
  _targetPosition,
  _biasFrame = None 
) 
The StarEnlarger VAR.SE.NAME will move in a spiral around the 
VAR.SE.TARGET_POSITION in order to find light on the CCD. The steps size
is given in UM by CFG.SE.STEP_SIZE_IN_UM.
The method stops searching when the light intensity exceed the given 
CFG.CCD.ILLUMINATION_LEVEL at the border of the pupil mask.

needed Properties
----------------- 
_seName                    the name of the StarEnlarger
_targetPosition            around that absolute position the StarEnalrger will do the spiral search
CFG.SE.STEP_SIZE_IN_UM     step size in UM (have to be greater than 0)
CFG.SE.GRID_SIZE_X         the amount of iteration on X axis (have to be greater than 0)
CFG.SE.GRID_SIZE_Y         the amount of iteration on Y axis (have to be greater than 0)
CFG.CCD.ILLUMINATION_LEVEL collected light above that threshold will aboard that method (have to be greater than 0)
CFG.CCD.IMAGE_ITERATION    the number of image that should be take to compute the image mean value (have to be greater than 0)

◆ spiralSearch() [2/2]

def laospy.acquisition.Acquisition.spiralSearch (   self,
  _seName,
  _targetPosition,
  _biasFrame = None 
) 
The StarEnlarger VAR.SE.NAME will move in a spiral around the 
VAR.SE.TARGET_POSITION in order to find light on the CCD. The steps size
is given in UM by CFG.SE.STEP_SIZE_IN_UM.
The method stops searching when the light intensity exceed the given 
CFG.CCD.ILLUMINATION_LEVEL at the border of the pupil mask.

needed Properties
----------------- 
_seName                    the name of the StarEnlarger
_targetPosition            around that absolute position the StarEnalrger will do the spiral search
CFG.SE.STEP_SIZE_IN_UM     step size in UM (have to be greater than 0)
CFG.SE.GRID_SIZE_X         the amount of iteration on X axis (have to be greater than 0)
CFG.SE.GRID_SIZE_Y         the amount of iteration on Y axis (have to be greater than 0)
CFG.CCD.ILLUMINATION_LEVEL collected light above that threshold will aboard that method (have to be greater than 0)
CFG.CCD.IMAGE_ITERATION    the number of image that should be take to compute the image mean value (have to be greater than 0)

Member Data Documentation

◆ a

laospy.acquisition.Acquisition.a = a - init_a
static

◆ abort

laospy.acquisition.Acquisition.abort

◆ b

laospy.acquisition.Acquisition.b = b - init_b
static

◆ best_a

laospy.acquisition.Acquisition.best_a
static

◆ best_b

laospy.acquisition.Acquisition.best_b
static

◆ best_c

laospy.acquisition.Acquisition.best_c
static

◆ best_d

laospy.acquisition.Acquisition.best_d
static

◆ bestPosition

laospy.acquisition.Acquisition.bestPosition = positions[_seName]
static

◆ c

laospy.acquisition.Acquisition.c = c - init_c
static

◆ calibrationStepsSizeInUM

laospy.acquisition.Acquisition.calibrationStepsSizeInUM

◆ camera

laospy.acquisition.Acquisition.camera

◆ CCDbinning

laospy.acquisition.Acquisition.CCDbinning

◆ centerGain

laospy.acquisition.Acquisition.centerGain

◆ config

laospy.acquisition.Acquisition.config

◆ ctrlSE

laospy.acquisition.Acquisition.ctrlSE

◆ d

laospy.acquisition.Acquisition.d = d - init_d
static

◆ ds

laospy.acquisition.Acquisition.ds
static

◆ gridDimensionInUM

laospy.acquisition.Acquisition.gridDimensionInUM

◆ gridSizeX

laospy.acquisition.Acquisition.gridSizeX

◆ gridSizeY

laospy.acquisition.Acquisition.gridSizeY

◆ highestFlux

laospy.acquisition.Acquisition.highestFlux = a
static

◆ illuminationLevel

laospy.acquisition.Acquisition.illuminationLevel

◆ imageIterationCentering

laospy.acquisition.Acquisition.imageIterationCentering

◆ imageIterationSpiralSearch

laospy.acquisition.Acquisition.imageIterationSpiralSearch

◆ img

laospy.acquisition.Acquisition.img = self.camera.get_image(self.imageIterationSpiralSearch)
static

◆ MetapupilMask

laospy.acquisition.Acquisition.MetapupilMask

◆ minTiltX

laospy.acquisition.Acquisition.minTiltX

◆ minTiltY

laospy.acquisition.Acquisition.minTiltY

◆ nodeCCD

laospy.acquisition.Acquisition.nodeCCD

◆ nodeSE

laospy.acquisition.Acquisition.nodeSE

◆ nodeWFC

laospy.acquisition.Acquisition.nodeWFC

◆ positions

laospy.acquisition.Acquisition.positions

◆ propertyName

laospy.acquisition.Acquisition.propertyName

◆ pup

laospy.acquisition.Acquisition.pup

◆ s

laospy.acquisition.Acquisition.s
static

◆ seCoordSys

laospy.acquisition.Acquisition.seCoordSys

◆ SEMaskBin1

laospy.acquisition.Acquisition.SEMaskBin1

◆ SEMaskBin2

laospy.acquisition.Acquisition.SEMaskBin2

◆ SEMaskBin4

laospy.acquisition.Acquisition.SEMaskBin4

◆ seUnit

laospy.acquisition.Acquisition.seUnit

◆ stepsdx

laospy.acquisition.Acquisition.stepsdx
static

◆ stepsdy

laospy.acquisition.Acquisition.stepsdy
static

◆ stepsX

laospy.acquisition.Acquisition.stepsX
static

◆ stepsY

laospy.acquisition.Acquisition.stepsY
static

◆ tiltToUMConvertion

laospy.acquisition.Acquisition.tiltToUMConvertion
The documentation for this class was generated from the following file:
Generated on Mon Feb 18 2019 14:16:16 for TwiceAsNice by   doxygen 1.8.14