Operator Reference

HALCON Operator Reference / Legacy / Identification

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

get_sample_identifier_paramT_get_sample_identifier_paramGetSampleIdentifierParamGetSampleIdentifierParamget_sample_identifier_param (Operator)

get_sample_identifier_paramT_get_sample_identifier_paramGetSampleIdentifierParamGetSampleIdentifierParamget_sample_identifier_param — Get selected parameters of a sample identifier.

Warning

get_sample_identifier_paramget_sample_identifier_paramGetSampleIdentifierParamGetSampleIdentifierParamget_sample_identifier_param is obsolete and is only provided for reasons of backward compatibility. New applications should use the operators for Deep-Learning-based classification instead, for details see Deep Learning / Classification.

Signature

get_sample_identifier_param( : : SampleIdentifier, GenParamName : GenParamValue)

Herror T_get_sample_identifier_param(const Htuple SampleIdentifier, const Htuple GenParamName, Htuple* GenParamValue)

void GetSampleIdentifierParam(const HTuple& SampleIdentifier, const HTuple& GenParamName, HTuple* GenParamValue)

HTuple HSampleIdentifier::GetSampleIdentifierParam(const HString& GenParamName) const

HTuple HSampleIdentifier::GetSampleIdentifierParam(const char* GenParamName) const

HTuple HSampleIdentifier::GetSampleIdentifierParam(const wchar_t* GenParamName) const   ( Windows only)

static void HOperatorSet.GetSampleIdentifierParam(HTuple sampleIdentifier, HTuple genParamName, out HTuple genParamValue)

HTuple HSampleIdentifier.GetSampleIdentifierParam(string genParamName)

def get_sample_identifier_param(sample_identifier: HHandle, gen_param_name: str) -> Union[str, float, int]

Description

The operator get_sample_identifier_paramget_sample_identifier_paramGetSampleIdentifierParamGetSampleIdentifierParamget_sample_identifier_param allows to query the values of the different parameters of the given SampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifiersample_identifier.

For an explanation of the concept of sample-based identification see the introduction of chapter Legacy / Identification.

The values of the following parameters can be queried:

'add_color_info'"add_color_info""add_color_info""add_color_info""add_color_info":

Do the operators add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataadd_sample_identifier_preparation_data and add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingDataadd_sample_identifier_training_data add color information to the SampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifiersample_identifier?

'add_texture_info'"add_texture_info""add_texture_info""add_texture_info""add_texture_info":

Do the operators add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataadd_sample_identifier_preparation_data and add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingDataadd_sample_identifier_training_data add texture information to the SampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifiersample_identifier?

'use_color_info'"use_color_info""use_color_info""use_color_info""use_color_info":

Is the SampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifiersample_identifier configured to use color information for the identification with apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierapply_sample_identifier?

'use_texture_info'"use_texture_info""use_texture_info""use_texture_info""use_texture_info":

Is the SampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifiersample_identifier configured to use texture information for the identification apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierapply_sample_identifier?

'image_resize_method'"image_resize_method""image_resize_method""image_resize_method""image_resize_method":

The selected image resize method.

'image_resize_value'"image_resize_value""image_resize_value""image_resize_value""image_resize_value":

The current image resize value.

'rating_method'"rating_method""rating_method""rating_method""rating_method":

The selected rating method which is used by apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierapply_sample_identifier.

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

SampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifiersample_identifier (input_control)  sample_identifier → HSampleIdentifier, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the sample identifier.

GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  attribute.name → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Parameter name.

Default: 'rating_method' "rating_method" "rating_method" "rating_method" "rating_method"

List of values: 'add_color_info'"add_color_info""add_color_info""add_color_info""add_color_info", 'add_texture_info'"add_texture_info""add_texture_info""add_texture_info""add_texture_info", 'image_resize_method'"image_resize_method""image_resize_method""image_resize_method""image_resize_method", 'image_resize_value'"image_resize_value""image_resize_value""image_resize_value""image_resize_value", 'rating_method'"rating_method""rating_method""rating_method""rating_method", 'use_color_info'"use_color_info""use_color_info""use_color_info""use_color_info", 'use_texture_info'"use_texture_info""use_texture_info""use_texture_info""use_texture_info"

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (output_control)  attribute.value → HTupleUnion[str, float, int]HTupleHtuple (real / string / integer) (double / string / int / long) (double / HString / Hlong) (double / char* / Hlong)

Parameter value.

Result

If the parameters are valid, the operator get_sample_identifier_paramget_sample_identifier_paramGetSampleIdentifierParamGetSampleIdentifierParamget_sample_identifier_param returns the value 2 ( H_MSG_TRUE) . If necessary an exception is raised.

Possible Predecessors

create_sample_identifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifiercreate_sample_identifier, set_sample_identifier_paramset_sample_identifier_paramSetSampleIdentifierParamSetSampleIdentifierParamset_sample_identifier_param

See also

add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationDataadd_sample_identifier_preparation_data, prepare_sample_identifierprepare_sample_identifierPrepareSampleIdentifierPrepareSampleIdentifierprepare_sample_identifier, add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingDataadd_sample_identifier_training_data, train_sample_identifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifiertrain_sample_identifier, apply_sample_identifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifierapply_sample_identifier, get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfoget_sample_identifier_object_info, remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationDataremove_sample_identifier_preparation_data, remove_sample_identifier_training_dataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingDataremove_sample_identifier_training_data, write_sample_identifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifierwrite_sample_identifier, read_sample_identifierread_sample_identifierReadSampleIdentifierReadSampleIdentifierread_sample_identifier, serialize_sample_identifierserialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifierserialize_sample_identifier, deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifierdeserialize_sample_identifier, clear_sample_identifierclear_sample_identifierClearSampleIdentifierClearSampleIdentifierclear_sample_identifier, set_sample_identifier_object_infoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfoset_sample_identifier_object_info

Module

Matching

---

ClassesClasses | | Operators