Processing(处理)(2D)
应用于 2D 图像的颜色处理(色彩平衡、伽马、Color Mode(颜色模式))。
有关如何选择这些设置的指导,请参阅 2D Settings(2D 设置)。
-
Processingclass
2D processing settings.
Public Functions
-
Processing()
Default constructor.
-
< Argstemplatetypename...>
Processing(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
Processingthen invokingset(args).The provided arguments must be descendants of
Processing. 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
Processing. These types can be provided:
-
< Argstemplatetypename...>
ProcessingcopyWith(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 Processing 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
Processing. These types can be provided:
-
Processing&set( Color&const value)inline
Set Color.
-
Processing&set( ColorBalance&const:: value)inline
Set Color::Balance.
-
Processing&set( ColorBalanceBlue&const:::: value)inline
Set Color::Balance::Blue.
-
Processing&set( ColorBalanceGreen&const:::: value)inline
-
Processing&set( ColorBalanceRed&const:::: value)inline
Set Color::Balance::Red.
-
Processing&set( ColorExperimental&const:: value)inline
Set Color::Experimental.
-
Processing&set( ColorExperimentalMode&const:::: value)inline
-
Processing&set( ColorGamma&const:: value)inline
Set Color::Gamma.
-
< 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( Processing&const other)constbool
Equality operator.
-
!=operator( Processing&const other)constbool
Inequality operator.
-
stdstringtoString()const::
Get the value as string.
Public Static Attributes
-
DataModelNodeTypenodeType=DataModelNodeTypegroupstaticconstexpr:: ::::
The type of this node.
-
path={}staticconstexprconstchar* "Processing"
The full path for this value.
-
name={}staticconstexprconstchar* "Processing"
The name of this value.
- static constexpr const char * description = { R"description(2D processing settings.)description" }
The description for this value.
Friends
-
stdostream&<<operator(stdostream&:: stream, Processing&const value)inlinefriend::
Operator to send the value as string to a stream.
-
Colorclass
Color settings.
Public Functions
-
Color()
Default constructor.
-
< Argstemplatetypename...>
Color(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
Colorthen invokingset(args).The provided arguments must be descendants of
Color. 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
Color. These types can be provided:
-
< Argstemplatetypename...>
ColorcopyWith(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 Color 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
Color. These types can be provided:
-
Color&set( BalanceBlue&const:: value)inline
Set Balance::Blue.
-
Color&set( BalanceGreen&const:: value)inline
Set Balance::Green.
-
Color&set( BalanceRed&const:: value)inline
Set Balance::Red.
-
Experimental&experimental()constinlineconst
Get Experimental.
-
Experimental&experimental()inline
Get Experimental.
-
Color&set( Experimental&const value)inline
Set Experimental.
-
Color&set( ExperimentalMode&const:: value)inline
Set Experimental::Mode.
-
< 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.
-
stdstringtoString()const::
Get the value as string.
Public Static Attributes
-
DataModelNodeTypenodeType=DataModelNodeTypegroupstaticconstexpr:: ::::
The type of this node.
-
path={}staticconstexprconstchar* "Processing/Color"
The full path for this value.
-
name={}staticconstexprconstchar* "Color"
The name of this value.
- static constexpr const char * description = { R"description(Color settings.)description" }
The description for this value.
Friends
-
Balanceclass
Color balance settings.
Public Functions
-
Balance()
Default constructor.
-
< Argstemplatetypename...>
Balance(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
Balancethen invokingset(args).The provided arguments must be descendants of
Balance. 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
Balance. These types can be provided:
-
< Argstemplatetypename...>
BalancecopyWith(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 Balance 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
Balance. These types can be provided:
-
< 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.
-
stdstringtoString()const::
Get the value as string.
Public Static Attributes
-
DataModelNodeTypenodeType=DataModelNodeTypegroupstaticconstexpr:: ::::
The type of this node.
-
path={}staticconstexprconstchar* "Processing/Color/Balance"
The full path for this value.
-
name={}staticconstexprconstchar* "Balance"
The name of this value.
- static constexpr const char * description = { R"description(Color balance settings.)description" }
The description for this value.
Friends
-
Blueclass
Digital gain applied to blue channel.
Public Types
-
ValueType=doubleusing
The type of the underlying value.
Public Functions
-
Blue()=default
Default constructor.
-
Blue( 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.
Public Static Functions
Public Static Attributes
-
DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::
The type of this node.
-
path={}staticconstexprconstchar* "Processing/Color/Balance/Blue"
The full path for this value.
-
name={}staticconstexprconstchar* "Blue"
The name of this value.
- static constexpr const char * description {R"description(Digital gain applied tobluechannel.)description"}
The description for this value.
-
ValueType=doubleusing
-
Greenclass
Digital gain applied to green channel.
Public Types
-
ValueType=doubleusing
The type of the underlying value.
Public Functions
-
Green()=default
Default constructor.
-
Green( 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.
Public Static Functions
Public Static Attributes
-
DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::
The type of this node.
-
path={}staticconstexprconstchar* "Processing/Color/Balance/Green"
The full path for this value.
-
name={}staticconstexprconstchar* "Green"
The name of this value.
- static constexpr const char * description {R"description(Digital gain applied togreenchannel.)description"}
The description for this value.
-
ValueType=doubleusing
-
Redclass
Digital gain applied to red channel.
Public Types
-
ValueType=doubleusing
The type of the underlying value.
Public Functions
-
Red()=default
Default constructor.
-
Red( 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.
Public Static Functions
Public Static Attributes
-
DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::
The type of this node.
-
path={}staticconstexprconstchar* "Processing/Color/Balance/Red"
The full path for this value.
-
name={}staticconstexprconstchar* "Red"
The name of this value.
- static constexpr const char * description {R"description(Digital gain applied toredchannel.)description"}
The description for this value.
-
ValueType=doubleusing
-
Balance()
-
Experimentalclass
Experimental color settings. These may be renamed, moved or deleted in the future.
Public Functions
-
Experimental()
Default constructor.
-
< Argstemplatetypename...>
Experimental(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
Experimentalthen invokingset(args).The provided arguments must be descendants of
Experimental. 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
Experimental. These types can be provided:
-
< Argstemplatetypename...>
ExperimentalcopyWith(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 Experimental 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
Experimental. These types can be provided:
-
Experimental&set( Mode&const value)inline
Set Mode.
-
< 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( Experimental&const other)constbool
Equality operator.
-
!=operator( Experimental&const other)constbool
Inequality operator.
-
stdstringtoString()const::
Get the value as string.
Public Static Attributes
-
DataModelNodeTypenodeType=DataModelNodeTypegroupstaticconstexpr:: ::::
The type of this node.
-
path={}staticconstexprconstchar* "Processing/Color/Experimental"
The full path for this value.
-
name={}staticconstexprconstchar* "Experimental"
The name of this value.
- static constexpr const char * description {R"description(Experimental colorsettings. These may be renamed, moved or deleted in the future.)description"}
The description for this value.
Friends
-
stdostream&<<operator(stdostream&:: stream, Experimental&const value)inlinefriend::
Operator to send the value as string to a stream.
-
Modeclass
This setting controls how the color image is computed.
automaticis the default option. It performs tone mapping for HDR captures, but not for single-acquisition captures. Use this mode with a single acquisition if you want to have the most control over the colors in the image.toneMappinguses all the acquisitions to create one merged and normalized color image. For HDR captures the dynamic range of the captured images is usually higher than the 8-bit color image range.toneMappingwill map the HDR color data to the 8-bit color output range by applying a scaling factor.toneMappingcan also be used for single-acquisition captures to normalize the captured color image to the full 8-bit output. Note that when usingtoneMappingmode the color values can be inconsistent over repeated captures if you move, add or remove objects in the scene. For the most control over the colors in the single-acquisition case, select theautomaticmode.Public Types
Public Functions
-
Mode()=default
Default constructor.
-
ValueTypevalue()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.
Public Static Attributes
-
DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::
The type of this node.
-
path={}staticconstexprconstchar* "Processing/Color/Experimental/Mode"
The full path for this value.
-
name={}staticconstexprconstchar* "Mode"
The name of this value.
- static constexpr const char * description {R"description(This setting controls how thecolorimage is computed.`automatic` is the default option. It performs tone mapping for HDR captures, but not forsingle-acquisition captures. Use thismodewith a single acquisition if you want to havethe most control over the colors in the image.`toneMapping` uses all the acquisitions to create one merged and normalized colorimage. ForHDR captures the dynamic range of the captured images is usually higher than the 8-bitcolor image range. `toneMapping` will map the HDR color data to the 8-bit coloroutput range byapplying a scaling factor. `toneMapping` can also be used for single-acquisition captures tonormalize the capturedcolor image to the full 8-bit output. Note that when using `toneMapping` mode the colorvalues can be inconsistent over repeated captures if you move, add or removeobjects in the scene. For the most control over the colors in the single-acquisition case,select the `automatic` mode.)description"}
The description for this value.
-
Mode()=default
-
Experimental()
-
Gammaclass
Gamma applied to the color values.
Gamma less than 1 makes the colors brighter, while gamma greater than 1 makes the colors darker.
Public Types
-
ValueType=doubleusing
The type of the underlying value.
Public Functions
-
Gamma()=default
Default constructor.
-
Gamma( 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.
Public Static Functions
Public Static Attributes
-
DataModelNodeTypenodeType=DataModelNodeTypeleafValuestaticconstexpr:: ::::
The type of this node.
-
path={}staticconstexprconstchar* "Processing/Color/Gamma"
The full path for this value.
-
name={}staticconstexprconstchar* "Gamma"
The name of this value.
- static constexpr const char * description {R"description(Gamma applied to the color values. Gamma less than 1 makes the colors brighter, while gammagreater than 1 makes the colors darker.)description"}
The description for this value.
-
ValueType=doubleusing
-
Color()
-
Processing()
-
ProcessingGroupstruct
2D processing settings.
Public Functions
-
ProcessingGroup()inline
Constructor.
- ProcessingGroup ^ 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.
- ProcessingGroup ^ Clone ()
Create a clone (deep copy) of the current instance.
- System::String ^ ToString () override
Get string representation of the object.
-
ColorGroupstruct
Color settings.
Public Functions
-
ColorGroup()inline
Constructor.
- ColorGroup ^ 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.
- ColorGroup ^ Clone ()
Create a clone (deep copy) of the current instance.
- System::String ^ ToString () override
Get string representation of the object.
Properties
-
SystemNullabledouble Gamma::<>
Gamma applied to the color values.
Gamma less than 1 makes the colors brighter, while gamma greater than 1 makes the colors darker.
-
BalanceGroupstruct
Color balance settings.
Public Functions
-
BalanceGroup()inline
Constructor.
- BalanceGroup ^ 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.
- BalanceGroup ^ Clone ()
Create a clone (deep copy) of the current instance.
- System::String ^ ToString () override
Get string representation of the object.
-
BalanceGroup()inline
-
ExperimentalGroupstruct
Experimental color settings. These may be renamed, moved or deleted in the future.
Public Types
-
ModeOption:stdunderlying_typeZividSettings2DProcessingColorExperimentalModeValueType::typeenumclass ::<::::::::::::>
This setting controls how the color image is computed.
automaticis the default option. It performs tone mapping for HDR captures, but not for single-acquisition captures. Use this mode with a single acquisition if you want to have the most control over the colors in the image.toneMappinguses all the acquisitions to create one merged and normalized color image. For HDR captures the dynamic range of the captured images is usually higher than the 8-bit color image range.toneMappingwill map the HDR color data to the 8-bit color output range by applying a scaling factor.toneMappingcan also be used for single-acquisition captures to normalize the captured color image to the full 8-bit output. Note that when usingtoneMappingmode the color values can be inconsistent over repeated captures if you move, add or remove objects in the scene. For the most control over the colors in the single-acquisition case, select theautomaticmode.Values:
-
Automaticenumerator
-
ToneMappingenumerator
-
Automaticenumerator
Public Functions
-
ExperimentalGroup()inline
Constructor.
- ExperimentalGroup ^ 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.
- ExperimentalGroup ^ Clone ()
Create a clone (deep copy) of the current instance.
- System::String ^ ToString () override
Get string representation of the object.
Properties
-
SystemNullableModeOption Mode::<>
This setting controls how the color image is computed.
automaticis the default option. It performs tone mapping for HDR captures, but not for single-acquisition captures. Use this mode with a single acquisition if you want to have the most control over the colors in the image.toneMappinguses all the acquisitions to create one merged and normalized color image. For HDR captures the dynamic range of the captured images is usually higher than the 8-bit color image range.toneMappingwill map the HDR color data to the 8-bit color output range by applying a scaling factor.toneMappingcan also be used for single-acquisition captures to normalize the captured color image to the full 8-bit output. Note that when usingtoneMappingmode the color values can be inconsistent over repeated captures if you move, add or remove objects in the scene. For the most control over the colors in the single-acquisition case, select theautomaticmode.
-
ModeOption:stdunderlying_typeZividSettings2DProcessingColorExperimentalModeValueType::typeenumclass ::<::::::::::::>
-
ColorGroup()inline
-
ProcessingGroup()inline
- classProcessing(:Settings2D | None=Nonecolor )
2D processing settings.
Initialization
- classColor(
- :float | int | None=Nonegamma ,
- :Settings2D | None=Nonebalance ,
- :Settings2D | None=Noneexperimental ,
Color settings.
Initialization
- classBalance( )
Color balance settings.
Initialization
- propertyblue
Digital gain applied to blue channel.
- propertygreen
Digital gain applied to green channel.
- propertyred
Digital gain applied to red channel.
- classExperimental(:str | None=Nonemode )
Experimental color settings. These may be renamed, moved or deleted in the future.
Initialization
- classMode
This setting controls how the color image is computed. automatic is the default option. It performs tone mapping for HDR captures, but not for single-acquisition captures. Use this mode with a single acquisition if you want to have the most control over the colors in the image. toneMapping uses all the acquisitions to create one merged and normalized color image. For HDR captures the dynamic range of the captured images is usually higher than the 8-bit color image range. toneMapping will map the HDR color data to the 8-bit color output range by applying a scaling factor. toneMapping can also be used for single-acquisition captures to normalize the captured color image to the full 8-bit output. Note that when using toneMapping mode the color values can be inconsistent over repeated captures if you move, add or remove objects in the scene. For the most control over the colors in the single-acquisition case, select the automatic mode.
- automatic='automatic'
- toneMapping='toneMapping'
- classmethodvalid_values()
All valid values of Mode
- propertymode
This setting controls how the color image is computed. automatic is the default option. It performs tone mapping for HDR captures, but not for single-acquisition captures. Use this mode with a single acquisition if you want to have the most control over the colors in the image. toneMapping uses all the acquisitions to create one merged and normalized color image. For HDR captures the dynamic range of the captured images is usually higher than the 8-bit color image range. toneMapping will map the HDR color data to the 8-bit color output range by applying a scaling factor. toneMapping can also be used for single-acquisition captures to normalize the captured color image to the full 8-bit output. Note that when using toneMapping mode the color values can be inconsistent over repeated captures if you move, add or remove objects in the scene. For the most control over the colors in the single-acquisition case, select the automatic mode.
- propertygamma
Gamma applied to the color values. Gamma less than 1 makes the colors brighter, while gamma greater than 1 makes the colors darker.
- propertybalance
Color balance settings.
- propertyexperimental
Experimental color settings. These may be renamed, moved or deleted in the future.
- propertycolor
Color settings.