pylablib.devices.PrincetonInstruments package¶
Submodules¶
pylablib.devices.PrincetonInstruments.picam module¶
-
class
pylablib.devices.PrincetonInstruments.picam.
LibraryController
(lib)[source]¶ Bases:
pylablib.devices.utils.load_lib.LibraryController
-
close
(opid)[source]¶ Mark device closing.
Return tuple
(close_result, uninit_result)
with the results of the closing and the shutdown. If library does not need to be shut down yet, setuninit_result=None
-
-
class
pylablib.devices.PrincetonInstruments.picam.
TCameraInfo
(name, serial_number, model, interface)¶ Bases:
tuple
-
count
()¶ Return number of occurrences of value.
-
index
()¶ Return first index of value.
Raises ValueError if the value is not present.
-
interface
¶
-
model
¶
-
name
¶
-
serial_number
¶
-
-
pylablib.devices.PrincetonInstruments.picam.
list_cameras
()[source]¶ List all cameras available through Picam interface
-
pylablib.devices.PrincetonInstruments.picam.
get_cameras_number
()[source]¶ Get number of connected Picam cameras
-
class
pylablib.devices.PrincetonInstruments.picam.
TROIConstraints
(flags, nrois, xrng, wrng, xbins, yrng, hrng, ybins)¶ Bases:
tuple
-
count
()¶ Return number of occurrences of value.
-
flags
¶
-
hrng
¶
-
index
()¶ Return first index of value.
Raises ValueError if the value is not present.
-
nrois
¶
-
wrng
¶
-
xbins
¶
-
xrng
¶
-
ybins
¶
-
yrng
¶
-
-
class
pylablib.devices.PrincetonInstruments.picam.
PicamAttribute
(handle, pid)[source]¶ Bases:
object
Object representing an Picam camera parameter.
Allows to query and set values and get additional information. Usually created automatically by an
PicamCamera
instance, but could be created manually.Parameters: - handle – camera handle
- pid – parameter id of the attribute
-
name
¶ attribute name
-
kind
¶ attribute kind; can be
"Integer"
,"Large Integer"
,"Floating Point"
,"Enumeration"
,"Boolean"
, or"Rois"
-
read_directly
¶ whether value can be read directly from the device; if
True
, thenget_value()
will automatically use the appropriate methodType: bool
-
default
¶ default parameter value (only for writable parameters)
-
cons_permanent
¶ whether the constraint is permanent, or dependent on other parameters; if
False
, then useupdate_limits()
to update the constraintsType: bool
-
cons_excluded
¶ list of special parameters which are within the range but are excluded
-
cons_included
¶ list of special parameters which are outside the range but are included
-
ivalues
¶ list of possible integer values for enum attributes
-
values
¶ list of possible text values for enum attributes
-
labels
¶ dict
{label: index}
which shows all possible values of an enumerated attribute and their corresponding numerical values
-
ilabels
¶ dict
{index: label}
which shows labels corresponding to numerical values of an enumerated attribute
-
update_limits
(force=False)[source]¶ Update attribute constraints.
If
force==False
and the constraints are permanent, skip the update.
-
class
pylablib.devices.PrincetonInstruments.picam.
TDeviceInfo
(name, serial_number, model, interface)¶ Bases:
tuple
-
count
()¶ Return number of occurrences of value.
-
index
()¶ Return first index of value.
Raises ValueError if the value is not present.
-
interface
¶
-
model
¶
-
name
¶
-
serial_number
¶
-
-
class
pylablib.devices.PrincetonInstruments.picam.
TFrameInfo
(frame_index, timestamp_start, timestamp_end, framestamp)¶ Bases:
tuple
-
count
()¶ Return number of occurrences of value.
-
frame_index
¶
-
framestamp
¶
-
index
()¶ Return first index of value.
Raises ValueError if the value is not present.
-
timestamp_end
¶
-
timestamp_start
¶
-
-
class
pylablib.devices.PrincetonInstruments.picam.
PicamCamera
(serial_number=None)[source]¶ Bases:
pylablib.devices.interface.camera.IBinROICamera
,pylablib.devices.interface.camera.IExposureCamera
,pylablib.devices.interface.camera.IAttributeCamera
Generic Picam camera interface.
Parameters: serial_number – camera serial number; if None
, connect to the first non-used camera-
Error
= <Mock name='mock.PicamError' id='140259567643920'>¶
-
TimeoutError
= <Mock spec='str' id='140259574165392'>¶
-
get_attribute_value
(name, error_on_missing=True, default=None, enum_as_str=True)[source]¶ Get value of an attribute with the given name.
If the value doesn’t exist or can not be read and
error_on_missing==True
, raise error; otherwise, return default. If default is notNone
, assume thaterror_on_missing==False
. If name points at a dictionary branch, return a dictionary with all values in this branch. Ifenum_as_str==True
, return enum-style values as strings; otherwise, return corresponding integer values.
-
set_attribute_value
(name, value, truncate=True, error_on_missing=True)[source]¶ Set value of an attribute with the given name.
If the value doesn’t exist or can not be written and
error_on_missing==True
, raise error; otherwise, do nothing. If name points at a dictionary branch, set all values in this branch (in this case value must be a dictionary). Iftruncate==True
, truncate value to lie within attribute range.
-
get_all_attribute_values
(root='', enum_as_str=True)[source]¶ Get values of all attributes with the given root
-
set_all_attribute_values
(settings, root='', truncate=True)[source]¶ Set values of all attributes with the given root.
If
truncate==True
, truncate value to lie within attribute range.
-
get_device_info
()[source]¶ Get camera information.
Return tuple
(vendor, model, serial_number, bus_type)
.
-
is_metadata_enabled
(individual=False)[source]¶ Check if metadata is enabled.
If
individual==True
, return individual metadata info(time_stamp_start, time_stamp_end, frame_stamp, gate_delay, modulation_phase)
. Otherwise, return simplyTrue
orFalse
depending on whether the basic group (time- and frame-stamps) is enabled. In this case, if the value is inconsistent with either for the groups, fix this to be consistent.
-
get_frame_period
(per_readout=False)[source]¶ Get frame period (time between two consecutive frames in the internal trigger mode)
If
per_readout==True
, return time difference between readouts, which can contain more than one frame; otherwise, return average time per frame (keep in mind that the frames still come in single unbroken readout).
-
get_frame_timings
(per_readout=False)[source]¶ Get acquisition timing.
Return tuple
(exposure, frame_period)
. Ifper_readout==True
, frame period difference between readouts, which can contain more than one frame; otherwise, it is the time per frame (keep in mind that the frames still come in single unbroken readout).
-
get_roi
()[source]¶ Get current ROI.
Return tuple
(hstart, hend, vstart, vend, hbin, vbin)
. hstart and hend specify horizontal image extent, vstart and vend specify vertical image extent (start is inclusive, stop is exclusive, starting from 0), hbin and vbin specify binning.
-
set_roi
(hstart=0, hend=None, vstart=0, vend=None, hbin=1, vbin=1)[source]¶ Setup camera ROI.
hstart and hend specify horizontal image extent, vstart and vend specify vertical image extent (start is inclusive, stop is exclusive, starting from 0), hbin and vbin specify binning. By default, all non-supplied parameters take extreme values (0 for start, maximal for end, 1 for binning).
-
get_roi_limits
(hbin=1, vbin=1)[source]¶ Get the minimal and maximal ROI parameters.
Return tuple
(hlim, vlim)
, where each element is in turn a limit 5-tuple(min, max, pstep, sstep, maxbin)
with, correspondingly, minimal and maximal size, position and size step, and the maximal binning. In some cameras, the step and the minimal size depend on the binning, which can be supplied.
-
setup_acquisition
(mode='sequence', nframes=100)[source]¶ Setup acquisition mode.
mode can be either
"snap"
(single frame or a fixed number of frames) or"sequence"
(continuous acquisition). nframes sets up number of frame buffers. If there are multiple frames per readout, it still means the number of frames, and the number of readouts is set up to contain all required frames (e.g., 10 frames per readout and 15 frames result in 2 readouts).
-
start_acquisition
(*args, **kwargs)[source]¶ Start acquisition.
Can take the same keyword parameters as :meth:``setup_acquisition. If the acquisition is not set up yet, set it up using the supplied parameters (use default of
setup_acquisition()
,if the parameter isNone
). Otherwise, if any supplied parameters are different from the current ones, change them and reset the acquisition.
-
FrameTransferError
¶ alias of
pylablib.devices.interface.camera.DefaultFrameTransferError
-
class
NoParameterCaller
(device, kind)¶ Bases:
object
Class to simplify calling functions without a parameter
-
apply_settings
(settings)¶ Apply the settings.
settings is the dict
{name: value}
of the device available settings. Non-applicable settings are ignored.
-
get_acquisition_parameters
()¶ Get acquisition parameters.
Return dictionary
{name: value}
-
get_all_attributes
(copy=False)¶ Return a dictionary of all available attributes.
If
copy==True
, copy the dictionary; otherwise, return the internal dictionary structure (should not be modified).
-
get_attribute
(name, error_on_missing=True)¶ Get the camera attribute with the given name
-
get_data_dimensions
()¶ Get readout data dimensions (in pixels) as a tuple
(width, height)
; take indexing mode into account
-
get_device_variable
(key)¶ Get the value of a settings, status, or full info parameter
-
get_frame_format
()¶ Get format for the returned images.
Can be
"list"
(list of 2D arrays),"array"
(a single 3D array), or"chunks"
(list of 3D “chunk” arrays; supported for some cameras and provides the best performance).
-
get_frame_info_fields
()¶ Get the names of frame info fields.
Applicable when frame info format (set by
set_frame_info_format()
) is"list"
or"array"
.
-
get_frame_info_format
()¶ Get format of the frame info.
Can be
"namedtuple"
(potentially nested named tuples; convenient to get particular values),"list"
(flat list of values, with field names are given byget_frame_info_fields()
; convenient for building a table),"array"
(same as"list"
, but with a numpy array, which is easier to use for"chunks"
frame format), or"dict"
(flat dictionary with the same fields as the"list"
format; more resilient to future format changes)
-
get_frame_info_period
()¶ Get period of frame info acquisition.
Frame info might be skipped (set to
None
) except for frames which indices are divisible by period. Useful for certain cameras where acquiring frame info takes a lot of time and can reduce performance at higher frame rates. Note that this parameter can still be ignored (i.e., always set to 1) if the performance is not an issue for a given camera class.
-
get_frames_status
()¶ Get acquisition and buffer status.
Return tuple
(acquired, unread, skipped, size)
, whereacquired
is the total number of acquired frames,unread
is the number of acquired but not read frames,skipped
is the number of skipped (not read and then written over) frames, andbuffer_size
is the total buffer size (in frames).
-
get_full_info
(include=0)¶ Get dict
{name: value}
containing full device information (including status and settings).include specifies either a list of variables (only these variables are returned), a priority threshold (only values with the priority equal or higher are returned), or
"all"
(all available variables). Since the lowest priority is -10, settinginclude=-10
queries all available variables, which is equivalent toinclude="all"
.
-
get_full_status
(include=0)¶ Get dict
{name: value}
containing the device status (including settings).include specifies either a list of variables (only these variables are returned), a priority threshold (only values with the priority equal or higher are returned), or
"all"
(all available variables). Since the lowest priority is -10, settinginclude=-10
queries all available variables, which is equivalent toinclude="all"
.
-
get_image_indexing
()¶ Get indexing for the returned images.
Can be
"rct"
(first index row, second index column, rows counted from the top),"rcb"
(same as"rc"
, rows counted from the bottom),"xyt"
(first index column, second index row, rows counted from the top), or"xyb"
(same as"xyt"
, rows counted from the bottom)
-
get_new_images_range
()¶ Get the range of the new images.
Return tuple
(first, last)
with images range (first inclusive). If no images are available, returnNone
. If some images were in the buffer were overwritten, exclude them from the range.
-
get_settings
(include=0)¶ Get dict
{name: value}
containing all the device settings.include specifies either a list of variables (only these variables are returned), a priority threshold (only values with the priority equal or higher are returned), or
"all"
(all available variables). Since the lowest priority is -10, settinginclude=-10
queries all available variables, which is equivalent toinclude="all"
.
-
grab
(nframes=1, frame_timeout=5.0, missing_frame='skip', return_info=False, buff_size=None)¶ Snap nframes images (with preset image read mode parameters)
buff_size determines buffer size (if
None
, use the default size). Timeout is specified for a single-frame acquisition, not for the whole acquisition time. missing_frame determines what to do with frames which have been lost: can be"none"
(replacing them withNone
),"zero"
(replacing them with zero-filled frame), or"skip"
(skipping them, while still keeping total returned frames number to n). Ifreturn_info==True
, return tuple(frames, infos)
, whereinfos
is a list of frame info tuples (camera-dependent); if some frames are missing andmissing_frame!="skip"
, the corresponding frame info isNone
.
-
is_acquisition_setup
()¶ Check if acquisition is set up.
If the camera does not support separate acquisition setup, always return
True
.
-
pausing_acquisition
(clear=None, stop=True, setup_after=None, start_after=True, combine_nested=True)¶ Context manager which temporarily pauses acquisition during execution of
with
block.Useful for applying certain settings which can’t be changed during the acquisition. If
clear==True
, clear acquisition in addition to stopping (by default, use the class default specified as_clear_pausing_acquisition
attribute). Ifstop==True
, stop the acquisition (ifclear==True
, stop regardless). Ifsetup_after==True
, setup the acquisition after pause if necessary (None
means setup only if clearing was required). Ifstart_after==True
, start the acquisition after pause if necessary (None
means start only if stopping was required). Ifcombine_nested==True
, then any nestedpausing_acquisition
calls will stop/clear acquisition as necessary, but won’t setup/start it again until thispausing_acquisition
call is complete.Yields tuple
(acq_in_progress, acq_params)
, which indicates whether acquisition is currently in progress, and what are the current acquisition parameters.
-
read_newest_image
(peek=False, return_info=False)¶ Read the newest un-read image.
If no un-read frames are available, return
None
. Ifpeek==True
, return the image but not mark it as read. Ifreturn_info==True
, return tuple(frame, info)
, whereinfo
is an info tuples (camera-dependent, seeread_multiple_images()
).
-
read_oldest_image
(peek=False, return_info=False)¶ Read the oldest un-read image.
If no un-read frames are available, return
None
. Ifpeek==True
, return the image but not mark it as read. Ifreturn_info==True
, return tuple(frame, info)
, whereinfo
is an info tuples (camera-dependent, seeread_multiple_images()
).
-
set_device_variable
(key, value)¶ Set the value of a settings parameter
-
set_frame_format
(fmt)¶ Set format for the returned images.
Can be
"list"
(list of 2D arrays),"array"
(a single 3D array),"chunks"
(list of 3D “chunk” arrays; supported for some cameras and provides the best performance), or"try_chunks"
(same as"chunks"
, but if chunks are not supported, set to"list"
instead). If format is"chunks"
and chunks are not supported by the camera, it results in one frame per chunk. Note that if the format is set to"array"
or"chunks"
, the frame info format is also automatically set to"array"
. If the format is set to"chunks"
, then the image info is also returned in chunks form (list of 2D info arrays with the same length as the corresponding frame chunks).
-
set_frame_info_format
(fmt, include_fields=None)¶ Set format of the frame info.
Can be
"namedtuple"
(potentially nested named tuples; convenient to get particular values),"list"
(flat list of values, with field names are given byget_frame_info_fields()
; convenient for building a table),"array"
(same as"list"
, but with a numpy array, which is easier to use for"chunks"
frame format), or"dict"
(flat dictionary with the same fields as the"list"
format; more resilient to future format changes) If include_fields is notNone
, it specifies the fields included for non-"tuple"
formats; note that order or include_fields is ignored, and the resulting fields are always ordered same as in the original.
-
set_frame_info_period
(period=1)¶ Set period of frame info acquisition.
Frame info might be skipped (set to
None
) except for frames which indices are divisible by period. Useful for certain cameras where acquiring frame info takes a lot of time and can reduce performance at higher frame rates. Note that this parameter can still be ignored (i.e., always set to 1) if the performance is not an issue for a given camera class.
-
set_image_indexing
(indexing)¶ Set up indexing for the returned images.
Can be
"rct"
(first index row, second index column, rows counted from the top),"rcb"
(same as"rc"
, rows counted from the bottom),"xyt"
(first index column, second index row, rows counted from the top), or"xyb"
(same as"xyt"
, rows counted from the bottom)
-
snap
(timeout=5.0, return_info=False)¶ Snap a single frame
-
wait_for_frame
(since='lastread', nframes=1, timeout=20.0, error_on_stopped=False)¶ Wait for one or several new camera frames.
since specifies the reference point for waiting to acquire nframes frames; can be “lastread”`` (from the last read frame),
"lastwait"
(wait for the last successfulwait_for_frame()
call),"now"
(from the start of the current call), or"start"
(from the acquisition start, i.e., wait until nframes frames have been acquired). timeout can be either a number,None
(infinite timeout), or a tuple(timeout, frame_timeout)
, in which case the call times out if the total time exceedstimeout
, or a single frame wait exceedsframe_timeout
. If the call times out, raiseTimeoutError
. Iferror_on_stopped==True
and the acquisition is not running, raiseError
; otherwise, simply returnFalse
without waiting.
-
read_multiple_images
(rng=None, peek=False, missing_frame='skip', return_info=False, return_rng=False)[source]¶ Read multiple images specified by rng (by default, all un-read images).
If rng is specified, it is a tuple
(first, last)
with images range (first inclusive). If no new frames are available, return an empty list; if no acquisition is running, returnNone
. Ifpeek==True
, return images but not mark them as read. missing_frame determines what to do with frames which are out of range (missing or lost): can be"none"
(replacing them withNone
),"zero"
(replacing them with zero-filled frame), or"skip"
(skipping them). Ifreturn_info==True
, return tuple(frames, infos)
, whereinfos
is a list ofTFrameInfo
instances describing frame index and frame metadata, which contains start and stop timestamps, and framestamp; if some frames are missing andmissing_frame!="skip"
, the corresponding frame info isNone
. ifreturn_rng==True
, return the range covered resulting frames; ifmissing_frame=="skip"
, the range can be smaller than the supplied rng if some frames are skipped.
-