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

Public Member Functions

def __init__ (self, _con)
 
def state (self)
 
def stop (self)
 
def readEndless (self)
 
def get_program (self)
 
def set_program (self, program)
 
def get_attenuation (self)
 
def set_attenuation (self, attenuation)
 
def get_image (self, nFrames=1, _checkZero=False, _async=None)
 
def calibrate_bias_frame (self, skipEdge=3, trimLevel=0.2, nFrames=10)
 
def set_bias_frame (self, frame)
 
def get_channel_mean (self, skipEdge, trimLevel, nFrames=10, _async=None)
 
def align_channel_bias (self, biasTargetLevel=200, biasIncrement=50, maxBiasProbe=1000, nFrames=10, skipEdge=3, trimLevel=0.2, biasStart=0, _async=None)
 
def calibrate_program_channel_bias (self, filename, programs, biasTargetLevel=100, biasIncrement=50, maxBiasProbe=1000, nFrames=10, skipEdge=3, trimLevel=0.2, biasStart=0)
 
def __init__ (self, _con)
 
def state (self)
 
def stop (self)
 
def readEndless (self)
 
def get_program (self)
 
def set_program (self, program)
 
def get_attenuation (self)
 
def set_attenuation (self, attenuation)
 
def get_image (self, nFrames=1, _checkZero=False, _async=None)
 
def calibrate_bias_frame (self, skipEdge=3, trimLevel=0.2, nFrames=10)
 
def set_bias_frame (self, frame)
 
def get_channel_mean (self, skipEdge, trimLevel, nFrames=10, _async=None)
 
def align_channel_bias (self, biasTargetLevel=200, biasIncrement=50, maxBiasProbe=1000, nFrames=10, skipEdge=3, trimLevel=0.2, biasStart=0, _async=None)
 
def calibrate_program_channel_bias (self, filename, programs, biasTargetLevel=100, biasIncrement=50, maxBiasProbe=1000, nFrames=10, skipEdge=3, trimLevel=0.2, biasStart=0)
 

Public Attributes

 ctrl
 
 nChanRows
 
 nChanCols
 
 nChannels
 
 channelIndex
 

Static Public Attributes

int nChannels = 0
 
int nChanRows = 0
 
int nChanCols = 0
 
string node = ''
 
 biasFrame = None
 

Detailed Description

High-level calibration and operation methods for CCD39, CCD47, and CCD50.

Constructor & Destructor Documentation

◆ __init__() [1/2]

def laospy.camera.LittleJoeCamera.__init__ (   self,
  _con 
)
Initializes the LittleJoeCamera object

Parameters (2 alternatives)
----------
_con: string
    ccd Service node as defined in the alias file

_con: connected ctrl interface
    ccd Ctrl Service

◆ __init__() [2/2]

def laospy.camera.LittleJoeCamera.__init__ (   self,
  _con 
)
Initializes the LittleJoeCamera object

Parameters (2 alternatives)
----------
_con: string
    ccd Service node as defined in the alias file

_con: connected ctrl interface
    ccd Ctrl Service

Member Function Documentation

◆ align_channel_bias() [1/2]

def laospy.camera.LittleJoeCamera.align_channel_bias (   self,
  biasTargetLevel = 200,
  biasIncrement = 50,
  maxBiasProbe = 1000,
  nFrames = 10,
  skipEdge = 3,
  trimLevel = 0.2,
  biasStart = 0,
  _async = None 
)
Equalizes the bias level for all channels of the CCD

Parameters
----------
biasTargetLevel : int
    the approximate bias level for all channels after alignment


biasIncrement : int
    the steps in which the  bias setting is increased while probing the response

maxBiasProbe :  int
    the highest value for the bias setting.

nFrames : int
    the number of images over which the response is averaged

skipEdge : int
    the number of pixel columns and rows around the edge of each channel to be excluded
    from the bias level detection

trimLevel : float (0..1)
    the percentage of pixel values at the upper and lower end of the histogram to be
    ignored in the determination of the bias level (to exclude dead pixels)

biasStart : int
    the starting value for the bias setting

◆ align_channel_bias() [2/2]

def laospy.camera.LittleJoeCamera.align_channel_bias (   self,
  biasTargetLevel = 200,
  biasIncrement = 50,
  maxBiasProbe = 1000,
  nFrames = 10,
  skipEdge = 3,
  trimLevel = 0.2,
  biasStart = 0,
  _async = None 
)
Equalizes the bias level for all channels of the CCD

Parameters
----------
biasTargetLevel : int
    the approximate bias level for all channels after alignment


biasIncrement : int
    the steps in which the  bias setting is increased while probing the response

maxBiasProbe :  int
    the highest value for the bias setting.

nFrames : int
    the number of images over which the response is averaged

skipEdge : int
    the number of pixel columns and rows around the edge of each channel to be excluded
    from the bias level detection

trimLevel : float (0..1)
    the percentage of pixel values at the upper and lower end of the histogram to be
    ignored in the determination of the bias level (to exclude dead pixels)

biasStart : int
    the starting value for the bias setting

◆ calibrate_bias_frame() [1/2]

def laospy.camera.LittleJoeCamera.calibrate_bias_frame (   self,
  skipEdge = 3,
  trimLevel = 0.2,
  nFrames = 10 
)
Calibrates the bias frame

Run this calibration with all lights off!

Parameters
----------
skipEdge : int
    the number of pixel columns and rows around the edge of each channel to be excluded
    from the bias level detection

trimLevel : float (0..1)
    the percentage of pixel values at the upper and lower end of the histogram to be
    ignored in the determination of the bias level (to exclude dead pixels)

nFrames : integer (default = 10)
    number of frames over which the mean image is calculated

◆ calibrate_bias_frame() [2/2]

def laospy.camera.LittleJoeCamera.calibrate_bias_frame (   self,
  skipEdge = 3,
  trimLevel = 0.2,
  nFrames = 10 
)
Calibrates the bias frame

Run this calibration with all lights off!

Parameters
----------
skipEdge : int
    the number of pixel columns and rows around the edge of each channel to be excluded
    from the bias level detection

trimLevel : float (0..1)
    the percentage of pixel values at the upper and lower end of the histogram to be
    ignored in the determination of the bias level (to exclude dead pixels)

nFrames : integer (default = 10)
    number of frames over which the mean image is calculated

◆ calibrate_program_channel_bias() [1/2]

def laospy.camera.LittleJoeCamera.calibrate_program_channel_bias (   self,
  filename,
  programs,
  biasTargetLevel = 100,
  biasIncrement = 50,
  maxBiasProbe = 1000,
  nFrames = 10,
  skipEdge = 3,
  trimLevel = 0.2,
  biasStart = 0 
)
Determines the bias levels for each combination of program and attenuation

Parameters
----------
filename : string
    name of the logfile

programs : list of int
    programs to be considered in the calibration

biasTargetLevel: int
    the approximate bias level for all channels after alignment

biasIncrement : int
    the steps in which the  bias setting is increased while probing the response

maxBiasProbe :  int
    the highest value for the bias setting.

nFrames : int
    the number of images over which the response is averaged

skipEdge : int
    the number of pixel columns and rows around the edge of each channel to be excluded
    from the bias level detection

trimLevel : float (0..1)
    the percentage of pixel values at the upper and lower end of the histogram to be
    ignored in the determination of the bias level (to exclude dead pixels)

biasStart : int
    the starting value for the bias setting

◆ calibrate_program_channel_bias() [2/2]

def laospy.camera.LittleJoeCamera.calibrate_program_channel_bias (   self,
  filename,
  programs,
  biasTargetLevel = 100,
  biasIncrement = 50,
  maxBiasProbe = 1000,
  nFrames = 10,
  skipEdge = 3,
  trimLevel = 0.2,
  biasStart = 0 
)
Determines the bias levels for each combination of program and attenuation

Parameters
----------
filename : string
    name of the logfile

programs : list of int
    programs to be considered in the calibration

biasTargetLevel: int
    the approximate bias level for all channels after alignment

biasIncrement : int
    the steps in which the  bias setting is increased while probing the response

maxBiasProbe :  int
    the highest value for the bias setting.

nFrames : int
    the number of images over which the response is averaged

skipEdge : int
    the number of pixel columns and rows around the edge of each channel to be excluded
    from the bias level detection

trimLevel : float (0..1)
    the percentage of pixel values at the upper and lower end of the histogram to be
    ignored in the determination of the bias level (to exclude dead pixels)

biasStart : int
    the starting value for the bias setting

◆ get_attenuation() [1/2]

def laospy.camera.LittleJoeCamera.get_attenuation (   self)

◆ get_attenuation() [2/2]

def laospy.camera.LittleJoeCamera.get_attenuation (   self)

◆ get_channel_mean() [1/2]

def laospy.camera.LittleJoeCamera.get_channel_mean (   self,
  skipEdge,
  trimLevel,
  nFrames = 10,
  _async = None 
)
Gets an image and finds the mean of each channel

Parameters
----------
skipEdge : int
    the number of pixel columns and rows around the edge of each channel to be excluded
    from the bias level detection

trimLevel : float (0..1)
    the percentage of pixel values at the upper and lower end of the histogram to be
    ignored in the determination of the bias level (to exclude dead pixels)

nFrames : int
    the number of images over which the response is averaged

◆ get_channel_mean() [2/2]

def laospy.camera.LittleJoeCamera.get_channel_mean (   self,
  skipEdge,
  trimLevel,
  nFrames = 10,
  _async = None 
)
Gets an image and finds the mean of each channel

Parameters
----------
skipEdge : int
    the number of pixel columns and rows around the edge of each channel to be excluded
    from the bias level detection

trimLevel : float (0..1)
    the percentage of pixel values at the upper and lower end of the histogram to be
    ignored in the determination of the bias level (to exclude dead pixels)

nFrames : int
    the number of images over which the response is averaged

◆ get_image() [1/2]

def laospy.camera.LittleJoeCamera.get_image (   self,
  nFrames = 1,
  _checkZero = False,
  _async = None 
)
Returns an image from the LittleJoe Camera

Optionally the image is averaged over several frames. Bias correction is applied if a bias
frame is set.

Parameters
----------
nFrames : integer
    number of frames over which the returned image is averaged
_checkZero : bool
    stop reading if first image is zero

Returns
-------
out : ndarray

◆ get_image() [2/2]

def laospy.camera.LittleJoeCamera.get_image (   self,
  nFrames = 1,
  _checkZero = False,
  _async = None 
)
Returns an image from the LittleJoe Camera

Optionally the image is averaged over several frames. Bias correction is applied if a bias
frame is set.

Parameters
----------
nFrames : integer
    number of frames over which the returned image is averaged
_checkZero : bool
    stop reading if first image is zero

Returns
-------
out : ndarray

◆ get_program() [1/2]

def laospy.camera.LittleJoeCamera.get_program (   self)

◆ get_program() [2/2]

def laospy.camera.LittleJoeCamera.get_program (   self)

◆ readEndless() [1/2]

def laospy.camera.LittleJoeCamera.readEndless (   self)

◆ readEndless() [2/2]

def laospy.camera.LittleJoeCamera.readEndless (   self)

◆ set_attenuation() [1/2]

def laospy.camera.LittleJoeCamera.set_attenuation (   self,
  attenuation 
)
Sets the attenuation value

Parameters
----------
attenuation: integer
    attenuation value [0..3]

◆ set_attenuation() [2/2]

def laospy.camera.LittleJoeCamera.set_attenuation (   self,
  attenuation 
)
Sets the attenuation value

Parameters
----------
attenuation: integer
    attenuation value [0..3]

◆ set_bias_frame() [1/2]

def laospy.camera.LittleJoeCamera.set_bias_frame (   self,
  frame 
)
Sets the bias frame

Note: set frame to "None" to remove existing frame

Parameters
----------
frame : ndarray or None
    array with bias values

◆ set_bias_frame() [2/2]

def laospy.camera.LittleJoeCamera.set_bias_frame (   self,
  frame 
)
Sets the bias frame

Note: set frame to "None" to remove existing frame

Parameters
----------
frame : ndarray or None
    array with bias values

◆ set_program() [1/2]

def laospy.camera.LittleJoeCamera.set_program (   self,
  program 
)
Sets a new program

Parameters
----------
program: integer
    program number [0..7]

◆ set_program() [2/2]

def laospy.camera.LittleJoeCamera.set_program (   self,
  program 
)
Sets a new program

Parameters
----------
program: integer
    program number [0..7]

◆ state() [1/2]

def laospy.camera.LittleJoeCamera.state (   self)

◆ state() [2/2]

def laospy.camera.LittleJoeCamera.state (   self)

◆ stop() [1/2]

def laospy.camera.LittleJoeCamera.stop (   self)

◆ stop() [2/2]

def laospy.camera.LittleJoeCamera.stop (   self)

Member Data Documentation

◆ biasFrame

laospy.camera.LittleJoeCamera.biasFrame = None
static

◆ channelIndex

laospy.camera.LittleJoeCamera.channelIndex

◆ ctrl

laospy.camera.LittleJoeCamera.ctrl

◆ nChanCols [1/2]

int laospy.camera.LittleJoeCamera.nChanCols = 0
static

◆ nChanCols [2/2]

laospy.camera.LittleJoeCamera.nChanCols

◆ nChannels [1/2]

int laospy.camera.LittleJoeCamera.nChannels = 0
static

◆ nChannels [2/2]

laospy.camera.LittleJoeCamera.nChannels

◆ nChanRows [1/2]

int laospy.camera.LittleJoeCamera.nChanRows = 0
static

◆ nChanRows [2/2]

laospy.camera.LittleJoeCamera.nChanRows

◆ node

string laospy.camera.LittleJoeCamera.node = ''
static

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