Acquisition Settings（采集设置）

按采集划分的捕获设置：曝光时间、光圈、增益和投影仪亮度。3D 捕获会为采集列表中的每个采集项运行一次采集。

有关如何选择这些设置的指导，请参阅 Acquisition Settings (3D)。

C++

Acquisitionclass

Settings for a single acquisition.

Public Functions

Acquisition()

Default constructor.

< Argstemplatetypename...>
Acquisition(Args& &...args)inlineexplicit

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:

• Settings::Acquisition::Aperture

• Settings::Acquisition::Brightness

• Settings::Acquisition::ExposureTime

• Settings::Acquisition::Gain

< Argstemplatetypename...>
set(Args& &...args)inlinevoid

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:

• Settings::Acquisition::Aperture

• Settings::Acquisition::Brightness

• Settings::Acquisition::ExposureTime

• Settings::Acquisition::Gain

< Argstemplatetypename...>
AcquisitioncopyWith(Args& &...args)constinline

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:

• Settings::Acquisition::Aperture

• Settings::Acquisition::Brightness

• Settings::Acquisition::ExposureTime

• Settings::Acquisition::Gain

Aperture&aperture()constinlineconst

Get Aperture.

Aperture&aperture()inline

Get Aperture.

Acquisition&set( Aperture&const value)inline

Set Aperture.

Brightness&brightness()constinlineconst

Get Brightness.

Brightness&brightness()inline

Get Brightness.

Acquisition&set( Brightness&const value)inline

Set Brightness.

ExposureTime&exposureTime()constinlineconst

Get ExposureTime.

ExposureTime&exposureTime()inline

Get ExposureTime.

Acquisition&set( ExposureTime&const value)inline

Set ExposureTime.

Gain&gain()constinlineconst

Get Gain.

Gain&gain()inline

Get Gain.

Acquisition&set( Gain&const value)inline

Set Gain.

< Ftemplatetypename>
forEach( F&const f)constinlinevoid

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

< Ftemplatetypename>
forEach( F&const f)inlinevoid

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

==operator( Acquisition&const other)constbool

Equality operator.

!=operator( Acquisition&const other)constbool

Inequality operator.

stdstringtoString()const::

Get the value as string.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypegroupstaticconstexpr:: ::::

The type of this node.

path={}staticconstexprconstchar* "Acquisition"

The full path for this value.

name={}staticconstexprconstchar* "Acquisition"

The name of this value.

static constexpr const char * description   = { R"description(Settings for a single acquisition.)description" }

The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, Acquisition&const value)inlinefriend::

Operator to send the value as string to a stream.

Apertureclass

Aperture setting for the camera.

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

Public Types

ValueType=doubleusing

The type of the underlying value.

Public Functions

Aperture()=default

Default constructor.

Aperture( doublevalue)inlineexplicitconstexpr

Constructor.

value()constdouble

Get the value.

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

hasValue()constbool

Check if the value is set.

reset()void

Reset the node to unset state.

stdstringtoString()const::

Get the value as string.

==operator( Aperture&const other)constinlinebool

Comparison operator.

!=operator( Aperture&const other)constinlinebool

Comparison operator.

<operator( Aperture&const other)constinlinebool

Comparison operator.

>operator( Aperture&const other)constinlinebool

Comparison operator.

<=operator( Aperture&const other)constinlinebool

Comparison operator.

>=operator( Aperture&const other)constinlinebool

Comparison operator.

Public Static Functions

Rangedouble validRange()staticinlineconstexpr<>

The range of valid values for Aperture.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::

The type of this node.

path={}staticconstexprconstchar* "Acquisition/Aperture"

The full path for this value.

name={}staticconstexprconstchar* "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).)description"}

The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, Aperture&const value)inlinefriend::

Operator to serialize the value to a stream.

Brightnessclass

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

ValueType=doubleusing

The type of the underlying value.

Public Functions

Brightness()=default

Default constructor.

Brightness( doublevalue)inlineexplicitconstexpr

Constructor.

value()constdouble

Get the value.

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

hasValue()constbool

Check if the value is set.

reset()void

Reset the node to unset state.

stdstringtoString()const::

Get the value as string.

==operator( Brightness&const other)constinlinebool

Comparison operator.

!=operator( Brightness&const other)constinlinebool

Comparison operator.

<operator( Brightness&const other)constinlinebool

Comparison operator.

>operator( Brightness&const other)constinlinebool

Comparison operator.

<=operator( Brightness&const other)constinlinebool

Comparison operator.

>=operator( Brightness&const other)constinlinebool

Comparison operator.

Public Static Functions

Rangedouble validRange()staticinlineconstexpr<>

The range of valid values for Brightness.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::

The type of this node.

path={}staticconstexprconstchar* "Acquisition/Brightness"

The full path for this value.

name={}staticconstexprconstchar* "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

stdostream&<<operator(stdostream&:: stream, Brightness&const value)inlinefriend::

Operator to serialize the value to a stream.

ExposureTimeclass

Exposure time for each single image in the measurement. Affects frame rate.

Public Types

ValueType=stdchronomicrosecondsusing ::::

The type of the underlying value.

Public Functions

ExposureTime()=default

Default constructor.

ExposureTime(stdchronomicrosecondsvalue:::: )inlineexplicitconstexpr

Constructor.

stdchronomicrosecondsvalue()const::::

Get the value.

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

hasValue()constbool

Check if the value is set.

reset()void

Reset the node to unset state.

stdstringtoString()const::

Get the value as string.

==operator( ExposureTime&const other)constinlinebool

Comparison operator.

!=operator( ExposureTime&const other)constinlinebool

Comparison operator.

<operator( ExposureTime&const other)constinlinebool

Comparison operator.

>operator( ExposureTime&const other)constinlinebool

Comparison operator.

<=operator( ExposureTime&const other)constinlinebool

Comparison operator.

>=operator( ExposureTime&const other)constinlinebool

Comparison operator.

Public Static Functions

Rangestdchronomicroseconds validRange()staticinlineconstexpr<::::>

The range of valid values for ExposureTime.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::

The type of this node.

path={}staticconstexprconstchar* "Acquisition/ExposureTime"

The full path for this value.

name={}staticconstexprconstchar* "ExposureTime"

The name of this value.

static constexpr const char * description  {R"description(Exposure time for each single image in the measurement. Affectsframerate.)description"}

The description for this value.

Friends

stdostream&<<operator(stdostream&:: stream, ExposureTime&const value)inlinefriend::

Operator to serialize the value to a stream.

Gainclass

Analog gain in the camera.

Public Types

ValueType=doubleusing

The type of the underlying value.

Public Functions

Gain()=default

Default constructor.

Gain( doublevalue)inlineexplicitconstexpr

Constructor.

value()constdouble

Get the value.

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

hasValue()constbool

Check if the value is set.

reset()void

Reset the node to unset state.

stdstringtoString()const::

Get the value as string.

==operator( Gain&const other)constinlinebool

Comparison operator.

!=operator( Gain&const other)constinlinebool

Comparison operator.

<operator( Gain&const other)constinlinebool

Comparison operator.

>operator( Gain&const other)constinlinebool

Comparison operator.

<=operator( Gain&const other)constinlinebool

Comparison operator.

>=operator( Gain&const other)constinlinebool

Comparison operator.

Public Static Functions

Rangedouble validRange()staticinlineconstexpr<>

The range of valid values for Gain.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::

The type of this node.

path={}staticconstexprconstchar* "Acquisition/Gain"

The full path for this value.

name={}staticconstexprconstchar* "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

stdostream&<<operator(stdostream&:: stream, Gain&const value)inlinefriend::

Operator to serialize the value to a stream.

C#

Acquisitionstruct

Settings for a single acquisition.

Public Functions

Acquisition()inline

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

SystemNullabledouble Aperture::<>

Aperture setting for the camera.

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

SystemNullabledouble 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.

SystemNullable::ZividNETDuration ExposureTime::<::::>

Exposure time for each single image in the measurement. Affects frame rate.

SystemNullabledouble Gain::<>

Analog gain in the camera.

Python

classAcquisition(

:float | int | None=Noneaperture ,

:float | int | None=Nonebrightness ,

:timedelta | None=Noneexposure_time ,

:float | int | None=Nonegain ,

)

Settings for a single acquisition.

Initialization

propertyaperture

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

propertybrightness

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.

propertyexposure_time

Exposure time for each single image in the measurement. Affects frame rate.

propertygain

Analog gain in the camera.