Zivid  1.0.1+3607.8a7510c4
Zivid API
Public Member Functions | List of all members
Zivid::Frame Class Reference

A frame captured by a Zivid camera More...

#include <Frame.h>

Public Member Functions

ZIVID_API Frame ()
 Construct a new frame.
 
ZIVID_API Frame (const std::string &fileName)
 Creates a frame by loading data from a file.
 
ZIVID_API Frame (const std::string &fileName, ComputeDevice computeDevice)
 Creates a frame by loading data from a file on the given compute device.
 
ZIVID_API Frame clone () const
 Clone the frame.
 
ZIVID_API PointCloud getPointCloud () const
 Copies the point cloud to the CPU and returns it.
 
ZIVID_API DeviceCloud deviceCloud () const
 Returns the point cloud on the Compute device.
 
ZIVID_API CameraState state () const
 Get the camera state data at the time of the frame capture.
 
ZIVID_API Settings settings () const
 Get the settings for the API at the time of the frame capture.
 
ZIVID_API FrameInfo info () const
 Get information collected at the time of the frame capture.
 
ZIVID_API void save (const std::string &fileName) const
 Save the frame as a Zivid data file.
 
ZIVID_API void load (const std::string &fileName)
 Load a frame from a Zivid data file.
 

Detailed Description

A frame captured by a Zivid camera

Contains a Compute device point cloud and/or a CPU point cloud as well as calibration data, settings and state used by the API at time of the frame capture.


The documentation for this class was generated from the following file: