Short description
set_distance_transform_xld_paramset_distance_transform_xld_paramSetDistanceTransformXldParamSetDistanceTransformXldParamset_distance_transform_xld_paramT_set_distance_transform_xld_param — Set new parameters for an XLD distance transform.
Signature
set_distance_transform_xld_param( xld_dist_trans DistanceTransformID, attribute.name GenParamName, attribute.value GenParamValue )set_distance_transform_xld_param( : : DistanceTransformID, GenParamName, GenParamValue : )void SetDistanceTransformXldParam( const HTuple& DistanceTransformID, const HTuple& GenParamName, const HTuple& GenParamValue )static void HOperatorSet.SetDistanceTransformXldParam( HTuple distanceTransformID, HTuple genParamName, HTuple genParamValue )def set_distance_transform_xld_param( distance_transform_id: HHandle, gen_param_name: MaybeSequence[str], gen_param_value: MaybeSequence[Union[float, str]] ) -> None
Herror T_set_distance_transform_xld_param( const Htuple DistanceTransformID, const Htuple GenParamName, const Htuple GenParamValue )
void HXLDDistTrans::SetDistanceTransformXldParam( const HTuple& GenParamName, const HTuple& GenParamValue ) const
void HXLDDistTrans::SetDistanceTransformXldParam( const HString& GenParamName, const HString& GenParamValue ) const
void HXLDDistTrans::SetDistanceTransformXldParam( const char* GenParamName, const char* GenParamValue ) const
void HXLDDistTrans::SetDistanceTransformXldParam( const wchar_t* GenParamName, const wchar_t* GenParamValue ) const (Windows only)
void HXLDDistTrans.SetDistanceTransformXldParam( HTuple genParamName, HTuple genParamValue )
void HXLDDistTrans.SetDistanceTransformXldParam( string genParamName, string genParamValue )
Description
set_distance_transform_xld_paramSetDistanceTransformXldParam sets new parameters for the
XLD distance transform DistanceTransformIDdistanceTransformIDdistance_transform_id.
The names and values of the parameters are passed in GenParamNamegenParamNamegen_param_name
and GenParamValuegenParamValuegen_param_value, respectively. GenParamNamegenParamNamegen_param_name can contain
the names of parameters 'mode'"mode" and 'max_distance'"max_distance".
The XLD distance transform of the original reference contour is then
rebuilt with updated values of parameters.
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:
During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.
Parameters
DistanceTransformIDdistanceTransformIDdistance_transform_id (input_control, state is modified) xld_dist_trans → (handle)(handle)HTuple (HHandle)HXLDDistTrans, HTuple (IntPtr)HHandleHtuple (handle)
Handle of the XLD distance transform.
GenParamNamegenParamNamegen_param_name (input_control) attribute.name(-array) → (string)(string)HTuple (HString)HTuple (string)MaybeSequence[str]Htuple (char*)
Names of the generic parameters.
Default: 'mode'"mode"
List of values: 'max_distance', 'mode'"max_distance", "mode"
GenParamValuegenParamValuegen_param_value (input_control) attribute.value(-array) → (string / real)(string / real)HTuple (HString / double)HTuple (string / double)MaybeSequence[Union[float, str]]Htuple (char* / double)
Values of the generic parameters.
Default: 'point_to_point'"point_to_point"
Suggested values: 'point_to_point', 'point_to_segment', 5.0"point_to_point", "point_to_segment", 5.0
Result
If all parameters are correct, the operator returns the
value 2 (H_MSG_TRUE). Otherwise, an exception is raised.
Combinations with other operators
Combinations
Possible predecessors
get_distance_transform_xld_paramGetDistanceTransformXldParam
Possible successors
apply_distance_transform_xldApplyDistanceTransformXld
See also
write_distance_transform_xldWriteDistanceTransformXld, serialize_distance_transform_xldSerializeDistanceTransformXld, get_distance_transform_xld_contourGetDistanceTransformXldContour, read_distance_transform_xldReadDistanceTransformXld, deserialize_distance_transform_xldDeserializeDistanceTransformXld, clear_distance_transform_xldClearDistanceTransformXld
Module
Foundation