Frame Class |
A frame captured by a Zivid camera
Inheritance HierarchySystemObject
Zivid.NETFrame
Zivid.NETFrame
Namespace: Zivid.NET
Assembly: ZividCoreNET (in ZividCoreNET.dll) Version: 2.14.0.0
SyntaxThe Frame type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Frame | Initializes a new instance of the Frame class |
| Frame(Frame*) | Initializes a new instance of the Frame class |
| Frame(String) | Create a frame by loading data from a file |
Properties| Name | Description | |
|---|---|---|
 | CameraInfo | Information about the camera used to capture the frame |
| Frame2D | Get 2D frame from 2D+3D frame. |
| Info | Additional information associated with the frame |
| PointCloud | The point cloud |
| Settings | The camera settings at the time of the frame capture |
| State | The camera state data at the time of the frame capture |
Methods| Name | Description | |
|---|---|---|
| Clone |
Returns a clone of the frame. The clone will include a copy of all of the point cloud data on
the compute device memory. This means that the returned frame will not be affected by subsequent
modifications on the original frame or point cloud.
|
| Dispose | Releases all resources used by the Frame |
| Load | Load a frame from a Zivid data file |
| Save | Save the frame to file |
| ToString | Get string representation of the frame (Overrides ObjectToString.) |
Remarks
Contains the point cloud (stored on compute device memory) as well as calibration data, settings and
state used by the API at time of the frame capture. Use PointCloud to access point cloud
data.
Note that if this Frame 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 the Frame object that requires the capture to be finished,
for example PointCloud, the method will block until the point cloud is available.
See Also