ApplicationCreateFileCamera Method (Frame) |
Create a file camera from a captured frame
Namespace:
Zivid.NET
Assembly:
ZividCoreNET (in ZividCoreNET.dll) Version: 2.18.0.0
Syntaxpublic Camera CreateFileCamera(
Frame frameWithDiagnostics
)
Public Function CreateFileCamera (
frameWithDiagnostics As Frame
) As Camera
public:
Camera^ CreateFileCamera(
Frame^ frameWithDiagnostics
)
Parameters
- frameWithDiagnostics
- Type: Zivid.NETFrame
A frame captured with Settings::Diagnostics::Enabled = yes
Return Value
Type:
CameraZivid virtual camera instance
Remarks
A file camera is a virtual camera that replays a previously captured frame. It holds the raw sensor
data from the original capture and reconstructs point clouds and color images from it, so it can be
used to develop and test capture pipelines without physical camera hardware.
The frame must have been captured with Settings::Diagnostics::Enabled = yes, otherwise this method
throws. The diagnostics data carries the raw sensor images required to replay the capture.
Because a file camera owns only the raw data from a single capture, the settings it can capture with
are more restricted than those of a physical camera:
- Processing settings (filters, color balance, resampling, etc.) may be changed freely.
- Engine and Sampling (Pixel and Color) must match the values used for the original capture.
If set to a value different from the original setting, the capture throws.
- The number of acquisitions must not exceed the number stored in the file camera. Requesting fewer
acquisitions is allowed and replays the corresponding subset; requesting more throws.
- Acquisition values (Aperture, ExposureTime, Gain, Brightness) do not affect the captured data.
The requested settings are recorded on the returned frame, but they do not change the underlying
sensor data.
- Settings left unset are set automatically before capture: Engine and Sampling are set from the file
camera, while unset acquisition and processing fields are filled with the camera-model defaults.
The same restrictions apply to the 2D color acquisitions of a 2D or 2D+3D capture.
See Also