set_structured_light_model_paramT_set_structured_light_model_paramSetStructuredLightModelParamSetStructuredLightModelParamset_structured_light_model_param (Operator)

Name

set_structured_light_model_paramT_set_structured_light_model_paramSetStructuredLightModelParamSetStructuredLightModelParamset_structured_light_model_param — Set parameters of a structured light model.

Signature

Description

The operator set_structured_light_model_paramset_structured_light_model_paramSetStructuredLightModelParamSetStructuredLightModelParamSetStructuredLightModelParamset_structured_light_model_param is used to manipulate the parameters of a structured light model StructuredLightModelStructuredLightModelStructuredLightModelStructuredLightModelstructuredLightModelstructured_light_model. The current parameter settings can be queried with the operator get_structured_light_model_paramget_structured_light_model_paramGetStructuredLightModelParamGetStructuredLightModelParamGetStructuredLightModelParamget_structured_light_model_param.

For an explanation of the concept of structured light and its supported applications, see the introduction of chapter Inspection / Structured Light.

General parameters:

'persistence'"persistence""persistence""persistence""persistence""persistence":

Enables (GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value='true'"true""true""true""true""true") or disables (GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value='false'"false""false""false""false""false") the 'persistence'"persistence""persistence""persistence""persistence""persistence" mode of the structured light model. When in persistence mode, the model stores intermediate results of the decoding, which can be inspected later by get_structured_light_objectget_structured_light_objectGetStructuredLightObjectGetStructuredLightObjectGetStructuredLightObjectget_structured_light_object.

Note that the model might need significant memory space in this mode. Therefore, we recommend to enable this mode only during the setup and for debugging a structured light model setup.

If 'persistence'"persistence""persistence""persistence""persistence""persistence" is changed, all results of the model are cleared.

Values: 'true'"true""true""true""true""true", 'false'"false""false""false""false""false", 1, 0

Default: 'false'"false""false""false""false""false"

Parameters which influence the appearance of the generated pattern images:

'pattern_width'"pattern_width""pattern_width""pattern_width""pattern_width""pattern_width":

Sets the width of the pattern images that are generated while calling gen_structured_light_patterngen_structured_light_patternGenStructuredLightPatternGenStructuredLightPatternGenStructuredLightPatterngen_structured_light_pattern. Usually, the value should be set to the width of the monitor that is used to display the pattern images.

The value of 'pattern_width'"pattern_width""pattern_width""pattern_width""pattern_width""pattern_width" has to be larger than the value 'min_stripe_width'"min_stripe_width""min_stripe_width""min_stripe_width""min_stripe_width""min_stripe_width"/2. In case that 'pattern_type'"pattern_type""pattern_type""pattern_type""pattern_type""pattern_type" is 'single_stripe'"single_stripe""single_stripe""single_stripe""single_stripe""single_stripe", it also has to be larger than 'single_stripe_width'"single_stripe_width""single_stripe_width""single_stripe_width""single_stripe_width""single_stripe_width"/2.

If 'pattern_width'"pattern_width""pattern_width""pattern_width""pattern_width""pattern_width" is changed, the model is not decodable anymore and all possibly available results are cleared. Therefore, gen_structured_light_patterngen_structured_light_patternGenStructuredLightPatternGenStructuredLightPatternGenStructuredLightPatterngen_structured_light_pattern has to be called before decoding the model using decode_structured_light_patterndecode_structured_light_patternDecodeStructuredLightPatternDecodeStructuredLightPatternDecodeStructuredLightPatterndecode_structured_light_pattern.

Values: integer values larger or equal to 1

Default: 1024

'pattern_height'"pattern_height""pattern_height""pattern_height""pattern_height""pattern_height":

Sets the height of the pattern images that are generated while calling gen_structured_light_patterngen_structured_light_patternGenStructuredLightPatternGenStructuredLightPatternGenStructuredLightPatterngen_structured_light_pattern. Usually, the value should be set to the height of the monitor that is used to display the pattern images.

The value of 'pattern_height'"pattern_height""pattern_height""pattern_height""pattern_height""pattern_height" has to be larger than the value 'min_stripe_width'"min_stripe_width""min_stripe_width""min_stripe_width""min_stripe_width""min_stripe_width"/2. In case that 'pattern_type'"pattern_type""pattern_type""pattern_type""pattern_type""pattern_type" is 'single_stripe'"single_stripe""single_stripe""single_stripe""single_stripe""single_stripe", it also has to be larger than 'single_stripe_width'"single_stripe_width""single_stripe_width""single_stripe_width""single_stripe_width""single_stripe_width"/2.

If 'pattern_height'"pattern_height""pattern_height""pattern_height""pattern_height""pattern_height" is changed, the model is not decodable anymore and all possibly available results are cleared. Therefore, gen_structured_light_patterngen_structured_light_patternGenStructuredLightPatternGenStructuredLightPatternGenStructuredLightPatterngen_structured_light_pattern has to be called before decoding the model using decode_structured_light_patterndecode_structured_light_patternDecodeStructuredLightPatternDecodeStructuredLightPatternDecodeStructuredLightPatterndecode_structured_light_pattern.

Values: integer values larger or equal to 1

Default: 1024

'min_stripe_width'"min_stripe_width""min_stripe_width""min_stripe_width""min_stripe_width""min_stripe_width":

Sets the width (in pixels) of the finest stripe of the pattern images that are generated while calling gen_structured_light_patterngen_structured_light_patternGenStructuredLightPatternGenStructuredLightPatternGenStructuredLightPatterngen_structured_light_pattern.

The value has to be a power of two. Furthermore, it has to be smaller or equal the minimum of the parameters 'pattern_width'"pattern_width""pattern_width""pattern_width""pattern_width""pattern_width" and 'pattern_height'"pattern_height""pattern_height""pattern_height""pattern_height""pattern_height" after rounding both up to their next power of two. In case that 'pattern_type'"pattern_type""pattern_type""pattern_type""pattern_type""pattern_type" is 'single_stripe'"single_stripe""single_stripe""single_stripe""single_stripe""single_stripe", it also has to be smaller or equal the 'single_stripe_width'"single_stripe_width""single_stripe_width""single_stripe_width""single_stripe_width""single_stripe_width".

If 'min_stripe_width'"min_stripe_width""min_stripe_width""min_stripe_width""min_stripe_width""min_stripe_width" is changed, the model is not decodable anymore and all possibly available results are cleared. Therefore, gen_structured_light_patterngen_structured_light_patternGenStructuredLightPatternGenStructuredLightPatternGenStructuredLightPatterngen_structured_light_pattern has to be called before decoding the model using decode_structured_light_patterndecode_structured_light_patternDecodeStructuredLightPatternDecodeStructuredLightPatternDecodeStructuredLightPatterndecode_structured_light_pattern.

Values: integer values larger or equal to 4 and a power of 2

Default: 32

'normalization'"normalization""normalization""normalization""normalization""normalization":

Sets the normalization mode of the structured light model. If the parameter is set to 'global'"global""global""global""global""global", gen_structured_light_patterngen_structured_light_patternGenStructuredLightPatternGenStructuredLightPatternGenStructuredLightPatterngen_structured_light_pattern generates two additional pattern images composed of a black and a white image. These images are then used in the decoding process to determine the actual pattern region. If instead, the value 'inverted_pattern'"inverted_pattern""inverted_pattern""inverted_pattern""inverted_pattern""inverted_pattern" is chosen, each Gray code image is additionally inverted and the pattern region is segmented iteratively using the Gray code images and their inverted version.

If 'normalization'"normalization""normalization""normalization""normalization""normalization" is changed, the model is not decodable anymore and all possibly available results are cleared. Therefore, gen_structured_light_patterngen_structured_light_patternGenStructuredLightPatternGenStructuredLightPatternGenStructuredLightPatterngen_structured_light_pattern has to be called before decoding the model using decode_structured_light_patterndecode_structured_light_patternDecodeStructuredLightPatternDecodeStructuredLightPatternDecodeStructuredLightPatterndecode_structured_light_pattern.

Values: 'global'"global""global""global""global""global", 'inverted_pattern'"inverted_pattern""inverted_pattern""inverted_pattern""inverted_pattern""inverted_pattern"

Default: 'global'"global""global""global""global""global"

'pattern_orientation'"pattern_orientation""pattern_orientation""pattern_orientation""pattern_orientation""pattern_orientation":

Sets the orientation of the pattern images that are generated while calling gen_structured_light_patterngen_structured_light_patternGenStructuredLightPatternGenStructuredLightPatternGenStructuredLightPatterngen_structured_light_pattern. If the parameter is set to 'both'"both""both""both""both""both", pattern images with vertical stripes as well as pattern images with horizontal stripes are created. For 'vertical'"vertical""vertical""vertical""vertical""vertical" the pattern images consist of vertical stripes only, whereas for 'horizontal'"horizontal""horizontal""horizontal""horizontal""horizontal" only horizontal stripes are generated.

If 'pattern_orientation'"pattern_orientation""pattern_orientation""pattern_orientation""pattern_orientation""pattern_orientation" is changed, the model is not decodable anymore and all possibly available results are cleared. Therefore, gen_structured_light_patterngen_structured_light_patternGenStructuredLightPatternGenStructuredLightPatternGenStructuredLightPatterngen_structured_light_pattern has to be called before decoding the model using decode_structured_light_patterndecode_structured_light_patternDecodeStructuredLightPatternDecodeStructuredLightPatternDecodeStructuredLightPatterndecode_structured_light_pattern.

Values: 'both'"both""both""both""both""both", 'vertical'"vertical""vertical""vertical""vertical""vertical", 'horizontal'"horizontal""horizontal""horizontal""horizontal""horizontal"

Default: 'both'"both""both""both""both""both"

'pattern_type'"pattern_type""pattern_type""pattern_type""pattern_type""pattern_type":

Sets the type of the pattern images that are generated while calling gen_structured_light_patterngen_structured_light_patternGenStructuredLightPatternGenStructuredLightPatternGenStructuredLightPatterngen_structured_light_pattern.

'pattern_type'	Generated Images
'gray_code'"gray_code""gray_code""gray_code""gray_code""gray_code"	Gray code images
'gray_code_and_phase_shift'"gray_code_and_phase_shift""gray_code_and_phase_shift""gray_code_and_phase_shift""gray_code_and_phase_shift""gray_code_and_phase_shift"	Gray code images and phase shift images
'single_stripe'"single_stripe""single_stripe""single_stripe""single_stripe""single_stripe"	Single stripe images, Gray code images and phase shift images

Usually, 'gray_code_and_phase_shift'"gray_code_and_phase_shift""gray_code_and_phase_shift""gray_code_and_phase_shift""gray_code_and_phase_shift""gray_code_and_phase_shift" leads to more accurate results than 'gray_code'"gray_code""gray_code""gray_code""gray_code""gray_code" because the combination between Gray code and phase images yields sub-pixel precise monitor coordinates. 'single_stripe'"single_stripe""single_stripe""single_stripe""single_stripe""single_stripe" can increase robustness in case of only partially specular surfaces.

If 'pattern_type'"pattern_type""pattern_type""pattern_type""pattern_type""pattern_type" is changed, the model is not decodable anymore and all possibly available results are cleared. Therefore, gen_structured_light_patterngen_structured_light_patternGenStructuredLightPatternGenStructuredLightPatternGenStructuredLightPatterngen_structured_light_pattern has to be called before decoding the model using decode_structured_light_patterndecode_structured_light_patternDecodeStructuredLightPatternDecodeStructuredLightPatternDecodeStructuredLightPatterndecode_structured_light_pattern.

Values: 'gray_code_and_phase_shift'"gray_code_and_phase_shift""gray_code_and_phase_shift""gray_code_and_phase_shift""gray_code_and_phase_shift""gray_code_and_phase_shift", 'gray_code'"gray_code""gray_code""gray_code""gray_code""gray_code", 'single_stripe'"single_stripe""single_stripe""single_stripe""single_stripe""single_stripe"

Default: 'gray_code_and_phase_shift'"gray_code_and_phase_shift""gray_code_and_phase_shift""gray_code_and_phase_shift""gray_code_and_phase_shift""gray_code_and_phase_shift"

'single_stripe_width'"single_stripe_width""single_stripe_width""single_stripe_width""single_stripe_width""single_stripe_width":

Sets the width (in pixels) of the single stripe that is generated while calling gen_structured_light_patterngen_structured_light_patternGenStructuredLightPatternGenStructuredLightPatternGenStructuredLightPatterngen_structured_light_pattern using the 'pattern_type'"pattern_type""pattern_type""pattern_type""pattern_type""pattern_type" 'single_stripe'"single_stripe""single_stripe""single_stripe""single_stripe""single_stripe".

The value has to be a power of two and has to be greater or equal 'min_stripe_width'"min_stripe_width""min_stripe_width""min_stripe_width""min_stripe_width""min_stripe_width". Furthermore, it has to be smaller or equal the minimum of the parameters 'pattern_width'"pattern_width""pattern_width""pattern_width""pattern_width""pattern_width" and 'pattern_height'"pattern_height""pattern_height""pattern_height""pattern_height""pattern_height" after rounding both up to their next power of two.

Note that 'single_stripe_width'"single_stripe_width""single_stripe_width""single_stripe_width""single_stripe_width""single_stripe_width" can only be set in case that 'pattern_type'"pattern_type""pattern_type""pattern_type""pattern_type""pattern_type" is 'single_stripe'"single_stripe""single_stripe""single_stripe""single_stripe""single_stripe". When 'pattern_type'"pattern_type""pattern_type""pattern_type""pattern_type""pattern_type" is changed to 'single_stripe'"single_stripe""single_stripe""single_stripe""single_stripe""single_stripe", 'single_stripe_width'"single_stripe_width""single_stripe_width""single_stripe_width""single_stripe_width""single_stripe_width" is set to some power of two roughly halfway between the currently set 'min_stripe_width'"min_stripe_width""min_stripe_width""min_stripe_width""min_stripe_width""min_stripe_width" and the minimum of 'pattern_width'"pattern_width""pattern_width""pattern_width""pattern_width""pattern_width" and 'pattern_height'"pattern_height""pattern_height""pattern_height""pattern_height""pattern_height".

If 'single_stripe_width'"single_stripe_width""single_stripe_width""single_stripe_width""single_stripe_width""single_stripe_width" is changed, the model is not decodable anymore and all possibly available results are cleared. Therefore, gen_structured_light_patterngen_structured_light_patternGenStructuredLightPatternGenStructuredLightPatternGenStructuredLightPatterngen_structured_light_pattern has to be called before decoding the model using decode_structured_light_patterndecode_structured_light_patternDecodeStructuredLightPatternDecodeStructuredLightPatternDecodeStructuredLightPatterndecode_structured_light_pattern.

Values: integer values larger or equal to 4 and a power of 2

Default: power of two roughly halfway between the currently set 'min_stripe_width'"min_stripe_width""min_stripe_width""min_stripe_width""min_stripe_width""min_stripe_width" and 'pattern_width'"pattern_width""pattern_width""pattern_width""pattern_width""pattern_width", 'pattern_height'"pattern_height""pattern_height""pattern_height""pattern_height""pattern_height"

Parameters which influence the segmentation of the pattern region:

'min_gray_difference'"min_gray_difference""min_gray_difference""min_gray_difference""min_gray_difference""min_gray_difference":

Sets the minimum gray value difference for the Gray code images. This value is used within decode_structured_light_patterndecode_structured_light_patternDecodeStructuredLightPatternDecodeStructuredLightPatternDecodeStructuredLightPatterndecode_structured_light_pattern to determine the binarized images. Thereby, for each pixel of the camera images the gray value difference between the lighted and the unlighted case is calculated. If the gray value difference of a pixel is smaller than 'min_gray_difference'"min_gray_difference""min_gray_difference""min_gray_difference""min_gray_difference""min_gray_difference", it is excluded from the domain of the binarized images (see get_structured_light_objectget_structured_light_objectGetStructuredLightObjectGetStructuredLightObjectGetStructuredLightObjectget_structured_light_object) and thus also from further calculations.

If 'min_gray_difference'"min_gray_difference""min_gray_difference""min_gray_difference""min_gray_difference""min_gray_difference" is set to the value 0, the segmented region is identical to the input region of the camera images with the only exception that pixels with a decoding result outside the pattern images are excluded.

Values: integer values larger or equal to 0

Default: 30

Parameters which influence the defect image:

'derivative_sigma'"derivative_sigma""derivative_sigma""derivative_sigma""derivative_sigma""derivative_sigma":

Sets the sigma of the Gaussian (i.e. the amount of smoothing) that is used for the convolution of the correspondence image(s) to calculate the defect image.

Values: float or integer value larger or equal 0.01

Default: 2

Execution Information

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

This operator modifies the state of the following input parameter:

• StructuredLightModelStructuredLightModelStructuredLightModelStructuredLightModelstructuredLightModelstructured_light_model

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

Example (HDevelop)

* Create the model
create_structured_light_model ('deflectometry', StructuredLightModel)
* Set the size of the monitor
set_structured_light_model_param (StructuredLightModel, \
                                  'pattern_width', 1600)
set_structured_light_model_param (StructuredLightModel, \
                                  'pattern_height', 1200)
* Set the smallest width of the stripes in the pattern
set_structured_light_model_param (StructuredLightModel, \
                                  'min_stripe_width', 8)
* Generate the patterns to project
gen_structured_light_pattern (PatternImages, StructuredLightModel)
* Set the expected black/white contrast in the region of interest
set_structured_light_model_param (StructuredLightModel, \
                                  'min_gray_difference', 70)
* Decode the camera images
decode_structured_light_pattern (CameraImages, StructuredLightModel)
* Get the computed correspondences and defects
get_structured_light_object (CorrespondenceImages, StructuredLightModel, \
                             'correspondence_image')
set_structured_light_model_param (StructuredLightModel, 'derivative_sigma', \
                                  Sigma)
get_structured_light_object (DefectImage, StructuredLightModel, \
                             'defect_image')

Result

The operator set_structured_light_model_paramset_structured_light_model_paramSetStructuredLightModelParamSetStructuredLightModelParamSetStructuredLightModelParamset_structured_light_model_param returns the value 2 ( H_MSG_TRUE) if the given parameters are valid and within acceptable range. Otherwise, an exception will be raised.

Possible Predecessors

create_structured_light_modelcreate_structured_light_modelCreateStructuredLightModelCreateStructuredLightModelCreateStructuredLightModelcreate_structured_light_model

See also

get_structured_light_model_paramget_structured_light_model_paramGetStructuredLightModelParamGetStructuredLightModelParamGetStructuredLightModelParamget_structured_light_model_param

Module

3D Metrology