Skip to content

add_samples_image_class_knnAddSamplesImageClassKnnAddSamplesImageClassKnnadd_samples_image_class_knnT_add_samples_image_class_knn🔗

Short description🔗

add_samples_image_class_knnAddSamplesImageClassKnnAddSamplesImageClassKnnadd_samples_image_class_knnT_add_samples_image_class_knn — Add training samples from an image to the training data of a k-Nearest-Neighbor classifier.

Signature🔗

add_samples_image_class_knn( image Image, region ClassRegions, class_knn KNNHandle )void AddSamplesImageClassKnn( const HObject& Image, const HObject& ClassRegions, const HTuple& KNNHandle )static void HOperatorSet.AddSamplesImageClassKnn( HObject image, HObject classRegions, HTuple KNNHandle )def add_samples_image_class_knn( image: HObject, class_regions: HObject, knnhandle: HHandle ) -> None

Herror T_add_samples_image_class_knn( const Hobject Image, const Hobject ClassRegions, const Htuple KNNHandle )

void HImage::AddSamplesImageClassKnn( const HRegion& ClassRegions, const HClassKnn& KNNHandle ) const

void HClassKnn::AddSamplesImageClassKnn( const HImage& Image, const HRegion& ClassRegions ) const

void HImage.AddSamplesImageClassKnn( HRegion classRegions, HClassKnn KNNHandle )

void HClassKnn.AddSamplesImageClassKnn( HImage image, HRegion classRegions )

Description🔗

add_samples_image_class_knnAddSamplesImageClassKnn adds training samples from the Imageimageimage to the k-Nearest-Neighbor (k-NN) given by KNNHandleKNNHandleknnhandle. add_samples_image_class_knnAddSamplesImageClassKnn is used to store the training samples before a classifier is used for the pixel classification of multichannel images with classify_image_class_knnClassifyImageClassKnn. add_samples_image_class_knnAddSamplesImageClassKnn works analogously to add_sample_class_knnAddSampleClassKnn. The Imageimageimage must have a number of channels equal to NumDimnumDimnum_dim, as specified with create_class_knnCreateClassKnn. ClassRegionsclassRegionsclass_regions must be a tuple containing of at least 2 regions. The order of the regions in ClassRegionsclassRegionsclass_regions determines the class of the pixels. If there are no samples for a particular class in Imageimageimage an empty region must be passed at the position of the class in ClassRegionsclassRegionsclass_regions. With this mechanism it is possible to use multiple images to add training samples for all relevant classes to the k-NN classifier by calling add_samples_image_class_knnAddSamplesImageClassKnn multiple times with different images and suitably chosen regions. The regions in ClassRegionsclassRegionsclass_regions should contain representative training samples for the respective classes. Hence, they do not need to cover the entire image. The regions in ClassRegionsclassRegionsclass_regions should not overlap each other, as these samples from overlapping areas would be assigned to multiple classes in the training data, which may lead to a lower classification performance.

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.

This operator modifies the state of the following input parameter:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters🔗

Imageimageimage (input_object) (multichannel-)image → object (byte / cyclic / direction / int1 / int2 / uint2 / int4 / real)HObject (byte / cyclic / direction / int1 / int2 / uint2 / int4 / real)HImage (byte / cyclic / direction / int1 / int2 / uint2 / int4 / real)HObject (byte / cyclic / direction / int1 / int2 / uint2 / int4 / real)Hobject (byte / cyclic / direction / int1 / int2 / uint2 / int4 / real)

Training image.

ClassRegionsclassRegionsclass_regions (input_object) region-array → objectHObjectHRegionHObjectHobject

Regions of the classes to be trained.

KNNHandleKNNHandleknnhandle (input_control, state is modified) class_knn → (handle)HTuple (HHandle)HClassKnn, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the k-NN classifier.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

create_class_knnCreateClassKnn

Possible successors

train_class_knnTrainClassKnn

Alternatives

add_sample_class_knnAddSampleClassKnn

See also

classify_image_class_knnClassifyImageClassKnn, add_sample_class_knnAddSampleClassKnn, add_samples_image_class_svmAddSamplesImageClassSvm

Module🔗

Foundation