descript_class_boxT_descript_class_boxDescriptClassBoxDescriptClassBoxdescript_class_box (Operator)
Name
descript_class_boxT_descript_class_boxDescriptClassBoxDescriptClassBoxdescript_class_box — Describe the classes of a box classifier.
Warning
descript_class_boxdescript_class_boxDescriptClassBoxDescriptClassBoxdescript_class_box is obsolete and is only provided for
reasons of backward compatibility. New applications should use the
MLP, SVM, KNN or GMM operators instead. The operator will be removed with
HALCON 25.11.
Signature
void DescriptClassBox(const HTuple& ClassifHandle, const HTuple& Dimensions, HTuple* ClassIdx, HTuple* BoxIdx, HTuple* BoxLowerBound, HTuple* BoxHigherBound, HTuple* BoxNumSamplesTrain, HTuple* BoxNumSamplesWrong)
HTuple HClassBox::DescriptClassBox(Hlong Dimensions, HTuple* BoxIdx, HTuple* BoxLowerBound, HTuple* BoxHigherBound, HTuple* BoxNumSamplesTrain, HTuple* BoxNumSamplesWrong) const
Hlong HClassBox::DescriptClassBox(Hlong Dimensions, Hlong* BoxIdx, Hlong* BoxLowerBound, Hlong* BoxHigherBound, Hlong* BoxNumSamplesTrain, Hlong* BoxNumSamplesWrong) const
static void HOperatorSet.DescriptClassBox(HTuple classifHandle, HTuple dimensions, out HTuple classIdx, out HTuple boxIdx, out HTuple boxLowerBound, out HTuple boxHigherBound, out HTuple boxNumSamplesTrain, out HTuple boxNumSamplesWrong)
HTuple HClassBox.DescriptClassBox(int dimensions, out HTuple boxIdx, out HTuple boxLowerBound, out HTuple boxHigherBound, out HTuple boxNumSamplesTrain, out HTuple boxNumSamplesWrong)
int HClassBox.DescriptClassBox(int dimensions, out int boxIdx, out int boxLowerBound, out int boxHigherBound, out int boxNumSamplesTrain, out int boxNumSamplesWrong)
def descript_class_box(classif_handle: HHandle, dimensions: int) -> Tuple[Sequence[int], Sequence[int], Sequence[int], Sequence[int], Sequence[int], Sequence[int]]
def descript_class_box_s(classif_handle: HHandle, dimensions: int) -> Tuple[int, int, int, int, int, int]
Description
descript_class_boxdescript_class_boxDescriptClassBoxDescriptClassBoxdescript_class_box describes the classes of a box classifier. A box
classifier uses a set of hyper cuboids (boxes) for every class. These boxes
describe the distribution of the samples.
descript_class_boxdescript_class_boxDescriptClassBoxDescriptClassBoxdescript_class_box returns for every class (ClassIdxClassIdxClassIdxclassIdxclass_idx) the
boundaries of every contained box (BoxIdxBoxIdxBoxIdxboxIdxbox_idx) from dimension 1 up to
DimensionsDimensionsDimensionsdimensionsdimensions (BoxLowerBoundBoxLowerBoundBoxLowerBoundboxLowerBoundbox_lower_bound, BoxHigherBoundBoxHigherBoundBoxHigherBoundboxHigherBoundbox_higher_bound) as
well as the number of samples that were used during the learning phase to
determine these boundaries at each dimension (BoxNumSamplesTrainBoxNumSamplesTrainBoxNumSamplesTrainboxNumSamplesTrainbox_num_samples_train).
Furthermore, the number of samples that were assigned to the wrong class
during the learning phase is returned in BoxNumSamplesWrongBoxNumSamplesWrongBoxNumSamplesWrongboxNumSamplesWrongbox_num_samples_wrong.
The boundary information of the boxes can be used to inspect the box
classifier.
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
ClassifHandleClassifHandleClassifHandleclassifHandleclassif_handle (input_control) class_box → HClassBox, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the classifier.
DimensionsDimensionsDimensionsdimensionsdimensions (input_control) integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Highest dimension for output.
Default:
3
ClassIdxClassIdxClassIdxclassIdxclass_idx (output_control) integer(-array) → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Indices of the classes.
BoxIdxBoxIdxBoxIdxboxIdxbox_idx (output_control) integer(-array) → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Indices of the boxes.
BoxLowerBoundBoxLowerBoundBoxLowerBoundboxLowerBoundbox_lower_bound (output_control) integer(-array) → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Lower bounds of the boxes (for each dimension).
BoxHigherBoundBoxHigherBoundBoxHigherBoundboxHigherBoundbox_higher_bound (output_control) integer(-array) → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Higher bounds of the boxes (for each dimension).
BoxNumSamplesTrainBoxNumSamplesTrainBoxNumSamplesTrainboxNumSamplesTrainbox_num_samples_train (output_control) integer(-array) → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Number of training samples that were used to define this
box (for each dimension).
BoxNumSamplesWrongBoxNumSamplesWrongBoxNumSamplesWrongboxNumSamplesWrongbox_num_samples_wrong (output_control) integer(-array) → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Number of training samples that were assigned
incorrectly to the box.
Result
descript_class_boxdescript_class_boxDescriptClassBoxDescriptClassBoxdescript_class_box returns 2 (
H_MSG_TRUE)
.
Possible Predecessors
create_class_boxcreate_class_boxCreateClassBoxCreateClassBoxcreate_class_box,
learn_class_boxlearn_class_boxLearnClassBoxLearnClassBoxlearn_class_box,
set_class_box_paramset_class_box_paramSetClassBoxParamSetClassBoxParamset_class_box_param
Possible Successors
enquire_class_boxenquire_class_boxEnquireClassBoxEnquireClassBoxenquire_class_box,
learn_class_boxlearn_class_boxLearnClassBoxLearnClassBoxlearn_class_box,
write_class_boxwrite_class_boxWriteClassBoxWriteClassBoxwrite_class_box,
close_class_boxclose_class_boxCloseClassBoxCloseClassBoxclose_class_box
See also
create_class_boxcreate_class_boxCreateClassBoxCreateClassBoxcreate_class_box,
enquire_class_boxenquire_class_boxEnquireClassBoxEnquireClassBoxenquire_class_box,
learn_class_boxlearn_class_boxLearnClassBoxLearnClassBoxlearn_class_box,
read_class_boxread_class_boxReadClassBoxReadClassBoxread_class_box,
write_class_boxwrite_class_boxWriteClassBoxWriteClassBoxwrite_class_box
Module
Foundation