pylablib.devices.Photometrics package

Submodules

pylablib.devices.Photometrics.pvcam module

class pylablib.devices.Photometrics.pvcam.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, set uninit_result=None

open()[source]

Mark device opening.

Return tuple (init_result, open_result, opid) with the results of the initialization and the opening, and the opening ID which should afterwards be used for closing. If library is already initialized, set init_result=None

preinit()[source]

Pre-initialize the library, if it hasn’t been done already

shutdown()[source]

Close all opened connections and shutdown the library

temp_open()[source]

Context for temporarily opening a new device connection

pylablib.devices.Photometrics.pvcam.list_cameras()[source]

List all cameras available through Pvcam interface

pylablib.devices.Photometrics.pvcam.get_cameras_number()[source]

Get number of connected Pvcam cameras

class pylablib.devices.Photometrics.pvcam.PvcamAttribute(handle, pid, cam=None)[source]

Bases: object

Object representing an Pvcam camera parameter.

Allows to query and set values and get additional information. Usually created automatically by an PvcamCamera instance, but could be created manually.

Parameters:
  • handle – camera handle
  • pid – parameter id of the attribute
name

attribute name

kind

attribute kind; can be "INT8", "INT16", "INT32", "INT64", "UNS8", "UNS16", "UNS32", "UNS64", "FLT32", "FLT64", "ENUM", "BOOLEAN", or "CHAR_PTR"

kind

attribute kind (e.g., "INT8" or "FLT32")

available

whether attribute is available on the current hardware

Type:bool
readable

whether attribute is readable

Type:bool
writable

whether attribute is writable

Type:bool
min

minimal attribute value (if applicable)

Type:float or int
max

maximal attribute value (if applicable)

Type:float or int
inc

minimal attribute increment value (if applicable)

Type:float or int
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

default

default values of the attribute

update_limits()[source]

Update attribute constraints

truncate_value(value)[source]

Truncate value to lie within attribute limits

get_value(enum_as_str=True, error_on_noacq=True)[source]

Get attribute value.

If enum_as_str==True, return enum-style values as strings; otherwise, return corresponding integer values.

set_value(value, truncate=True)[source]

Set attribute value.

If truncate==True, automatically truncate value to lie within allowed range.

class pylablib.devices.Photometrics.pvcam.TDeviceInfo(vendor, product, chip, system, part, serial)

Bases: tuple

chip
count()

Return number of occurrences of value.

index()

Return first index of value.

Raises ValueError if the value is not present.

part
product
serial
system
vendor
class pylablib.devices.Photometrics.pvcam.TFrameInfo(frame_index, timestamp_start_ns, timestamp_end_ns, framestamp, flags, exposure_ns)

Bases: tuple

count()

Return number of occurrences of value.

exposure_ns
flags
frame_index
framestamp
index()

Return first index of value.

Raises ValueError if the value is not present.

timestamp_end_ns
timestamp_start_ns
class pylablib.devices.Photometrics.pvcam.TReadoutInfo(port_idx, port_name, speed_idx, speed_freq, gain_idx, gain_name)

Bases: tuple

count()

Return number of occurrences of value.

gain_idx
gain_name
index()

Return first index of value.

Raises ValueError if the value is not present.

port_idx
port_name
speed_freq
speed_idx
class pylablib.devices.Photometrics.pvcam.PvcamCamera(name=None)[source]

Bases: pylablib.devices.interface.camera.IBinROICamera, pylablib.devices.interface.camera.IExposureCamera, pylablib.devices.interface.camera.IAttributeCamera

Generic Pvcam camera interface.

Parameters:serial_number – camera serial number; if None, connect to the first non-used camera
Error = <Mock name='mock.PvcamError' id='140344273000848'>
TimeoutError = <Mock spec='str' id='140344301252112'>
open()[source]

Open connection to the camera

close()[source]

Close connection to the camera

is_opened()[source]

Check if the device is connected

get_attribute_value(name, error_on_missing=True, error_on_noacq=False, 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 not None, assume that error_on_missing==False. If name points at a dictionary branch, return a dictionary with all values in this branch. If enum_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). If truncate==True, truncate value to lie within attribute range.

get_all_attribute_values(root='', enum_as_str=True, error_on_noacq=False)[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_attribute_range(name, error_on_missing=True, default=None, parameter=None)[source]

Return attribute range.

For numerical attributes it is a tuple (min, max), while for enum attributes it is a dictionary {index: name}. If parameter is specified, it is a parameter class used to convert the index for a enum attribute.

get_all_readout_modes()[source]

Get a list of all possible readout modes.

Return a list of tuples (port_idx, port_name, speed_idx, speed_freq, gain_idx, gain_name). The indices (port, speed, and gain) can be used to set up a particular mode using set_readout_mode().

get_readout_mode(full=True)[source]

Get current readout mode.

If full==True, return a full tuple (port_idx, port_name, speed_idx, speed_freq, gain_idx, gain_name) containing the descriptions; otherwise, return only indices (port_idx, speed_idx, gain_idx).

set_readout_mode(port_idx=None, speed_idx=None, gain_idx=None)[source]

Set the readout mode.

Any None value stays unchanged.

get_device_info()[source]

Get camera information.

Return tuple (vendor, product, chip, system, part, serial).

get_pixel_size()[source]

Get camera pixel size (in m)

get_pixel_distance()[source]

Get camera pixel distance (in m)

get_temperature_setpoint()[source]

Get the temperature setpoint (in C)

get_temperature()[source]

Get the current camera temperature (in C)

set_temperature(temp)[source]

Change the temperature setpoint (in C)

get_fan_mode()[source]

Get current fan mode

set_fan_mode(fan_mode='high')[source]

Set current fan mode

is_metadata_enabled()[source]

Check if metadata is enabled

enable_metadata(enable=True)[source]

Enable or disable metadata

get_exposure()[source]

Get current exposure

set_exposure(exposure)[source]

Set camera exposure

get_clear_mode()[source]

Get sensor clear mode

set_clear_mode(mode)[source]

Set sensor clear mode

get_clear_cycles()[source]

Get sensor clear cycles

set_clear_cycles(ncycles)[source]

Set sensor clear cycles

get_clearing_time()[source]

Get sensor clearing time (regardless of the mode)

get_readout_time(include_clear=True)[source]

Get frame readout time.

If include_clear==True and the clear mode is per-exposure ("Pre-Exposure" or "Pre-Exposure and Post-Sequence"), include it into this time.

get_frame_timings()[source]

Get acquisition timing.

Return tuple (exposure, frame_period).

get_trigger_mode()[source]

Get trigger mode

set_trigger_mode(mode, out_mode=None)[source]

Set trigger mode

get_detector_size()[source]

Get camera detector size (in pixels) as a tuple (width, height)

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.

get_supported_binning_modes()[source]

Get all possible binning combinations as a list [(hbin, vbin)]

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.

clear_acquisition()[source]

Clear acquisition settings

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 is None). Otherwise, if any supplied parameters are different from the current ones, change them and reset the acquisition.

stop_acquisition()[source]

Stop acquisition

acquisition_in_progress()[source]

Check if acquisition is in progress

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, return None. If peek==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 with None), "zero" (replacing them with zero-filled frame), or "skip" (skipping them). If return_info==True, return tuple (frames, infos), where infos is a list of TFrameInfo instances describing frame index and frame metadata, which contains start and stop timestamps, framestamp, frame flags, and exposure; if some frames are missing and missing_frame!="skip", the corresponding frame info is None. if return_rng==True, return the range covered resulting frames; if missing_frame=="skip", the range can be smaller than the supplied rng if some frames are skipped.

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 by get_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_frame_period()

Get frame period (time between two consecutive frames in the internal trigger mode)

get_frames_status()

Get acquisition and buffer status.

Return tuple (acquired, unread, skipped, size), where acquired 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, and buffer_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, setting include=-10 queries all available variables, which is equivalent to include="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, setting include=-10 queries all available variables, which is equivalent to include="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, return None. 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, setting include=-10 queries all available variables, which is equivalent to include="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 with None), "zero" (replacing them with zero-filled frame), or "skip" (skipping them, while still keeping total returned frames number to n). If return_info==True, return tuple (frames, infos), where infos is a list of frame info tuples (camera-dependent); if some frames are missing and missing_frame!="skip", the corresponding frame info is None.

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). If stop==True, stop the acquisition (if clear==True, stop regardless). If setup_after==True, setup the acquisition after pause if necessary (None means setup only if clearing was required). If start_after==True, start the acquisition after pause if necessary (None means start only if stopping was required). If combine_nested==True, then any nested pausing_acquisition calls will stop/clear acquisition as necessary, but won’t setup/start it again until this pausing_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. If peek==True, return the image but not mark it as read. If return_info==True, return tuple (frame, info), where info is an info tuples (camera-dependent, see read_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. If peek==True, return the image but not mark it as read. If return_info==True, return tuple (frame, info), where info is an info tuples (camera-dependent, see read_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 by get_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 not None, 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 successful wait_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 exceeds timeout, or a single frame wait exceeds frame_timeout. If the call times out, raise TimeoutError. If error_on_stopped==True and the acquisition is not running, raise Error; otherwise, simply return False without waiting.

pylablib.devices.Photometrics.pvcam.get_roi_parameters(buffer)[source]

Extract ROI parameters from the buffer.

buffer is the buffer represented as bytes numpy byte array. Return numpy array with one row per ROI and 4 columns: data offset from the frame start, data bytes per pixel, ROI height, and ROI width.

pylablib.devices.Photometrics.pvcam.parse_metainfo_v1(buffer, nframes, stride)[source]

Extract frames metainfo for frames with v1 or v2 header.

buffer is the buffer represented as bytes numpy byte array, nframes is the number of frames in it, and stride is the frame stride (in bytes).

Return a 2D array with nframes rows and 7 columns: framestamp, timestampBOF, timestampEOF, timestampRes, exposure, exposureRes, flags.

pylablib.devices.Photometrics.pvcam.parse_metainfo_v3(buffer, nframes, stride)[source]

Extract frames metainfo for frames with v3 header.

buffer is the buffer represented as bytes numpy byte array, nframes is the number of frames in it, and stride is the frame stride (in bytes).

Return a 2D array with nframes rows and 5 columns: framestamp, timestampBOF, timestampEOF, exposure, flags.

Module contents