Skip to content

write_tupleWriteTupleWriteTuplewrite_tuplewrite_tuple🔗

Short description🔗

write_tupleWriteTupleWriteTuplewrite_tuplewrite_tuple — Write a tuple to a file.

Signature🔗

write_tuple( tuple Tuple, filename.write FileName )void WriteTuple( const HTuple& Tuple, const HTuple& FileName )static void HOperatorSet.WriteTuple( HTuple tuple, HTuple fileName )def write_tuple( tuple: MaybeSequence[Union[float, int, str]], file_name: str ) -> None

Herror write_tuple( double Tuple, const char* FileName )

Herror T_write_tuple( const Htuple Tuple, const Htuple FileName )

static void HMisc::WriteTuple( const HTuple& Tuple, const HString& FileName )

static void HMisc::WriteTuple( const HTuple& Tuple, const char* FileName )

static void HMisc::WriteTuple( const HTuple& Tuple, const wchar_t* FileName ) (Windows only)

void HTuple::WriteTuple( const HTuple& FileName ) const

static void HMisc.WriteTuple( HTuple tuple, string fileName )

void HTuple.WriteTuple( HTuple fileName )

Description🔗

The operator write_tupleWriteTuple writes the contents of Tupletupletuple to a file. The data is written in an ASCII format. Therefore, the file can be exchanged between different architectures (see also Tuple / String Operations). The default HALCON file extension for the tuple is 'tup'.

Exception: Handles🔗

Note that write_tupleWriteTuple does not support handles, since binary data is not supported by the underlying ASCII format. Any handle contained in Tupletupletuple is replaced by the integer 00. To write a tuple that contains handles, use serialize_tupleSerializeTuple and fwrite_serialized_itemFwriteSerializedItem.

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.

Parameters🔗

Tupletupletuple (input_control) tuple(-array) → (real / integer / string)HTuple (double / Hlong / HString)HTuple (double / int / long / string)MaybeSequence[Union[float, int, str]]Htuple (double / Hlong / char*)

Tuple with any kind of data.

FileNamefileNamefile_name (input_control) filename.write → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Name of the file to be written.

File extension: .tup

Result🔗

If the parameters are correct the operator write_tupleWriteTuple returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.

Combinations with other operators🔗

Combinations

Alternatives

fwrite_stringFwriteString

See also

read_tupleReadTuple, write_imageWriteImage, write_regionWriteRegion, open_fileOpenFile

Module🔗

Foundation