ClassesClassesClassesClasses | | | | Operators

train_sample_identifierT_train_sample_identifierTrainSampleIdentifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifier (Operator)

Name

train_sample_identifierT_train_sample_identifierTrainSampleIdentifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifier — Train a sample identifier.

Signature

train_sample_identifier( : : SampleIdentifier, ParamName, ParamValue : )

Herror T_train_sample_identifier(const Htuple SampleIdentifier, const Htuple ParamName, const Htuple ParamValue)

Herror train_sample_identifier(const HTuple& SampleIdentifier, const HTuple& ParamName, const HTuple& ParamValue)

void HSampleIdentifier::TrainSampleIdentifier(const HTuple& ParamName, const HTuple& ParamValue) const

void TrainSampleIdentifier(const HTuple& SampleIdentifier, const HTuple& ParamName, const HTuple& ParamValue)

void HSampleIdentifier::TrainSampleIdentifier(const HTuple& ParamName, const HTuple& ParamValue) const

void HOperatorSetX.TrainSampleIdentifier(
[in] VARIANT SampleIdentifier, [in] VARIANT ParamName, [in] VARIANT ParamValue)

void HSampleIdentifierX.TrainSampleIdentifier(
[in] VARIANT ParamName, [in] VARIANT ParamValue)

static void HOperatorSet.TrainSampleIdentifier(HTuple sampleIdentifier, HTuple paramName, HTuple paramValue)

void HSampleIdentifier.TrainSampleIdentifier(HTuple paramName, HTuple paramValue)

Description

train_sample_identifiertrain_sample_identifierTrainSampleIdentifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifier trains the given SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier using the training data, which has been set with add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingData.

See create_sample_identifiercreate_sample_identifierCreateSampleIdentifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifier for an explanation of the concept of sample-based identification.

In order to be able to identify objects, the SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier must be trained with a representative set of sample images of the objects to be identified (see add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingData).

To train the SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier, first, all the relevant sample images of the objects to be identified must be added with add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingData. Alternatively, the preparation data can be reused. See prepare_sample_identifierprepare_sample_identifierPrepareSampleIdentifierprepare_sample_identifierPrepareSampleIdentifierPrepareSampleIdentifier for an explanation on how to reuse preparation data for the training of the sample identifier. Then, with the call of train_sample_identifiertrain_sample_identifierTrainSampleIdentifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifier, the SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier is trained.

Note that the training itself is very fast and does not consume a lot of memory. Therefore, it is very easy to retrain the SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier, e.g., after new objects were added or already trained objects were removed from the SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier.

To retrain an existing sample identifier with new objects, just add the relevant sample images with add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingData and call train_sample_identifiertrain_sample_identifierTrainSampleIdentifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifier, again. To remove objects, use the operator remove_sample_identifier_training_dataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingData and retrain the sample identifier with train_sample_identifiertrain_sample_identifierTrainSampleIdentifiertrain_sample_identifierTrainSampleIdentifierTrainSampleIdentifier.

Note that the training of the sample identifier is only possible, if the sample identifier contains training data for at least two different training objects.

The generic parameters ParamNameParamNameParamNameParamNameParamNameparamName and ParamValueParamValueParamValueParamValueParamValueparamValue are intended for future use, only.

Parallelization

Parameters

SampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifierSampleIdentifiersampleIdentifier (input_control)  sample_identifier HSampleIdentifier, HTupleHTupleHSampleIdentifier, HTupleHSampleIdentifierX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the sample identifier.

ParamNameParamNameParamNameParamNameParamNameparamName (input_control)  attribute.name-array HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Parameter name.

Default value: []

List of values: []

ParamValueParamValueParamValueParamValueParamValueparamValue (input_control)  attribute.value-array HTupleHTupleHTupleVARIANTHtuple (real / string / integer) (double / string / int / long) (double / HString / Hlong) (double / char* / Hlong) (double / BSTR / Hlong) (double / char* / Hlong)

Parameter value.

Default value: []

List of values: []

Result

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

Possible Predecessors

add_sample_identifier_training_dataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataadd_sample_identifier_training_dataAddSampleIdentifierTrainingDataAddSampleIdentifierTrainingData

Possible Successors

apply_sample_identifierapply_sample_identifierApplySampleIdentifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifier, write_sample_identifierwrite_sample_identifierWriteSampleIdentifierwrite_sample_identifierWriteSampleIdentifierWriteSampleIdentifier

Alternatives

read_sample_identifierread_sample_identifierReadSampleIdentifierread_sample_identifierReadSampleIdentifierReadSampleIdentifier

See also

create_sample_identifiercreate_sample_identifierCreateSampleIdentifiercreate_sample_identifierCreateSampleIdentifierCreateSampleIdentifier, add_sample_identifier_preparation_dataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataadd_sample_identifier_preparation_dataAddSampleIdentifierPreparationDataAddSampleIdentifierPreparationData, prepare_sample_identifierprepare_sample_identifierPrepareSampleIdentifierprepare_sample_identifierPrepareSampleIdentifierPrepareSampleIdentifier, apply_sample_identifierapply_sample_identifierApplySampleIdentifierapply_sample_identifierApplySampleIdentifierApplySampleIdentifier, set_sample_identifier_paramset_sample_identifier_paramSetSampleIdentifierParamset_sample_identifier_paramSetSampleIdentifierParamSetSampleIdentifierParam, get_sample_identifier_paramget_sample_identifier_paramGetSampleIdentifierParamget_sample_identifier_paramGetSampleIdentifierParamGetSampleIdentifierParam, get_sample_identifier_object_infoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoget_sample_identifier_object_infoGetSampleIdentifierObjectInfoGetSampleIdentifierObjectInfo, remove_sample_identifier_preparation_dataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataremove_sample_identifier_preparation_dataRemoveSampleIdentifierPreparationDataRemoveSampleIdentifierPreparationData, remove_sample_identifier_training_dataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataremove_sample_identifier_training_dataRemoveSampleIdentifierTrainingDataRemoveSampleIdentifierTrainingData, serialize_sample_identifierserialize_sample_identifierSerializeSampleIdentifierserialize_sample_identifierSerializeSampleIdentifierSerializeSampleIdentifier, deserialize_sample_identifierdeserialize_sample_identifierDeserializeSampleIdentifierdeserialize_sample_identifierDeserializeSampleIdentifierDeserializeSampleIdentifier, clear_sample_identifierclear_sample_identifierClearSampleIdentifierclear_sample_identifierClearSampleIdentifierClearSampleIdentifier, clear_all_sample_identifiersclear_all_sample_identifiersClearAllSampleIdentifiersclear_all_sample_identifiersClearAllSampleIdentifiersClearAllSampleIdentifiers, set_sample_identifier_object_infoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoset_sample_identifier_object_infoSetSampleIdentifierObjectInfoSetSampleIdentifierObjectInfo

Module

Matching


ClassesClassesClassesClasses | | | | Operators