cli_interface.Interface Class Reference

Interface provides methods to interact with the camera on the command line, but it is not necessary to understand how to use the API of ids_peak or ids_peak_ipl. More...

Public Member Functions
	__init__ (self, Camera cam_module=None)
	__init__ (self, Camera cam_module=None)
	__init__ (self, Optional[Camera] cam_module=None)
	acquisition_check_and_disable (self)
	acquisition_check_and_disable (self)
	acquisition_check_and_set (self)
	acquisition_check_and_set (self)
	change_pixelformat (self)
	change_pixelformat (self)
	done_recording (self, RecordingStatistics stats)
	get_value (self, str prompt_text, float default)
	information (self, str message)
	information (self, str message)
	information (self, str message)
	is_gui (self)
	is_gui (self)
	on_image_received (self, image)
	on_image_received (self, image)
	on_image_received (self, image)
	print_help (self)
	print_help (self)
	print_help (self)
	prompt (self)
	set_camera (self, Camera cam_module)
	set_camera (self, Camera cam_module)
	set_camera (self, Camera cam_module)
	start_interface (self)
	start_interface (self)
	start_interface (self)
	start_window (self)
	start_window (self)
	start_window (self)
	warning (self, str message)
	warning (self, str message)
	warning (self, str message)

Public Attributes
	acquisition_thread = None

Protected Attributes
Optional[threading.Thread]	_acquisition_thread = None
	_camera = cam_module

Private Attributes
	__camera = cam_module

Detailed Description

Interface provides methods to interact with the camera on the command line, but it is not necessary to understand how to use the API of ids_peak or ids_peak_ipl.

Constructor & Destructor Documentation

__init__() [1/3]

cli_interface.Interface.__init__	(		self,
		Optional[Camera]	cam_module = None )

__init__() [2/3]

cli_interface.Interface.__init__	(		self,
		Camera	cam_module = None )

__init__() [3/3]

cli_interface.Interface.__init__	(		self,
		Camera	cam_module = None )

Member Function Documentation

acquisition_check_and_disable() [1/2]

cli_interface.Interface.acquisition_check_and_disable

(

self

)

acquisition_check_and_disable() [2/2]

cli_interface.Interface.acquisition_check_and_disable

(

self

)

acquisition_check_and_set() [1/2]

cli_interface.Interface.acquisition_check_and_set

(

self

)

acquisition_check_and_set() [2/2]

cli_interface.Interface.acquisition_check_and_set

(

self

)

change_pixelformat() [1/2]

cli_interface.Interface.change_pixelformat

(

self

)

change_pixelformat() [2/2]

cli_interface.Interface.change_pixelformat

(

self

)

done_recording()

cli_interface.Interface.done_recording	(		self,
		RecordingStatistics	stats )

get_value()

cli_interface.Interface.get_value	(		self,
		str	prompt_text,
		float	default )

information() [1/3]

cli_interface.Interface.information	(		self,
		str	message )

information() [2/3]

cli_interface.Interface.information	(		self,
		str	message )

information() [3/3]

cli_interface.Interface.information	(		self,
		str	message )

is_gui() [1/2]

cli_interface.Interface.is_gui

(

self

)

is_gui() [2/2]

cli_interface.Interface.is_gui

(

self

)

on_image_received() [1/3]

cli_interface.Interface.on_image_received	(		self,
			image )

on_image_received() [2/3]

cli_interface.Interface.on_image_received	(		self,
			image )

on_image_received() [3/3]

cli_interface.Interface.on_image_received	(		self,
			image )

print_help() [1/3]

cli_interface.Interface.print_help

(

self

)

print_help() [2/3]

cli_interface.Interface.print_help

(

self

)

print_help() [3/3]

cli_interface.Interface.print_help

(

self

)

prompt()

cli_interface.Interface.prompt

(

self

)

set_camera() [1/3]

cli_interface.Interface.set_camera	(		self,
		Camera	cam_module )

set_camera() [2/3]

cli_interface.Interface.set_camera	(		self,
		Camera	cam_module )

set_camera() [3/3]

cli_interface.Interface.set_camera	(		self,
		Camera	cam_module )

start_interface() [1/3]

cli_interface.Interface.start_interface

(

self

)

start_interface() [2/3]

cli_interface.Interface.start_interface

(

self

)

start_interface() [3/3]

cli_interface.Interface.start_interface

(

self

)

start_window() [1/3]

cli_interface.Interface.start_window

(

self

)

start_window() [2/3]

cli_interface.Interface.start_window

(

self

)

start_window() [3/3]

cli_interface.Interface.start_window

(

self

)

warning() [1/3]

cli_interface.Interface.warning	(		self,
		str	message )

warning() [2/3]

cli_interface.Interface.warning	(		self,
		str	message )

warning() [3/3]

cli_interface.Interface.warning	(		self,
		str	message )

Member Data Documentation

__camera

cli_interface.Interface.__camera = cam_module

private

_acquisition_thread

Optional[threading.Thread] cli_interface.Interface._acquisition_thread = None

protected

_camera

cli_interface.Interface._camera = cam_module

protected

acquisition_thread

cli_interface.Interface.acquisition_thread = None

---

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

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