Zivid Namespace Reference

The main Zivid namespace. All Zivid code is found here More...

Namespaces
namespace	Calibration
namespace	CaptureAssistant
namespace	DataModel
namespace	Experimental
namespace	Firmware
	Interface for verifying and configuring firmware
namespace	Presets
namespace	Version
	Get version information for the library
namespace	Visualization

Classes
class	Application
	Manager class for Zivid More...
class	Array2D
	Two-dimensional container of data More...
class	Camera
	Interface to one Zivid camera More...
class	CameraInfo
	Information about camera model, serial number etc. More...
class	CameraIntrinsics
	Information about the intrinsic parameters of the camera (OpenCV model) More...
class	CameraState
	Information about camera connection state, temperatures, etc. More...
struct	ColorBGRA
	Color with 8-bit blue, green, red and alpha channels More...
struct	ColorBGRABase
struct	ColorRGBA
	Color with 8-bit red, green, blue and alpha channels More...
struct	ColorRGBABase
class	ComputeDevice
	Contains information about the compute device used by Zivid::Application. More...
class	Exception
	A common base class for all Zivid exceptions. More...
class	Frame
	A frame captured by a Zivid camera More...
class	Frame2D
	A 2D frame captured by a Zivid camera More...
class	FrameInfo
	Various information for a frame More...
class	Image
	A 2-dimensional image More...
class	Matrix
	A fixed size matrix in row major order More...
struct	NormalXYZ
	Normal vector with three coordinates as float More...
class	PointCloud
	Point cloud with x, y, z, RGB color and SNR laid out on a 2D grid More...
struct	PointXY
	Point with two coordinates as float More...
struct	PointXYZ
	Point with three coordinates as float More...
struct	PointXYZColorBGRA
	Struct which contains XYZ point and BGRA color packed together More...
struct	PointXYZColorRGBA
	Struct which contains XYZ point and RGBA color packed together More...
struct	PointXYZW
	Point with four coordinates as float More...
struct	PointZ
	Point with Z coordinate More...
class	Range
	Class describing a range of values for a given type T More...
class	Resolution
	Class describing a given resolution More...
class	Settings
	Settings used when capturing with a Zivid camera More...
class	Settings2D
	Settings used when capturing 2D images with a Zivid camera More...
struct	SNR
	Signal-to-Noise ratio (SNR) More...
struct	VectorXYZ
	Vector with three coordinates as float More...

Typedefs
using	Matrix3x3 = Matrix< float, 3, 3 >
	Matrix of size 3x3 containing floats More...
using	Matrix3x3d = Matrix< double, 3, 3 >
	Matrix of size 3x3 containing doubles More...
using	Matrix4x4 = Matrix< float, 4, 4 >
	Matrix of size 4x4 containing floats More...
using	Matrix4x4d = Matrix< double, 4, 4 >
	Matrix of size 4x4 containing doubles More...

Functions
template<typename T >
std::ostream &	operator<< (std::ostream &stream, const Array2D< T > &array)
	Serialize array information to a stream More...
template<typename T >
Array2D< T >::ConstIterator	cbegin (const Array2D< T > &array)
	Iterator to the beginning of the array More...
template<typename T >
Array2D< T >::ConstIterator	begin (const Array2D< T > &array)
	Iterator to the beginning of the array More...
template<typename T >
Array2D< T >::ConstIterator	cend (const Array2D< T > &array)
	Iterator to the end of the array More...
template<typename T >
Array2D< T >::ConstIterator	end (const Array2D< T > &array)
	Iterator to the end of the array More...
ZIVID_CORE_EXPORT std::ostream &	operator<< (std::ostream &stream, const Camera &camera)
	Serialize the value to a stream More...
template<typename T >
std::ostream &	operator<< (std::ostream &stream, const ColorRGBABase< T > &color)
	Serialize the value to a stream More...
	ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE (ColorRGBA, 4)
template<typename T >
std::ostream &	operator<< (std::ostream &stream, const ColorBGRABase< T > &color)
	Serialize the value to a stream More...
	ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE (ColorBGRA, 4)
ZIVID_CORE_EXPORT std::ostream &	operator<< (std::ostream &stream, const ComputeDevice &computeDevice)
	Serialize the value to a stream More...
ZIVID_CORE_EXPORT std::string	toString (const std::exception &exception)
	Get string representation of the exception More...
template<typename T , size_t rowCount, size_t colCount>
std::ostream &	operator<< (std::ostream &stream, const Matrix< T, rowCount, colCount > &matrix)
	Serialize the value to a stream More...
ZIVID_CORE_EXPORT std::ostream &	operator<< (std::ostream &stream, const PointXYZ &point)
	Serialize the value to a stream More...
	ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE (PointXYZ, 12)
ZIVID_CORE_EXPORT std::ostream &	operator<< (std::ostream &stream, const PointXYZW &point)
	Serialize the value to a stream More...
	ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE (PointXYZW, 16)
ZIVID_CORE_EXPORT std::ostream &	operator<< (std::ostream &stream, const PointZ &point)
	Serialize the value to a stream More...
	ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE (PointZ, 4)
ZIVID_CORE_EXPORT std::ostream &	operator<< (std::ostream &stream, const PointXY &point)
	Serialize the value to a stream More...
	ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE (PointXY, 8)
ZIVID_CORE_EXPORT std::ostream &	operator<< (std::ostream &stream, const PointCloud &pointCloud)
	Serialize the value to a stream More...
ZIVID_CORE_EXPORT std::ostream &	operator<< (std::ostream &stream, const PointXYZColorRGBA &pc)
	Serialize the value to a stream More...
	ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE (PointXYZColorRGBA, 16)
ZIVID_CORE_EXPORT std::ostream &	operator<< (std::ostream &stream, const PointXYZColorBGRA &pc)
	Serialize the value to a stream More...
	ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE (PointXYZColorBGRA, 16)
template<typename T >
std::ostream &	operator<< (std::ostream &os, const Range< T > &range)
	Append the range to a stream More...
ZIVID_CORE_EXPORT std::ostream &	operator<< (std::ostream &os, const Resolution &resolution)
	Append the resolution to a stream More...
ZIVID_CORE_EXPORT std::ostream &	operator<< (std::ostream &stream, const Zivid::SNR &snr)
	Serialize the value to a stream More...
	ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE (SNR, 4)
ZIVID_CORE_EXPORT std::ostream &	operator<< (std::ostream &stream, const VectorXYZ &point)
	Serialize the value to a stream More...
	ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE (VectorXYZ, 12)

Detailed Description

The main Zivid namespace. All Zivid code is found here

Typedef Documentation

Matrix3x3

using Zivid::Matrix3x3 = typedef Matrix<float, 3, 3>

Matrix of size 3x3 containing floats

Matrix3x3d

using Zivid::Matrix3x3d = typedef Matrix<double, 3, 3>

Matrix of size 3x3 containing doubles

Matrix4x4

using Zivid::Matrix4x4 = typedef Matrix<float, 4, 4>

Matrix of size 4x4 containing floats

Matrix4x4d

using Zivid::Matrix4x4d = typedef Matrix<double, 4, 4>

Matrix of size 4x4 containing doubles

Function Documentation

begin()

template<typename T >

Array2D< T >::ConstIterator Zivid::begin

(

const Array2D< T > &

array

)

Iterator to the beginning of the array

cbegin()

template<typename T >

Array2D< T >::ConstIterator Zivid::cbegin

(

const Array2D< T > &

array

)

Iterator to the beginning of the array

cend()

template<typename T >

Array2D< T >::ConstIterator Zivid::cend

(

const Array2D< T > &

array

)

Iterator to the end of the array

end()

template<typename T >

Array2D< T >::ConstIterator Zivid::end

(

const Array2D< T > &

array

)

Iterator to the end of the array

operator<<() [1/17]

template<typename T >

std::ostream & Zivid::operator<<	(	std::ostream &	os,
		const Range< T > &	range
	)

Append the range to a stream

operator<<() [2/17]

ZIVID_CORE_EXPORT std::ostream & Zivid::operator<<	(	std::ostream &	os,
		const Resolution &	resolution
	)

Append the resolution to a stream

operator<<() [3/17]

template<typename T >

std::ostream & Zivid::operator<<	(	std::ostream &	stream,
		const Array2D< T > &	array
	)

Serialize array information to a stream

operator<<() [4/17]

ZIVID_CORE_EXPORT std::ostream & Zivid::operator<<	(	std::ostream &	stream,
		const Camera &	camera
	)

Serialize the value to a stream

operator<<() [5/17]

template<typename T >

std::ostream & Zivid::operator<<	(	std::ostream &	stream,
		const ColorBGRABase< T > &	color
	)

Serialize the value to a stream

operator<<() [6/17]

template<typename T >

std::ostream & Zivid::operator<<	(	std::ostream &	stream,
		const ColorRGBABase< T > &	color
	)

Serialize the value to a stream

operator<<() [7/17]

ZIVID_CORE_EXPORT std::ostream & Zivid::operator<<	(	std::ostream &	stream,
		const ComputeDevice &	computeDevice
	)

Serialize the value to a stream

operator<<() [8/17]

template<typename T , size_t rowCount, size_t colCount>

std::ostream & Zivid::operator<<	(	std::ostream &	stream,
		const Matrix< T, rowCount, colCount > &	matrix
	)

Serialize the value to a stream

operator<<() [9/17]

ZIVID_CORE_EXPORT std::ostream & Zivid::operator<<	(	std::ostream &	stream,
		const PointCloud &	pointCloud
	)

Serialize the value to a stream

operator<<() [10/17]

ZIVID_CORE_EXPORT std::ostream & Zivid::operator<<	(	std::ostream &	stream,
		const PointXY &	point
	)

Serialize the value to a stream

operator<<() [11/17]

ZIVID_CORE_EXPORT std::ostream & Zivid::operator<<	(	std::ostream &	stream,
		const PointXYZ &	point
	)

Serialize the value to a stream

operator<<() [12/17]

ZIVID_CORE_EXPORT std::ostream & Zivid::operator<<	(	std::ostream &	stream,
		const PointXYZColorBGRA &	pc
	)

Serialize the value to a stream

operator<<() [13/17]

ZIVID_CORE_EXPORT std::ostream & Zivid::operator<<	(	std::ostream &	stream,
		const PointXYZColorRGBA &	pc
	)

Serialize the value to a stream

operator<<() [14/17]

ZIVID_CORE_EXPORT std::ostream & Zivid::operator<<	(	std::ostream &	stream,
		const PointXYZW &	point
	)

Serialize the value to a stream

operator<<() [15/17]

ZIVID_CORE_EXPORT std::ostream & Zivid::operator<<	(	std::ostream &	stream,
		const PointZ &	point
	)

Serialize the value to a stream

operator<<() [16/17]

ZIVID_CORE_EXPORT std::ostream & Zivid::operator<<	(	std::ostream &	stream,
		const VectorXYZ &	point
	)

Serialize the value to a stream

operator<<() [17/17]

ZIVID_CORE_EXPORT std::ostream & Zivid::operator<<	(	std::ostream &	stream,
		const Zivid::SNR &	snr
	)

Serialize the value to a stream

toString()

ZIVID_CORE_EXPORT std::string Zivid::toString

(

const std::exception &

exception

)

Get string representation of the exception

Returns

The exceptions as a string, potential nested exceptions are included as well

ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE() [1/10]

Zivid::ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE	(	ColorBGRA	,
		4
	)

ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE() [2/10]

Zivid::ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE	(	ColorRGBA	,
		4
	)

ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE() [3/10]

Zivid::ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE	(	PointXY	,
		8
	)

ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE() [4/10]

Zivid::ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE	(	PointXYZ	,
		12
	)

ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE() [5/10]

Zivid::ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE	(	PointXYZColorBGRA	,
		16
	)

ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE() [6/10]

Zivid::ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE	(	PointXYZColorRGBA	,
		16
	)

ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE() [7/10]

Zivid::ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE	(	PointXYZW	,
		16
	)

ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE() [8/10]

Zivid::ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE	(	PointZ	,
		4
	)

ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE() [9/10]

Zivid::ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE	(	SNR	,
		4
	)

ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE() [10/10]

Zivid::ZIVID_STATIC_ASSERT_DATA_FORMAT_TYPE	(	VectorXYZ	,
		12
	)