Zivid::CaptureAssistant Namespace Reference

Classes
class	SuggestSettingsParameters
	SuggestSettingsParameters class is used to specify time constraint on total capture time for settings suggested by Capture Assistant functionality. A PC with recommended compute power or better is assumed. It is also used to optionally set ambient light frequency adaptation. More...

Enumerations
enum	AmbientLightFrequency { AmbientLightFrequency::hz50, AmbientLightFrequency::hz60, AmbientLightFrequency::none }
	AmbientLightFrequency is used to optionally ensure that the settings output by the Capture Assistant are compatible with the frequency of the ambient light present in the scene. More...

Functions
ZIVID_API_EXPORT std::string	toString (AmbientLightFrequency ambientLightFrequency)
	AmbientLightFrequency string representation More...
ZIVID_API_EXPORT std::ostream &	operator<< (std::ostream &stream, AmbientLightFrequency ambientLightFrequency)
	Serialize the value to a stream More...
ZIVID_API_EXPORT std::ostream &	operator<< (std::ostream &stream, const SuggestSettingsParameters &suggestSettingsParameters)
	Serialize the value to a stream More...
ZIVID_API_EXPORT std::vector< Settings >	suggestSettings (Camera &camera, const SuggestSettingsParameters &suggestSettingsParameters)
	Finds suggested settings for the current scene based on the SuggestSettingsParameters. More...

Variables
const Zivid::Range< std::chrono::milliseconds >	maxCaptureTimeRange

Enumeration Type Documentation

AmbientLightFrequency

enum Zivid::CaptureAssistant::AmbientLightFrequency

strong

AmbientLightFrequency is used to optionally ensure that the settings output by the Capture Assistant are compatible with the frequency of the ambient light present in the scene.

Enumerator
hz50
hz60
none

Function Documentation

operator<<() [1/2]

ZIVID_API_EXPORT std::ostream& Zivid::CaptureAssistant::operator<<	(	std::ostream &	stream,
		AmbientLightFrequency	ambientLightFrequency
	)

Serialize the value to a stream

operator<<() [2/2]

ZIVID_API_EXPORT std::ostream& Zivid::CaptureAssistant::operator<<	(	std::ostream &	stream,
		const SuggestSettingsParameters &	suggestSettingsParameters
	)

Serialize the value to a stream

suggestSettings()

ZIVID_API_EXPORT std::vector<Settings> Zivid::CaptureAssistant::suggestSettings	(	Camera &	camera,
		const SuggestSettingsParameters &	suggestSettingsParameters
	)

Finds suggested settings for the current scene based on the SuggestSettingsParameters.

The suggested settings returned from this function should be passed into Zivid::HDR::capture to perform the actual capture.

Parameters

camera	Reference to camera instance.
suggestSettingsParameters	Provides parameters (e.g., max capture time constraint) to the suggestSettings algorithm.

Returns

Vector of Settings. Capture with Zivid::HDR::capture.

toString()

ZIVID_API_EXPORT std::string Zivid::CaptureAssistant::toString

(

AmbientLightFrequency

ambientLightFrequency

)

AmbientLightFrequency string representation

Variable Documentation

maxCaptureTimeRange

const Zivid::Range<std::chrono::milliseconds> Zivid::CaptureAssistant::maxCaptureTimeRange

Initial value:

{ std::chrono::milliseconds(200),
                                                                           std::chrono::milliseconds(10000) }