camera.Camera Class Reference

This class showcases the usage of the ids_peak API in setting camera parameters, starting/stopping acquisition and how to record a video using the ids_peak_ipl API. More...

Public Member Functions
	__del__ (self)
	__del__ (self)
	__del__ (self)
	__init__ (self, device_manager, interface)
	__init__ (self, device_manager, interface)
	__init__ (self, device_manager, interface)
	acquisition_thread (self)
	change_pixel_format (self, str pixel_format)
	change_pixel_format (self, str pixel_format)
	close (self)
	close (self)
	close (self)
bool	conversion_supported (self, int source_pixel_format)
	Check if the image_converter supports the conversion of the source_pixel_format to our TARGET_PIXEL_FORMAT
bool	conversion_supported (self, int source_pixel_format)
	Check if the image_converter supports the conversion of the source_pixel_format to our TARGET_PIXEL_FORMAT
	get_data_stream_image (self)
	init_software_trigger (self)
	init_software_trigger (self)
	list_all_entries (self)
	list_entries (self, name)
	list_min_max (self, name)
	list_value (self, name)
	print (self)
	record (self, int timer)
	Records image frames into an AVI-container and saves it to {CWD}/video.avi :param timer: video length in seconds.
	revoke_and_allocate_buffer (self)
	revoke_and_allocate_buffer (self)
	save_image (self)
	save_image (self)
	set_remote_device_value (self, str name, any value)
	software_trigger (self)
	software_trigger (self)
	start_acquisition (self)
	start_acquisition (self)
	start_acquisition (self)
	stop_acquisition (self)
	stop_acquisition (self)
	stop_acquisition (self)
	wait_for_signal (self)
	wait_for_signal (self)

Public Attributes
bool	acquisition_running = False
	device_manager = device_manager
	ipl_image = None
bool	keep_image = True
bool	killed = False
bool	make_image = False
int	max_fps = 0
int	max_gain = 1
	node_map = None
bool	start_recording = False
int	target_fps = 20000
int	target_gain = 1

Protected Member Functions
	_find_and_set_remote_device_enumeration (self, str name, str value)
	_get_device (self)
	_get_device (self)
	_get_device (self)
	_init_data_stream (self)
	_init_data_stream (self)
	_setup_device_and_datastream (self)
	_valid_name (self, str path, str ext)
	_valid_name (self, str path, str ext)
	_valid_name (self, str path, str ext)

Protected Attributes
bool	_acquisition_running = False
list	_buffer_list = []
	_datastream = None
	_device = None
	_image_converter = ids_peak_ipl.ImageConverter()
	_interface = interface
	_node_map = None

Detailed Description

This class showcases the usage of the ids_peak API in setting camera parameters, starting/stopping acquisition and how to record a video using the ids_peak_ipl API.

Constructor & Destructor Documentation

__init__() [1/3]

camera.Camera.__init__	(		self,
			device_manager,
			interface )

__del__() [1/3]

camera.Camera.__del__

(

self

)

__init__() [2/3]

camera.Camera.__init__	(		self,
			device_manager,
			interface )

__del__() [2/3]

camera.Camera.__del__

(

self

)

__init__() [3/3]

camera.Camera.__init__	(		self,
			device_manager,
			interface )

__del__() [3/3]

camera.Camera.__del__

(

self

)

Member Function Documentation

_find_and_set_remote_device_enumeration()

camera.Camera._find_and_set_remote_device_enumeration ( self, str name, str value )

protected

_get_device() [1/3]

camera.Camera._get_device ( self )

protected

_get_device() [2/3]

camera.Camera._get_device ( self )

protected

_get_device() [3/3]

camera.Camera._get_device ( self )

protected

_init_data_stream() [1/2]

camera.Camera._init_data_stream ( self )

protected

_init_data_stream() [2/2]

camera.Camera._init_data_stream ( self )

protected

_setup_device_and_datastream()

camera.Camera._setup_device_and_datastream ( self )

protected

_valid_name() [1/3]

camera.Camera._valid_name ( self, str path, str ext )

protected

_valid_name() [2/3]

camera.Camera._valid_name ( self, str path, str ext )

protected

_valid_name() [3/3]

camera.Camera._valid_name ( self, str path, str ext )

protected

acquisition_thread()

camera.Camera.acquisition_thread

(

self

)

change_pixel_format() [1/2]

camera.Camera.change_pixel_format	(		self,
		str	pixel_format )

change_pixel_format() [2/2]

camera.Camera.change_pixel_format	(		self,
		str	pixel_format )

close() [1/3]

camera.Camera.close

(

self

)

close() [2/3]

camera.Camera.close

(

self

)

close() [3/3]

camera.Camera.close

(

self

)

conversion_supported() [1/2]

bool camera.Camera.conversion_supported	(		self,
		int	source_pixel_format )

Check if the image_converter supports the conversion of the source_pixel_format to our TARGET_PIXEL_FORMAT

conversion_supported() [2/2]

bool camera.Camera.conversion_supported	(		self,
		int	source_pixel_format )

Check if the image_converter supports the conversion of the source_pixel_format to our TARGET_PIXEL_FORMAT

get_data_stream_image()

camera.Camera.get_data_stream_image

(

self

)

init_software_trigger() [1/2]

camera.Camera.init_software_trigger

(

self

)

init_software_trigger() [2/2]

camera.Camera.init_software_trigger

(

self

)

See also

https://www.ids-imaging.us/manuals/ids-peak/ids-peak-user-manual/2.15.0/en/acquisition-control.html

list_all_entries()

camera.Camera.list_all_entries

(

self

)

list_entries()

camera.Camera.list_entries	(		self,
			name )

list_min_max()

camera.Camera.list_min_max	(		self,
			name )

list_value()

camera.Camera.list_value	(		self,
			name )

print()

camera.Camera.print

(

self

)

record()

camera.Camera.record	(		self,
		int	timer )

Records image frames into an AVI-container and saves it to {CWD}/video.avi :param timer: video length in seconds.

revoke_and_allocate_buffer() [1/2]

camera.Camera.revoke_and_allocate_buffer

(

self

)

revoke_and_allocate_buffer() [2/2]

camera.Camera.revoke_and_allocate_buffer

(

self

)

save_image() [1/2]

camera.Camera.save_image

(

self

)

save_image() [2/2]

camera.Camera.save_image

(

self

)

set_remote_device_value()

camera.Camera.set_remote_device_value	(		self,
		str	name,
		any	value )

software_trigger() [1/2]

camera.Camera.software_trigger

(

self

)

software_trigger() [2/2]

camera.Camera.software_trigger

(

self

)

start_acquisition() [1/3]

camera.Camera.start_acquisition

(

self

)

start_acquisition() [2/3]

camera.Camera.start_acquisition

(

self

)

start_acquisition() [3/3]

camera.Camera.start_acquisition

(

self

)

stop_acquisition() [1/3]

camera.Camera.stop_acquisition

(

self

)

stop_acquisition() [2/3]

camera.Camera.stop_acquisition

(

self

)

stop_acquisition() [3/3]

camera.Camera.stop_acquisition

(

self

)

wait_for_signal() [1/2]

camera.Camera.wait_for_signal

(

self

)

wait_for_signal() [2/2]

camera.Camera.wait_for_signal

(

self

)

Member Data Documentation

_acquisition_running

bool camera.Camera._acquisition_running = False

protected

_buffer_list

list Camera._buffer_list = []

protected

_datastream

camera.Camera._datastream = None

protected

_device

camera.Camera._device = None

protected

_image_converter

camera.Camera._image_converter = ids_peak_ipl.ImageConverter()

protected

_interface

camera.Camera._interface = interface

protected

_node_map

camera.Camera._node_map = None

protected

acquisition_running

bool Camera.acquisition_running = False

device_manager

camera.Camera.device_manager = device_manager

ipl_image

camera.Camera.ipl_image = None

keep_image

bool Camera.keep_image = True

killed

bool Camera.killed = False

make_image

bool Camera.make_image = False

max_fps

int camera.Camera.max_fps = 0

max_gain

int camera.Camera.max_gain = 1

node_map

camera.Camera.node_map = None

start_recording

bool camera.Camera.start_recording = False

target_fps

camera.Camera.target_fps = 20000

target_gain

camera.Camera.target_gain = 1

---

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

• ids/python/record_video_and_change_parameter/camera.py
• ids/python/start_stop_acquisition_software_trigger/camera.py
• IDSPeak/camera.py