SceneConditions

相机报告的场景环境光照条件信息。

SceneConditionsclass

A description of the ambient conditions detected by the camera.

Public Functions

SceneConditions()

Default constructor.

SceneConditions( stdstring&const:: fileName)explicit

Construct SceneConditions by loading from file.

stdstringserialize()const::

Serialize to a string.

See also fromSerialized. The returned string is formatted in YAML, and is compatible with the contents of files saved using save.

< Argstemplatetypename...>
SceneConditions(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 SceneConditions then invoking set(args).

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

< 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 SceneConditions. These types can be provided:

< Argstemplatetypename...>
SceneConditionscopyWith(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 SceneConditions 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 SceneConditions. These types can be provided:

AmbientLight&ambientLight()constinlineconst

Get AmbientLight.

AmbientLight&ambientLight()inline

Get AmbientLight.

SceneConditions&set( AmbientLight&const value)inline

Set AmbientLight.

SceneConditions&set( AmbientLightFlickerClassification&const:: value)inline

Set AmbientLight::FlickerClassification.

SceneConditions&set( AmbientLightFlickerFrequency&const:: value)inline

Set AmbientLight::FlickerFrequency.

< 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( SceneConditions&const other)constbool

Equality operator.

!=operator( SceneConditions&const other)constbool

Inequality operator.

stdstringtoString()const::

Get the value as string.

save( stdstring&const:: fileName)constvoid

Save to the given file.

load( stdstring&const:: fileName)void

Load from the given file.

Public Static Functions

SceneConditionsfromSerialized( stdstring&const:: value)static

Construct a new SceneConditions instance from a previously serialized string.

See also serialize.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypegroupstaticconstexpr:: ::::

The type of this node.

path={}staticconstexprconstchar* ""

The full path for this value.

name={}staticconstexprconstchar* "SceneConditions"

The name of this value.

static constexpr const char * description  {R"description(A description of the ambient conditions detected by the camera.)description"}

The description for this value.

Friends

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

Operator to send the value as string to a stream.

AmbientLightclass

The ambient light detected by the camera.

Public Functions

AmbientLight()

Default constructor.

< Argstemplatetypename...>
AmbientLight(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 AmbientLight then invoking set(args).

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

< 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 AmbientLight. These types can be provided:

< Argstemplatetypename...>
AmbientLightcopyWith(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 AmbientLight 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 AmbientLight. These types can be provided:

FlickerClassification&flickerClassification()constinlineconst

Get FlickerClassification.

FlickerClassification&flickerClassification()inline

Get FlickerClassification.

AmbientLight&set( FlickerClassification&const value)inline

Set FlickerClassification.

FlickerFrequency&flickerFrequency()constinlineconst

Get FlickerFrequency.

FlickerFrequency&flickerFrequency()inline

Get FlickerFrequency.

AmbientLight&set( FlickerFrequency&const value)inline

Set FlickerFrequency.

< 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( AmbientLight&const other)constbool

Equality operator.

!=operator( AmbientLight&const other)constbool

Inequality operator.

stdstringtoString()const::

Get the value as string.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypegroupstaticconstexpr:: ::::

The type of this node.

path={}staticconstexprconstchar* "AmbientLight"

The full path for this value.

name={}staticconstexprconstchar* "AmbientLight"

The name of this value.

static constexpr const char * description  { R"description(The ambient light detected by the camera.)description" }

The description for this value.

Friends

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

Operator to send the value as string to a stream.

FlickerClassificationclass

A classification of the detected ambient light flicker, if any.

The values grid50hz and grid60hz indicate that ambient light matching a 50 Hz or 60 Hz power grid was detected in the scene. In those cases it is recommended to use Ambient Light Adaptation for better point cloud quality. The value unknownFlicker indicates that some significant time-varying ambient light was detected, but it was not possible to determine the frequency. otherFlicker indicates that ambient light of a particular frequency was detected but it did not match the characteristics of a standard power grid.

Public Types

ValueTypeenumclass

The type of the underlying value.

Values:

noFlickerenumerator
unknownFlickerenumerator
grid50hzenumerator
grid60hzenumerator
otherFlickerenumerator

Public Functions

FlickerClassification()=default

Default constructor.

FlickerClassification(ValueTypevalue )inlineexplicitconstexpr

Constructor.

ValueTypevalue()const

Get the value.

stdstringtoString()const::

Get the value as string.

==operator( FlickerClassification&const other)constinlinebool

Comparison operator.

!=operator( FlickerClassification&const other)constinlinebool

Comparison operator.

Public Static Functions

stdsetValueType validValues()staticinline::<>

All valid values of FlickerClassification.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::

The type of this node.

path={}staticconstexprconstchar* "AmbientLight/FlickerClassification"

The full path for this value.

name={}staticconstexprconstchar* "FlickerClassification"

The name of this value.

static constexpr const char * description  {R"description(A classification of the detected ambient light flicker, if any.The values `grid50hz` and `grid60hz` indicate that ambientlight matching a 50 Hz or 60 Hz power grid was detected in thescene. In those cases it is recommended to use Ambient LightAdaptation for better point cloud quality. Thevalue `unknownFlicker` indicates that some significant time-varyingambient light was detected, but it was not possible todetermine the frequency. `otherFlicker` indicates that ambientlight of a particular frequency was detected but it did notmatch the characteristics of a standard power grid.)description"}

The description for this value.

FlickerClassificationnoFlickerstaticconst

noFlicker

FlickerClassificationunknownFlickerstaticconst

unknownFlicker

FlickerClassificationgrid50hzstaticconst

grid50hz

FlickerClassificationgrid60hzstaticconst

grid60hz

FlickerClassificationotherFlickerstaticconst

otherFlicker

Friends

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

Operator to serialize ValueType to a stream.

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

Operator to serialize the value to a stream.

FlickerFrequencyclass

This field contains the actual frequency unless the classification is noFlicker or unknownFlicker.

Public Types

ValueType=doubleusing

The type of the underlying value.

Public Functions

FlickerFrequency()=default

Default constructor.

FlickerFrequency( 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( FlickerFrequency&const other)constinlinebool

Comparison operator.

!=operator( FlickerFrequency&const other)constinlinebool

Comparison operator.

<operator( FlickerFrequency&const other)constinlinebool

Comparison operator.

>operator( FlickerFrequency&const other)constinlinebool

Comparison operator.

<=operator( FlickerFrequency&const other)constinlinebool

Comparison operator.

>=operator( FlickerFrequency&const other)constinlinebool

Comparison operator.

Public Static Functions

Rangedouble validRange()staticinlineconstexpr<>

The range of valid values for FlickerFrequency.

Public Static Attributes

DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::

The type of this node.

path={}staticconstexprconstchar* "AmbientLight/FlickerFrequency"

The full path for this value.

name={}staticconstexprconstchar* "FlickerFrequency"

The name of this value.

static constexpr const char * description  {R"description(This field contains the actual frequency unless theclassification is `noFlicker` or `unknownFlicker`.)description"}

The description for this value.

Friends

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

Operator to serialize the value to a stream.

SceneConditionsstruct

A description of the ambient conditions detected by the camera.

Public Functions

System::String ^ Serialize ()

Serialize to a string.

See also FromSerialized. The returned string is formatted in YAML, and is compatible with the contents of files saved using Save.

void Save (System::String ^ fileName)

Save to the given file.

void Load (System::String ^ fileName)

Load from the given file.

SceneConditions()inline

Constructor.

SceneConditions ^ 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.

SceneConditions ^ Clone ()

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

System::String ^ ToString () override

Get string representation of the object.

Public Static Attributes

static SceneConditions(System::String ^ fileName) SceneConditions FromSerialized )(System::String ^ value)

Construct SceneConditions by loading from file.

Construct a new SceneConditions instance from a previously serialized string

See also Serialize.

AmbientLightGroupstruct

The ambient light detected by the camera.

Public Types

FlickerClassificationOption:stdunderlying_typeZividSceneConditionsAmbientLightFlickerClassificationValueType::typeenumclass ::<::::::::>

A classification of the detected ambient light flicker, if any.

The values grid50hz and grid60hz indicate that ambient light matching a 50 Hz or 60 Hz power grid was detected in the scene. In those cases it is recommended to use Ambient Light Adaptation for better point cloud quality. The value unknownFlicker indicates that some significant time-varying ambient light was detected, but it was not possible to determine the frequency. otherFlicker indicates that ambient light of a particular frequency was detected but it did not match the characteristics of a standard power grid.

Values:

NoFlickerenumerator
UnknownFlickerenumerator
Grid50hzenumerator
Grid60hzenumerator
OtherFlickerenumerator

Public Functions

AmbientLightGroup()inline

Constructor.

AmbientLightGroup ^ 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.

AmbientLightGroup ^ Clone ()

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

System::String ^ ToString () override

Get string representation of the object.

Properties

FlickerClassificationOptionFlickerClassification

A classification of the detected ambient light flicker, if any.

The values grid50hz and grid60hz indicate that ambient light matching a 50 Hz or 60 Hz power grid was detected in the scene. In those cases it is recommended to use Ambient Light Adaptation for better point cloud quality. The value unknownFlicker indicates that some significant time-varying ambient light was detected, but it was not possible to determine the frequency. otherFlicker indicates that ambient light of a particular frequency was detected but it did not match the characteristics of a standard power grid.

SystemNullabledouble FlickerFrequency::<>

This field contains the actual frequency unless the classification is noFlicker or unknownFlicker.

classSceneConditions(:SceneConditions | None=Noneambient_light )

A description of the ambient conditions detected by the camera.

Initialization

classAmbientLight(
:str='unknownFlicker'flicker_classification ,
:float | int | None=Noneflicker_frequency ,
)

The ambient light detected by the camera.

Initialization

classFlickerClassification

A classification of the detected ambient light flicker, if any. The values grid50hz and grid60hz indicate that ambient light matching a 50 Hz or 60 Hz power grid was detected in the scene. In those cases it is recommended to use Ambient Light Adaptation for better point cloud quality. The value unknownFlicker indicates that some significant time-varying ambient light was detected, but it was not possible to determine the frequency. otherFlicker indicates that ambient light of a particular frequency was detected but it did not match the characteristics of a standard power grid.

grid50hz='grid50hz'
grid60hz='grid60hz'
noFlicker='noFlicker'
otherFlicker='otherFlicker'
unknownFlicker='unknownFlicker'
classmethodvalid_values()

All valid values of FlickerClassification

propertyflicker_classification

A classification of the detected ambient light flicker, if any. The values grid50hz and grid60hz indicate that ambient light matching a 50 Hz or 60 Hz power grid was detected in the scene. In those cases it is recommended to use Ambient Light Adaptation for better point cloud quality. The value unknownFlicker indicates that some significant time-varying ambient light was detected, but it was not possible to determine the frequency. otherFlicker indicates that ambient light of a particular frequency was detected but it did not match the characteristics of a standard power grid.

propertyflicker_frequency

This field contains the actual frequency unless the classification is noFlicker or unknownFlicker.

propertyambient_light

The ambient light detected by the camera.

classmethodload(file_name)

Construct SceneConditions by loading from file

save(file_name)

Save to the given file

classmethodfrom_serialized(value)

Construct a new SceneConditions instance from a previously serialized string

See also serialize.

serialize()

Serialize to a string

See also from_serialized. The returned string is formatted in YAML, and is compatible with the contents of files saved using save.