Skip to content

get_distance_transform_xld_paramget_distance_transform_xld_paramGetDistanceTransformXldParamGetDistanceTransformXldParamget_distance_transform_xld_paramT_get_distance_transform_xld_param🔗

Short description🔗

get_distance_transform_xld_paramget_distance_transform_xld_paramGetDistanceTransformXldParamGetDistanceTransformXldParamget_distance_transform_xld_paramT_get_distance_transform_xld_param — Get the parameters used to build an XLD distance transform.

Signature🔗

get_distance_transform_xld_param( xld_dist_trans DistanceTransformID, attribute.name GenParamName, out attribute.value GenParamValue )get_distance_transform_xld_param( : : DistanceTransformID, GenParamName : GenParamValue )void GetDistanceTransformXldParam( const HTuple& DistanceTransformID, const HTuple& GenParamName, HTuple* GenParamValue )static void HOperatorSet.GetDistanceTransformXldParam( HTuple distanceTransformID, HTuple genParamName, out HTuple genParamValue )def get_distance_transform_xld_param( distance_transform_id: HHandle, gen_param_name: MaybeSequence[str] ) -> Sequence[Union[float, str]]

def get_distance_transform_xld_param_s( distance_transform_id: HHandle, gen_param_name: MaybeSequence[str] ) -> Union[float, str]Herror T_get_distance_transform_xld_param( const Htuple DistanceTransformID, const Htuple GenParamName, Htuple* GenParamValue )

HTuple HXLDDistTrans::GetDistanceTransformXldParam( const HTuple& GenParamName ) const

HTuple HXLDDistTrans::GetDistanceTransformXldParam( const HString& GenParamName ) const

HTuple HXLDDistTrans::GetDistanceTransformXldParam( const char* GenParamName ) const

HTuple HXLDDistTrans::GetDistanceTransformXldParam( const wchar_t* GenParamName ) const (Windows only)

HTuple HXLDDistTrans.GetDistanceTransformXldParam( HTuple genParamName )

HTuple HXLDDistTrans.GetDistanceTransformXldParam( string genParamName )

Description🔗

get_distance_transform_xld_paramGetDistanceTransformXldParam returns the parameters used to build the XLD distance transform DistanceTransformIDdistanceTransformIDdistance_transform_id. The names of the parameters are passed in GenParamNamegenParamNamegen_param_name and their values are returned in GenParamValuegenParamValuegen_param_value. GenParamNamegenParamNamegen_param_name can contain the names of parameters 'mode'"mode" and 'max_distance'"max_distance".

Execution information🔗

Execution information
  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

Parameters🔗

DistanceTransformIDdistanceTransformIDdistance_transform_id (input_control) 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 (output_control) attribute.value(-array) → (string / real)(string / real)HTuple (HString / double)HTuple (string / double)Sequence[Union[float, str]]Htuple (char* / double)

Values of the generic parameters.

Number of elements: GenParamValue == 1 || GenParamValue == 2
List of values: 5.0, 'point_to_point', 'point_to_segment'5.0, "point_to_point", "point_to_segment"

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

read_distance_transform_xldReadDistanceTransformXld, deserialize_distance_transform_xldDeserializeDistanceTransformXld

Possible successors

set_distance_transform_xld_paramSetDistanceTransformXldParam

See also

get_distance_transform_xld_contourGetDistanceTransformXldContour, create_distance_transform_xldCreateDistanceTransformXld, apply_distance_transform_xldApplyDistanceTransformXld, clear_distance_transform_xldClearDistanceTransformXld, write_distance_transform_xldWriteDistanceTransformXld, serialize_distance_transform_xldSerializeDistanceTransformXld

Module🔗

Foundation