Click or drag to resize

ProjectedImageCapture2D Method (Settings)

Capture a single 2D frame without stopping the ongoing image projection

Namespace:  Zivid.NET.Projection
Assembly:  ZividCoreNET (in ZividCoreNET.dll) Version: 2.16.0.0
Syntax
Copy
public Frame2D Capture2D(
	Settings settings
)

Parameters

settings
Type: Zivid.NETSettings
Settings to use for the capture

Return Value

Type: Frame2D
A frame containing a 2D image and metadata
Remarks
This method returns right after the acquisition of the image is complete. Some settings cannot be used to capture while projecting, depending on the camera model:
  • Not all camera models support capturing rgb colors while projecting. An exception will be thrown if `Settings2D/Sampling/Color` is set to `rgb` and the camera does not support capturing rgb colors while projecting. Those cameras must use `grayscale` instead.
  • When `Settings2D/Sampling/Color` is set to `rgb` the brightness must be 0 in all acquisitions, otherwise an exception will be thrown.
  • When `Settings2D/Sampling/Color` is set to `grayscale` the brightness may be set to some value > 0. This value will override the brightness of the projection to control the contrast between the scene and the projected image. This will cause the projected image to flicker while the camera is capturing. If the brightness is set to 0 the image projection will be uninterrupted.
This overload is provided for convenience. Note that only the Settings2D part under Color will be used for the capture. The other parts of the settings will be ignored.
See Also