Zivid C++ API  1.3.0+bb9ee328-10
Defining the Future of 3D Machine Vision
Public Member Functions | List of all members
Zivid::Frame Class Reference

A frame captured by a Zivid camera More...

#include <Zivid/Frame.h>

Public Member Functions

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

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.

Constructor & Destructor Documentation

◆ Frame() [1/3]

ZIVID_API_EXPORT Zivid::Frame::Frame ( )

Construct a new frame.

◆ Frame() [2/3]

ZIVID_API_EXPORT Zivid::Frame::Frame ( const std::string &  fileName)
explicit

Creates a frame by loading data from a file.

◆ Frame() [3/3]

ZIVID_API_EXPORT Zivid::Frame::Frame ( const std::string &  fileName,
ComputeDevice  computeDevice 
)
explicit

Creates a frame by loading data from a file on the given compute device.

Member Function Documentation

◆ deviceCloud()

ZIVID_API_EXPORT DeviceCloud Zivid::Frame::deviceCloud ( ) const

Returns the point cloud on the Compute device.

◆ getPointCloud()

ZIVID_API_EXPORT PointCloud Zivid::Frame::getPointCloud ( ) const

Copies the point cloud to the CPU and returns it.

◆ info()

ZIVID_API_EXPORT FrameInfo Zivid::Frame::info ( ) const

Get information collected at the time of the frame capture.

◆ load()

ZIVID_API_EXPORT void Zivid::Frame::load ( const std::string &  fileName)

Load a frame from a Zivid data file.

◆ save()

ZIVID_API_EXPORT void Zivid::Frame::save ( const std::string &  fileName) const

Save the frame to file. The file type is determined from the file extension.

◆ settings()

ZIVID_API_EXPORT Settings Zivid::Frame::settings ( ) const

Get the settings for the API at the time of the frame capture.

◆ state()

ZIVID_API_EXPORT CameraState Zivid::Frame::state ( ) const

Get the camera state data at the time of the frame capture.

◆ toString()

ZIVID_API_EXPORT std::string Zivid::Frame::toString ( ) const

Get string representation of the frame

Returns
Frame info as string

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