Acquisition Settings (2D)

Per-acquisition settings for a 2D capture: exposure time, aperture, gain and projector brightness.

For guidance on choosing these settings, see Acquisition Settings (2D).

class Acquisition

Settings for one 2D acquisition.

When capturing 2D HDR, all 2D acquisitions must have the same Aperture setting. Use Exposure Time or Gain to control the exposure instead.

Public Functions

Acquisition()

Default constructor.

template<typename ...Args>
inline explicit Acquisition(Args&&... args)

Constructor taking variadic number of arguments.

One or more descendant types can be provided. All types not provided will be set to their default value. The result is the same as default constructing Acquisition then invoking set(args).

The provided arguments must be descendants of Acquisition. These types can be provided:

template<typename ...Args>
inline void set(Args&&... args)

Set multiple arguments.

The method invokes set(arg) with each of the provided arguments.

The provided arguments must be descendants of Acquisition. These types can be provided:

template<typename ...Args>
inline Acquisition copyWith(Args&&... args) const

Returns a copy of this object with the given argument(s) set to the new value(s)

Creates a copy of this Acquisition object, then invokes set(args) on the copy, and finally returns the copy. This method does not modify the original object.

The provided arguments must be descendants of Acquisition. These types can be provided:

inline const Aperture &aperture() const

Get Aperture.

inline Aperture &aperture()

Get Aperture.

inline Acquisition &set(const Aperture &value)

Set Aperture.

inline const Brightness &brightness() const

Get Brightness.

inline Brightness &brightness()

Get Brightness.

inline Acquisition &set(const Brightness &value)

Set Brightness.

inline const ExposureTime &exposureTime() const

Get ExposureTime.

inline ExposureTime &exposureTime()

Get ExposureTime.

inline Acquisition &set(const ExposureTime &value)

Set ExposureTime.

inline const Gain &gain() const

Get Gain.

inline Gain &gain()

Get Gain.

inline Acquisition &set(const Gain &value)

Set Gain.

template<typename F>
inline void forEach(const F &f) const

Run the given function on each direct member with the value of the member as parameter.

template<typename F>
inline void forEach(const F &f)

Run the given function on each direct member with the value of the member as parameter.

bool operator==(const Acquisition &other) const

Equality operator.

bool operator!=(const Acquisition &other) const

Inequality operator.

std::string toString() const

Get the value as string.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group

The type of this node.

static constexpr const char *path = {"Acquisition"}

The full path for this value.

static constexpr const char *name = {"Acquisition"}

The name of this value.

static constexpr const char * description   = { R"description(Settingsfor one 2D acquisition.When capturing 2D HDR, all 2Dacquisitions must have the same Aperturesetting. Use Exposure TimeorGainto control the exposure instead.)description" }

The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Acquisition &value)

Operator to send the value as string to a stream.

class Aperture

Aperture setting for the camera.

Specified as an f-number (the ratio of lens focal length to the effective aperture diameter).

When capturing 2D HDR, all 2D acquisitions must have the same Aperture setting. Use Exposure Time or Gain to control the exposure instead.

Public Types

using ValueType = double

The type of the underlying value.

Public Functions

Aperture() = default

Default constructor.

inline explicit constexpr Aperture(double value)

Constructor.

double value() const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

bool hasValue() const

Check if the value is set.

void reset()

Reset the node to unset state.

std::string toString() const

Get the value as string.

inline bool operator==(const Aperture &other) const

Comparison operator.

inline bool operator!=(const Aperture &other) const

Comparison operator.

inline bool operator<(const Aperture &other) const

Comparison operator.

inline bool operator>(const Aperture &other) const

Comparison operator.

inline bool operator<=(const Aperture &other) const

Comparison operator.

inline bool operator>=(const Aperture &other) const

Comparison operator.

Public Static Functions

static inline constexpr Range<double> validRange()

The range of valid values for Aperture.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue

The type of this node.

static constexpr const char *path = {"Acquisition/Aperture"}

The full path for this value.

static constexpr const char *name = {"Aperture"}

The name of this value.

static constexpr const char * description  {R"description(Aperturesetting for the camera. Specified as an f-number (the ratio of lens focal length tothe effectiveaperturediameter).When capturing 2D HDR, all 2Dacquisitions must have the same Aperturesetting. Use Exposure TimeorGainto control the exposure instead.)description"}

The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Aperture &value)

Operator to serialize the value to a stream.

class Brightness

Brightness controls the light output from the projector.

Brightness above 1.0 may be needed when the distance between the camera and the scene is large, or in case of high levels of ambient lighting.

When brightness is above 1.0 the duty cycle of the camera (the percentage of time the camera can capture) will be reduced. The duty cycle in boost mode is 50%. The duty cycle is calculated over a 10 second period. This limitation is enforced automatically by the camera. Calling capture when the duty cycle limit has been reached will cause the camera to first wait (sleep) for a duration of time to cool down, before capture will start.

Public Types

using ValueType = double

The type of the underlying value.

Public Functions

Brightness() = default

Default constructor.

inline explicit constexpr Brightness(double value)

Constructor.

double value() const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

bool hasValue() const

Check if the value is set.

void reset()

Reset the node to unset state.

std::string toString() const

Get the value as string.

inline bool operator==(const Brightness &other) const

Comparison operator.

inline bool operator!=(const Brightness &other) const

Comparison operator.

inline bool operator<(const Brightness &other) const

Comparison operator.

inline bool operator>(const Brightness &other) const

Comparison operator.

inline bool operator<=(const Brightness &other) const

Comparison operator.

inline bool operator>=(const Brightness &other) const

Comparison operator.

Public Static Functions

static inline constexpr Range<double> validRange()

The range of valid values for Brightness.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue

The type of this node.

static constexpr const char *path = {"Acquisition/Brightness"}

The full path for this value.

static constexpr const char *name = {"Brightness"}

The name of this value.

static constexpr const char * description  {R"description(Brightness controls the light output from the projector.  Brightnessabove 1.0 may be needed when the distance between the camera and the scene is large,or in case of high levels of ambient lighting.Whenbrightnessis above 1.0 the duty cycle of the camera (the percentage of time the cameracan capture) will be reduced. The duty cycle in boost mode is 50%. The duty cycle is calculatedover a 10 second period. This limitation is enforced automatically by the camera. Calling capturewhen the duty cycle limit has been reached will cause the camera to first wait (sleep) for aduration of time to cool down, before capture will start.)description"}

The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Brightness &value)

Operator to serialize the value to a stream.

class ExposureTime

Exposure time for the image.

Public Types

using ValueType = std::chrono::microseconds

The type of the underlying value.

Public Functions

ExposureTime() = default

Default constructor.

inline explicit constexpr ExposureTime(std::chrono::microseconds value)

Constructor.

std::chrono::microseconds value() const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

bool hasValue() const

Check if the value is set.

void reset()

Reset the node to unset state.

std::string toString() const

Get the value as string.

inline bool operator==(const ExposureTime &other) const

Comparison operator.

inline bool operator!=(const ExposureTime &other) const

Comparison operator.

inline bool operator<(const ExposureTime &other) const

Comparison operator.

inline bool operator>(const ExposureTime &other) const

Comparison operator.

inline bool operator<=(const ExposureTime &other) const

Comparison operator.

inline bool operator>=(const ExposureTime &other) const

Comparison operator.

Public Static Functions

static inline constexpr Range<std::chrono::microseconds> validRange()

The range of valid values for ExposureTime.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue

The type of this node.

static constexpr const char *path = {"Acquisition/ExposureTime"}

The full path for this value.

static constexpr const char *name = {"ExposureTime"}

The name of this value.

static constexpr const char * description   = { R"description(Exposure time for the image.)description" }

The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const ExposureTime &value)

Operator to serialize the value to a stream.

class Gain

Analog gain in the camera.

Public Types

using ValueType = double

The type of the underlying value.

Public Functions

Gain() = default

Default constructor.

inline explicit constexpr Gain(double value)

Constructor.

double value() const

Get the value.

If this object does not contain a value (see hasValue) then this method throws an exception.

bool hasValue() const

Check if the value is set.

void reset()

Reset the node to unset state.

std::string toString() const

Get the value as string.

inline bool operator==(const Gain &other) const

Comparison operator.

inline bool operator!=(const Gain &other) const

Comparison operator.

inline bool operator<(const Gain &other) const

Comparison operator.

inline bool operator>(const Gain &other) const

Comparison operator.

inline bool operator<=(const Gain &other) const

Comparison operator.

inline bool operator>=(const Gain &other) const

Comparison operator.

Public Static Functions

static inline constexpr Range<double> validRange()

The range of valid values for Gain.

Public Static Attributes

static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue

The type of this node.

static constexpr const char *path = {"Acquisition/Gain"}

The full path for this value.

static constexpr const char *name = {"Gain"}

The name of this value.

static constexpr const char * description   = { R"description(Analog gain in the camera.)description" }

The description for this value.

Friends

inline friend std::ostream &operator<<(std::ostream &stream, const Gain &value)

Operator to serialize the value to a stream.

struct Acquisition

Settings for one 2D acquisition.

When capturing 2D HDR, all 2D acquisitions must have the same Aperture setting. Use Exposure Time or Gain to control the exposure instead.

Public Functions

inline Acquisition()

Constructor.

Acquisition ^ CopyWith (CopyWithDelegate ^ delegate)

Create a clone (deep copy) of the current instance and invoke delegate on the clone.

Creates a clone (deep copy) of this object, then invokes the delegate function on the clone, and finally returns the clone. This method can be used to create a clone of an instance and then change one or more properties on the clone in one method call. The current instance is unchanged.

Acquisition ^ Clone ()

Create a clone (deep copy) of the current instance.

System::String ^ ToString () override

Get string representation of the object.

Properties

System::Nullable<double> Aperture

Aperture setting for the camera.

Specified as an f-number (the ratio of lens focal length to the effective aperture diameter).

When capturing 2D HDR, all 2D acquisitions must have the same Aperture setting. Use Exposure Time or Gain to control the exposure instead.

System::Nullable<double> Brightness

Brightness controls the light output from the projector.

Brightness above 1.0 may be needed when the distance between the camera and the scene is large, or in case of high levels of ambient lighting.

When brightness is above 1.0 the duty cycle of the camera (the percentage of time the camera can capture) will be reduced. The duty cycle in boost mode is 50%. The duty cycle is calculated over a 10 second period. This limitation is enforced automatically by the camera. Calling capture when the duty cycle limit has been reached will cause the camera to first wait (sleep) for a duration of time to cool down, before capture will start.

System::Nullable<::Zivid::NET::Duration> ExposureTime

Exposure time for the image.

System::Nullable<double> Gain

Analog gain in the camera.

class Acquisition(
aperture: float | int | None = _zivid.Settings2D.Acquisition.Aperture().value,
brightness: float | int | None = _zivid.Settings2D.Acquisition.Brightness().value,
exposure_time: timedelta | None = _zivid.Settings2D.Acquisition.ExposureTime().value,
gain: float | int | None = _zivid.Settings2D.Acquisition.Gain().value,
)

Settings for one 2D acquisition. When capturing 2D HDR, all 2D acquisitions must have the same Aperture setting. Use Exposure Time or Gain to control the exposure instead.

property aperture

Aperture setting for the camera. Specified as an f-number (the ratio of lens focal length to the effective aperture diameter). When capturing 2D HDR, all 2D acquisitions must have the same Aperture setting. Use Exposure Time or Gain to control the exposure instead.

property brightness

Brightness controls the light output from the projector. Brightness above 1.0 may be needed when the distance between the camera and the scene is large, or in case of high levels of ambient lighting. When brightness is above 1.0 the duty cycle of the camera (the percentage of time the camera can capture) will be reduced. The duty cycle in boost mode is 50%. The duty cycle is calculated over a 10 second period. This limitation is enforced automatically by the camera. Calling capture when the duty cycle limit has been reached will cause the camera to first wait (sleep) for a duration of time to cool down, before capture will start.

property exposure_time

Exposure time for the image.

property gain

Analog gain in the camera.