High Frequency IDS Camera Capture plugin for ImageJ

HF_IDS_Cam (High Frequency IDS Camera Capture)

Authors: Côme PASQUALIN - François GANNIER (gannier at univ-tours dot fr) University of Tours (France)

See also: Other productions for ImageJ from the authors
PCCV group main page

History: 2015/07/09: 0.1 - First version
2015/11/17: 0.2 - Add 10/12/16 bits support
2015/12/08: 0.3 - Speed optimisation, work now at full camera speed
2016/01/06: 1.0 - Compatibility with JNA 4.2
2016/12/12: 1.1 - New dialog box - Better compatibility Linux/Windows - Multi-cam management - RGB mode - SubSampling Management - Shutter Auto + Slider - Data transfert bandwidth display - Add keylistener - Add Zoom_to_AOI - Set AOI from ROI - Set AES/AGC on ROI - Add Brightness reference - White balance auto on Color Camera
2017/07/03: 1.2 - Add Pause, Snap and Stack acquisition - Free Memory Management for saving - Help info
2019/12/05: 1.3 - Fix FPS not updated with AOI change - Add RGB control for color camera - Add Stop visualisation to avoid lossing images during high speed acquisition - Add timestamp (in microsec) to each image

Requires: tested on ImageJ 1.51p but should works on older.

Publication: "HF_IDS_Cam: fast video capture with ImageJ for real-time analysis." Côme Pasqualin, François Gannier, Pierre Bredeloux, Véronique Maupoil
Journal of Imaging 2018 Feb.,
DOI:10.3390/jimaging4020044

Sources: src.zip. Link to GitHub

Limitations: There is no IDS driver for Mac OS so only Linux and Windows are supported

Installation: Install the IDS driver for your OS (IDS website download page).
Download latest version of jna.jar and jna-platform.jar and copy them into the jars folder. (N.B.: the plugin was tested with version 4.2.1; jna.jar is already included in FIJI)
Download and copy IJ_IDS_Cam.jar in a subfolder inside the plugins folder (eg : Camera), then restart ImageJ.

Additional installation: Libraries to synchronize the camera with other devices: download and install the latest version of RXTX and GetSync.jar as described here.

User guide: user_guide_HF_IDS_Cam.pdf .

Description: The HF_IDS_Cam plugin has been tested with the IDS UI-122x Monochrome model but should work with every IDS camera. The UI-122x camera has binning mode (X2 and X4) and AOI selection capacities, thus allowing very high frequency video acquisition (>1000 fps).
The USB 3.0 IDS UI-3060CP camera has also been tested at full resolution/full speed (1936x1216 at 160 fps, 8-bits) and with AOI (1936x32 at 1468 fps)

Subsampling/binning mode must be chosen at start

All displayed parameters in the control box can be adjusted
In this screenshoot, video (1936x1216) is displayed at 150 FPS (as shown in the status bar of the control panel).

Usage: Scripts can easily be synchronized with the video. Each time the image is updated, a value "Cam.newImage" is set to "true" (see following exemple).
Example:
to insert in your script :
	while (call("ij.Prefs.get", "Cam.newImage","false") == "false") {
		wait(1);  // wait for the next image come - reduce CPU usage
	}
	// here the image is updated
	call("ij.Prefs.set", "Cam.newImage","false");
	// you must set the "Cam.newImage" to false in the script
	// make what you want with the new image
Expected performance: Performance will be dependent from the CPU of the host computer.
We tested with two different computers with USB3 connector.
Zoom of the display in ImageJ is set at 50% (higher values means higher CPU usage)
The remaining CPU resources will be available for macro or plugin to perform realtime analysis.

Xeon E3-1241 - Linux OpenSUSE distribution Leap 42.3.
Full - 1936x1216 at 160fps, CPU usage is 20%.
AOI - 1936x136 at 1000fps, CPU usage is 20%.

Core i3-2330M - Windows 10 x64.
Full - 1936x1216 at 160fps, CPU usage is 43%.
AOI - 1936x136 at 1000fps, CPU usage is 44%.

Dialog with serial port: Input TTL signals can be acquired while video recording with the suitable "input box". See the following ref: article reference and GetSync page.

Control panel for the management of the input signal

Samples: Recording samples with HF_IDS_Cam plug-in and input synchronization:
Sync-Contraction.tif (22.5Mo) (stimulated isolated cardiomyocyte in transmitted light);
Sync-FluoCa.tif (83.1Mo) (stimulated isolated cardiomyocyte loaded with calcium sensitive dye (Fluo-4), recorded at 505-525nm);
Sync-FluoCa-8bits.tif (41.6Mo) (same as above but resampled to 8-bits);

Publication: "HF_IDS_Cam: Fast Video Capture with ImageJ for Real-Time Analysis." Côme Pasqualin, François Gannier, Pierre Bredeloux, Véronique Maupoil
Journal of Imaging, DOI: 10.3390/jimaging4020044

Thanks: We thank the company "STEMMER Imaging" (Suresnes, France) for providing us with an IDS UI-1225 monochrome camera.
We thank the company "Imaging Development Systems GmbH" (Obersulm, Germany) for providing us with an IDS UI-3060CP monochrome camera.

|Plugins | Home |

Authors:	Côme PASQUALIN - François GANNIER (gannier at univ-tours dot fr) University of Tours (France)
See also:	Other productions for ImageJ from the authors PCCV group main page
History:	2015/07/09: 0.1 - First version 2015/11/17: 0.2 - Add 10/12/16 bits support 2015/12/08: 0.3 - Speed optimisation, work now at full camera speed 2016/01/06: 1.0 - Compatibility with JNA 4.2 2016/12/12: 1.1 - New dialog box - Better compatibility Linux/Windows - Multi-cam management - RGB mode - SubSampling Management - Shutter Auto + Slider - Data transfert bandwidth display - Add keylistener - Add Zoom_to_AOI - Set AOI from ROI - Set AES/AGC on ROI - Add Brightness reference - White balance auto on Color Camera 2017/07/03: 1.2 - Add Pause, Snap and Stack acquisition - Free Memory Management for saving - Help info 2019/12/05: 1.3 - Fix FPS not updated with AOI change - Add RGB control for color camera - Add Stop visualisation to avoid lossing images during high speed acquisition - Add timestamp (in microsec) to each image
Requires:	tested on ImageJ 1.51p but should works on older.
Publication:	"HF_IDS_Cam: fast video capture with ImageJ for real-time analysis." Côme Pasqualin, François Gannier, Pierre Bredeloux, Véronique Maupoil Journal of Imaging 2018 Feb., DOI:10.3390/jimaging4020044
Sources:	src.zip. Link to GitHub
Limitations:	There is no IDS driver for Mac OS so only Linux and Windows are supported
Installation:	Install the IDS driver for your OS (IDS website download page). Download latest version of jna.jar and jna-platform.jar and copy them into the jars folder. (N.B.: the plugin was tested with version 4.2.1; jna.jar is already included in FIJI) Download and copy IJ_IDS_Cam.jar in a subfolder inside the plugins folder (eg : Camera), then restart ImageJ.
Additional installation:	Libraries to synchronize the camera with other devices: download and install the latest version of RXTX and GetSync.jar as described here.
User guide:	user_guide_HF_IDS_Cam.pdf .
Description:	The HF_IDS_Cam plugin has been tested with the IDS UI-122x Monochrome model but should work with every IDS camera. The UI-122x camera has binning mode (X2 and X4) and AOI selection capacities, thus allowing very high frequency video acquisition (>1000 fps). The USB 3.0 IDS UI-3060CP camera has also been tested at full resolution/full speed (1936x1216 at 160 fps, 8-bits) and with AOI (1936x32 at 1468 fps) Subsampling/binning mode must be chosen at start All displayed parameters in the control box can be adjusted In this screenshoot, video (1936x1216) is displayed at 150 FPS (as shown in the status bar of the control panel).
Usage:	Scripts can easily be synchronized with the video. Each time the image is updated, a value "Cam.newImage" is set to "true" (see following exemple).
Example:	to insert in your script : `while (call("ij.Prefs.get", "Cam.newImage","false") == "false") { wait(1); // wait for the next image come - reduce CPU usage } // here the image is updated call("ij.Prefs.set", "Cam.newImage","false"); // you must set the "Cam.newImage" to false in the script // make what you want with the new image`
Expected performance:	Performance will be dependent from the CPU of the host computer. We tested with two different computers with USB3 connector. Zoom of the display in ImageJ is set at 50% (higher values means higher CPU usage) The remaining CPU resources will be available for macro or plugin to perform realtime analysis. Xeon E3-1241 - Linux OpenSUSE distribution Leap 42.3. Full - 1936x1216 at 160fps, CPU usage is 20%. AOI - 1936x136 at 1000fps, CPU usage is 20%. Core i3-2330M - Windows 10 x64. Full - 1936x1216 at 160fps, CPU usage is 43%. AOI - 1936x136 at 1000fps, CPU usage is 44%.
Dialog with serial port:	Input TTL signals can be acquired while video recording with the suitable "input box". See the following ref: article reference and GetSync page. Control panel for the management of the input signal
Samples:	Recording samples with HF_IDS_Cam plug-in and input synchronization: Sync-Contraction.tif (22.5Mo) (stimulated isolated cardiomyocyte in transmitted light); Sync-FluoCa.tif (83.1Mo) (stimulated isolated cardiomyocyte loaded with calcium sensitive dye (Fluo-4), recorded at 505-525nm); Sync-FluoCa-8bits.tif (41.6Mo) (same as above but resampled to 8-bits);
Publication:	"HF_IDS_Cam: Fast Video Capture with ImageJ for Real-Time Analysis." Côme Pasqualin, François Gannier, Pierre Bredeloux, Véronique Maupoil Journal of Imaging, DOI: 10.3390/jimaging4020044
Thanks:	We thank the company "STEMMER Imaging" (Suresnes, France) for providing us with an IDS UI-1225 monochrome camera. We thank the company "Imaging Development Systems GmbH" (Obersulm, Germany) for providing us with an IDS UI-3060CP monochrome camera.