Reading Binary Files: Difference between revisions
No edit summary |
|||
| Line 76: | Line 76: | ||
==Reading Real Float== | ==Reading Real Float== | ||
To read from a file storing real samples encoded as floating point numbers, open the '''File | To read from a file storing real samples encoded as floating point numbers, open the '''File Source''' and change the ''Output Type'' to float: | ||
[[File:Reading_binary_files_select_real_float_type.png]] | [[File:Reading_binary_files_select_real_float_type.png]] | ||
| Line 107: | Line 107: | ||
==Reading Real Integers== | ==Reading Real Integers== | ||
Begin by adding a '''File | Begin by adding a '''File Source''' block. Open the properties and navigate to the file ending in ''.real_int'': | ||
[[File:Reading_binary_files_select_real_int_file.png]] | [[File:Reading_binary_files_select_real_int_file.png]] | ||
| Line 166: | Line 166: | ||
[[File:Reading_binary_files_time_freq_complex_int_display.png|750px]] | [[File:Reading_binary_files_time_freq_complex_int_display.png|750px]] | ||
==Repeating Samples from File== | |||
The '''File Source''' block comes with the option to repeat playback from file. When ''Yes'' is selected for repeat, the samples will be played back on loop until the flowgraph is stopped. | |||
[[File:Reading_binary_files_repeat_yes.png]] | |||
When ''No'' is selected for repeat, then all of the samples will be read from file and then the flowgraph will stop running once the last sample is read and then processed through the flowgraph. | |||
[[File:Reading_binary_files_repeat_no.png]] | |||
Revision as of 15:58, 20 April 2024
This tutorial describes how to read binary files using the File Source block along side how to diagnose potential errors.
Please review the Writing Binary Files tutorial before continuing. A series of binary files were created with different formats that will be needed for this tutorial:
File Source Block
The File Source block reads from a binary file and then sends the samples to the output port. Drag the File Source block into a flowgraph. The block by default uses the complex data type (32-bit floats), represented by the blue output port:
Double clicking the File Source block brings up the properties and the ability to select different data types.
A binary file of real floating point data requires the float data type to be selected, which outputs real floating point samples, denoted by an orange output port.
A binary file of 16-bit signed integers requires the short data type to be selected, which outputs 16-bit integers of either real or interleaved I and Q samples (more on this later in the tutorial), denoted by a yellow output port.
Also note that the File Source has the Repeat field enabled as Yes, which will continually and repeatedly play back the same file. Once the last sample is received in the file it skips back to the first sample in the file and continues cycling through the file.
Reading Complex Float Binary File
Add a File Source block, open the properties and begin by selecting the complex type.
Click the three dots to the right side of the File property to browse to a stored binary file.
Select the file ending in .complex_float:
Notice that the filename is now filled in for the File Source however the samp_rate variable is incorrectly 32 kHz (32,000). The sampling rate from the filename is 100 kHz (100,000) therefore update the samp_rate variable:
The change will be reflected in the flowgraph:
Add in the QT GUI Time Sink and QT GUI Frequency Sink and connect them accordingly. Notice how both blocks use samp_rate variable automatically:
Before running the flowgraph, recall that the Writing Binary Files generated a 1 kHz complex sinusoid at a sampling rate of 100 kHz. When playing the file using the File Source the same waveform should be seen.
Now run the flowgraph. Notice that the time-domain plot has sinusoidal shapes on the I and Q channels, characteristic of a complex sinusoid. Also notice how the frequency plot displays a tone with a single peak, also characteristic of a complex sinusoid. Finally, notice how the peak of the frequency plot has a peak of approximately 1 kHz confirming that the binary file was read properly and the samp_rate variable was set properly.
Reading Real Float
To read from a file storing real samples encoded as floating point numbers, open the File Source and change the Output Type to float:
Click the three dots next to File and select the file ending in .real_float:
Open the QT GUI Time Sink properties and change the type to float:
Open the QT GUI Freq Sink properties and change the type to float:
The flowgraph should now look like the following:
Run the flowgraph. Notice that the time-domain plot displays a single sinusoid, characteristic of a real sinusoid waveform. Also notice that the frequency domain plot displays two peaks, characteristic of a real sinusoid. Finally, notice that the peak on the right hand side, the positive frequencies, is at approximately 1 kHz, confirming that the binary file was read properly and the samp_rate variable is set properly.
Reading Real Integers
Begin by adding a File Source block. Open the properties and navigate to the file ending in .real_int:
Change the Output Type property to be short. Be sure not to select int:
Add in a Short to Float block and connect it accordingly:
Notice that the scale factor here is set to 1. This will plot all of the values at full scale, which is from -2^15 to 2^15-1, or 32,768 to +32767. Running the flowgraph with a scaling value of 1 is valid, although some flowgraphs may use a scale factor in order to normalize the data to be within -1 to +1. Open the Short to Float properties and enter a scale factor of 2^15:
The Short to Float block applies the inverse of the scale factor, meaning it will scale the output samples by 2^-15 or 1/32768. The flowgraph will now look like the following:
Running the flowgraph displays the file after being read as real integers. The time domain plot displays a single sinusoid which is characteristic of a real sinusoid, and the frequency domain plot displays two tones which is also characteristic of a real sinusoid. Finally, the peak at the positive frequency tone is approximately 1 kHz which confirms that the file is being read correctly.
Reading Complex Integers
Begin by adding a File Source block. Open the properties and navigate to the file ending in .complex_int:
Open the File Source properties and select the short data type. Do not select the int type:
Drag in a IShort to Complex block and connect it accordingly. Convert the QT GUI Time Sink and QT GUI Frequency Sink blocks into the complex data type. The flowgraph should look like the following.
Note that the IShort to Complex block has a scale factor of 1, which would plot the data on a range of -2^15 to 2^15, or -32,768 to +32,767. Running the flowgraph in this state is valid. However, some flowgraph require normalization such that all values are within -1 and +1. To do so, open the block’s properties and use a scale factor of 2^15:
The IShort to Complex block will apply the inverse of the scale factor, 2^-15 or 1/32768, producing normalized samples from -1 to +1.
Run the flowgraph. The time domain plot displays two sinusoids, characteristic of a complex sinusoid. The frequency domain plot displays a single tone, also characteristic of a complex sinusoid. Finally, the tone is at approximate 1 kHz which confirms that the file is being read correctly.
Repeating Samples from File
The File Source block comes with the option to repeat playback from file. When Yes is selected for repeat, the samples will be played back on loop until the flowgraph is stopped.
When No is selected for repeat, then all of the samples will be read from file and then the flowgraph will stop running once the last sample is read and then processed through the flowgraph.
