Operator Reference

HALCON Operator Reference / Tuple / Selection

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

tuple_select_masktuple_select_maskTupleSelectMaskTupleSelectMasktuple_select_mask (Operator)

tuple_select_masktuple_select_maskTupleSelectMaskTupleSelectMasktuple_select_mask — Select in mask specified elements of a tuple.

Signature

tuple_select_mask( : : Tuple, Mask : Selected)

Herror tuple_select_mask(const Hlong Tuple, const Hlong Mask, Hlong* Selected)

Herror T_tuple_select_mask(const Htuple Tuple, const Htuple Mask, Htuple* Selected)

void TupleSelectMask(const HTuple& Tuple, const HTuple& Mask, HTuple* Selected)

HTuple HTuple::TupleSelectMask(const HTuple& Mask) const

static void HOperatorSet.TupleSelectMask(HTuple tuple, HTuple mask, out HTuple selected)

HTuple HTuple.TupleSelectMask(HTuple mask)

def tuple_select_mask(tuple: MaybeSequence[Union[float, int, str]], mask: MaybeSequence[int]) -> Sequence[Union[float, int, str]]

def tuple_select_mask_s(tuple: MaybeSequence[Union[float, int, str]], mask: MaybeSequence[int]) -> Union[float, int, str]

Description

tuple_select_masktuple_select_maskTupleSelectMaskTupleSelectMasktuple_select_mask selects one or more single elements of the tuple TupleTupleTupletupletuple and returns them with SelectedSelectedSelectedselectedselected. For every element MaskMaskMaskmaskmask determines the corresponding element to select. If the value is greater than 0, the appropriate element is selected. Thus the length of the two input tuples has to be equal and MaskMaskMaskmaskmask may only contain integer or float values.

Exception: Empty input tuples

If both input tuples are empty, the operator returns an empty tuple. If only one of the input tuples is empty and the other is not, an exception is raised.

HDevelop In-line Operation

HDevelop provides an in-line operation for tuple_select_masktuple_select_maskTupleSelectMaskTupleSelectMasktuple_select_mask, which can be used in an expression in the following syntax:

Selected := select_mask(Tuple, Mask)

Execution Information

• Multithreading type: independent (runs in parallel even with exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

TupleTupleTupletupletuple (input_control)  tuple(-array) → HTupleMaybeSequence[Union[float, int, str]]HTupleHtuple (integer / real / string) (int / long / double / string) (Hlong / double / HString) (Hlong / double / char*)

Input tuple.

MaskMaskMaskmaskmask (input_control)  integer(-array) → HTupleMaybeSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

> 0 specifies the elements to select.

SelectedSelectedSelectedselectedselected (output_control)  tuple(-array) → HTupleSequence[Union[float, int, str]]HTupleHtuple (integer / real / string) (int / long / double / string) (Hlong / double / HString) (Hlong / double / char*)

Selected tuple elements.

Alternatives

tuple_first_ntuple_first_nTupleFirstNTupleFirstNtuple_first_n, tuple_last_ntuple_last_nTupleLastNTupleLastNtuple_last_n, tuple_str_bit_selecttuple_str_bit_selectTupleStrBitSelectTupleStrBitSelecttuple_str_bit_select, tuple_concattuple_concatTupleConcatTupleConcattuple_concat, tuple_selecttuple_selectTupleSelectTupleSelecttuple_select, tuple_select_rangetuple_select_rangeTupleSelectRangeTupleSelectRangetuple_select_range, tuple_select_ranktuple_select_rankTupleSelectRankTupleSelectRanktuple_select_rank

See also

tuple_removetuple_removeTupleRemoveTupleRemovetuple_remove

Module

Foundation

---

ClassesClasses | | Operators