get_sample_class_train_dataget_sample_class_train_dataGetSampleClassTrainDataGetSampleClassTrainDataget_sample_class_train_dataT_get_sample_class_train_data
Short description
get_sample_class_train_dataget_sample_class_train_dataGetSampleClassTrainDataGetSampleClassTrainDataget_sample_class_train_dataT_get_sample_class_train_data — Return a training sample from training data.
Signature
get_sample_class_train_data( class_train_data ClassTrainDataHandle, integer IndexSample, out real Features, out integer ClassID )get_sample_class_train_data( : : ClassTrainDataHandle, IndexSample : Features, ClassID )void GetSampleClassTrainData( const HTuple& ClassTrainDataHandle, const HTuple& IndexSample, HTuple* Features, HTuple* ClassID )static void HOperatorSet.GetSampleClassTrainData( HTuple classTrainDataHandle, HTuple indexSample, out HTuple features, out HTuple classID )def get_sample_class_train_data( class_train_data_handle: HHandle, index_sample: int ) -> Tuple[Sequence[float], int]
Herror T_get_sample_class_train_data( const Htuple ClassTrainDataHandle, const Htuple IndexSample, Htuple* Features, Htuple* ClassID )
HTuple HClassTrainData::GetSampleClassTrainData( Hlong IndexSample, Hlong* ClassID ) const
HTuple HClassTrainData.GetSampleClassTrainData( int indexSample, out int classID )
Description
get_sample_class_train_dataGetSampleClassTrainData reads a training sample from the
training data given by ClassTrainDataHandleclassTrainDataHandleclass_train_data_handle that was
added, e.g., with add_sample_class_train_dataAddSampleClassTrainData.
The index of the sample is
specified with IndexSampleindexSampleindex_sample. The index is counted from 0.
That means that IndexSampleindexSampleindex_sample must be a number between 0 and
NumSamplesnumSamplesnum_samples \(-\) 1, where NumSamplesnumSamplesnum_samples can be
determined with get_sample_num_class_train_dataGetSampleNumClassTrainData. The training
sample is returned in Featuresfeaturesfeatures and ClassIDclassIDclass_id.
Featuresfeaturesfeatures is a feature vector of length NumDimnumDimnum_dim
(see create_class_train_dataCreateClassTrainData) and ClassIDclassIDclass_id is
the class of the feature vector.
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
ClassTrainDataHandleclassTrainDataHandleclass_train_data_handle (input_control) class_train_data → (handle)(handle)HTuple (HHandle)HClassTrainData, HTuple (IntPtr)HHandleHtuple (handle)
Handle of training data for a classifier.
IndexSampleindexSampleindex_sample (input_control) integer → (integer)(integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)
Number of stored training sample.
Featuresfeaturesfeatures (output_control) real-array → (real)(real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)
Feature vector of the training sample.
ClassIDclassIDclass_id (output_control) integer → (integer)(integer)HTuple (Hlong)HTuple (int / long)intHtuple (Hlong)
Class of the training sample.
Result
If the parameters are valid, the operator
get_sample_class_mlpGetSampleClassMlp returns the value 2 (H_MSG_TRUE). If necessary,
an exception is raised.
Combinations with other operators
Combinations
Possible predecessors
add_sample_class_train_dataAddSampleClassTrainData
See also
create_class_train_dataCreateClassTrainData
Module
Foundation