Operator Reference
serialize_sample_identifier (Operator)
serialize_sample_identifier
— Serialize a sample identifier.
Warning
serialize_sample_identifier
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
serialize_sample_identifier( : : SampleIdentifier : SerializedItemHandle)
Description
serialize_sample_identifier
serializes the data of a sample
identifier (see fwrite_serialized_item
for an introduction of the
basic principle of serialization). The same data that is written in a file
by write_sample_identifier
is converted to a serialized item. The
sample identifier is defined by the handle SampleIdentifier
. The
serialized sample identifier is returned by the handle
SerializedItemHandle
and can be deserialized by
deserialize_sample_identifier
.
For an explanation of the concept of sample-based identification see the introduction of chapter Legacy / Identification.
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
SampleIdentifier
(input_control) sample_identifier →
(handle)
Handle of the sample identifier.
SerializedItemHandle
(output_control) serialized_item →
(handle)
Handle of the serialized item.
Result
If the parameters are valid, the operator
serialize_sample_identifier
returns the value 2 (
H_MSG_TRUE)
. If necessary,
an exception is raised.
Possible Predecessors
prepare_sample_identifier
,
train_sample_identifier
,
add_sample_identifier_preparation_data
,
add_sample_identifier_training_data
,
set_sample_identifier_param
Possible Successors
Alternatives
Module
Matching