Frame2D Class |
A 2D frame captured by a Zivid camera
Inheritance HierarchySystemObject
Zivid.NETFrame2D
Zivid.NETFrame2D
Namespace: Zivid.NET
Assembly: ZividCoreNET (in ZividCoreNET.dll) Version: 2.18.0.0
SyntaxThe Frame2D type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Frame2D(String) | Load a 2D frame from a .zdf file |
| Frame2D(Frame2D*) | Initializes a new instance of the Frame2D class |
Properties| Name | Description | |
|---|---|---|
 | CameraInfo | Get information about the camera used to capture the frame |
| Info | Get information collected at the time of the capture |
| IsDisposed | Check if the frame is disposed |
| Settings | Get the settings used to capture this frame |
| State | Get the camera state data at the time of the capture |
Methods| Name | Description | |
|---|---|---|
| Clone |
Returns a clone of the frame. The clone will include a copy of all of the frame data.
|
| Dispose | Releases all resources used by the Frame2D |
| ImageBGRA | Get the associated 2D color image in 8-bit BGRA format |
| ImageBGRA_SRGB | Get the associated 2D color image in the sRGB color space in 8-bit BGRA format |
| ImageDeviceArrayBGRA | Get a device buffer containing BGRA image data (8 bits per channel, linear) |
| ImageDeviceArrayBGRA_SRGB | Get a device buffer containing BGRA image data in the sRGB color space (8 bits per channel) |
| ImageDeviceArrayRGBA | Get a device buffer containing RGBA image data (8 bits per channel, linear) |
| ImageDeviceArrayRGBA_SRGB | Get a device buffer containing RGBA image data in the sRGB color space (8 bits per channel) |
| ImageDeviceArrayRGBAf | Get a device buffer containing RGBA float image data (32 bits per channel, linear) |
| ImageRGBA | Get the associated 2D color image in 8-bit RGBA format |
| ImageRGBA_SRGB | Get the associated 2D color image in the sRGB color space in 8-bit RGBA format |
| ImageSRGB | Get the associated 2D color image in the sRGB color space in 8-bit RGBA format |
| Load | Load a 2D frame from a .zdf file |
| Save | Save the 2D frame to a .zdf file |
| ShallowCopy |
Returns a shallow copy of the frame. The copy will share the image data with the original frame.
|
| ToString | Get string representation of the frame (Overrides ObjectToString.) |
Remarks
Contains a 2D image as well as metadata, settings and state of the
API at the time of capture.
Note that if this Frame2D object was returned from a call to `Camera::Capture(Settings^)` or
`Camera::Capture(Settings2D^)`, then there may still be remaining data transfer and processing going on
in the background. When you call a method on Frame2D that requires the capture to be finished,
for example ImageRGBA, the method will block until the image is available.
The images are not corrected for lens distortion. If your application relies on the geometry of the
image, you can undistort it using the camera intrinsics.
See Also