Engee documentation

Binary File Writer

Page in progress.

Writing data to binary files.

blockType: Binary File Writer

Path in the library:

/Signal Operations/Sinks/Binary File Writer

Description

The Binary File Writer block writes multichannel signal data to a binary file. In the parameters of the block you can specify the name of the file and the structure of the header, which will be written before the input data. If the header is not needed, it is necessary to specify empty brackets () in the field of parameters File header. When writing to the file for the first time, the block writes a header followed by the data. On subsequent calls, the block writes the remaining data.

To write matrices, the block uses one of two indexing options, which is set in the parameters Indexing mode. By default, it uses row-by-row (Row-major). For example, if the input matrix is [1 2 4 5; 8 7 9 2], the block writes the data as [1 2 4 5 8 7 9 2].

Ports

Input

# IN_1 — write data
scalar | vector | matrix

Details

The write block writes data to the file specified in the parameters File name. If there is a header File header, the block writes it to the file before writing the data. The block can write floating point and integer data. The input data can be real or complex. If the data is complex, the block writes it as alternating real and imaginary components. The write block assumes the standard by default byte order set on the host machine.

Data types

Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64.

Complex numbers support

Yes

Parameters

Main

# File name — file name

Details

The name of the file to which the block writes data. The file can have any extension.

Default value

Untitled.bin

Program usage name

Filename

Tunable

No

Evaluatable

Yes

# File header — file header

Details

If no header is required, then empty brackets () should be specified in the field. If a header is required, then the field should contain a named tuple (field1 = value, …​, fieldN = valueN), values can be strings, numbers, one-dimensional vectors of numbers and two-dimensional matrices of numbers.

Default value

()

Program usage name

HeaderStructure

Tunable

No

Evaluatable

Yes

# Indexing mode — indexing order for matrix entries
Row-major | Column-major

Details

Select how the block will write data:

  • Row-major - the input matrix is written to the file by rows;

  • Column-major - the input matrix is written to the file by columns.

Values

Row-major | Column-major

Default value

Row-major

Program usage name

IndexingMode

Tunable

No

Evaluatable

No