Main Content

dca1000FileReader

File-reader object for reading IQ data as radar data cubes from binary files

Since R2024b

expand all in page

Description

The dca1000FileReader enables you to read IQ data as radar data cubes from binary files recorded using the dca1000 object.

Creation

Syntax

dr = dca1000FileReader(RecordLocation = loc)
dr = dca1000FileReader(RecordLocation = loc,BoardName = boardName,ConfigFile = cfgFile)

Description

dr = dca1000FileReader(RecordLocation = loc) reads radar ADC data cubes from the recorded binary files available at the file location specified by loc. Use this syntax if you have used the startRecording function of dca1000 object to record IQ data. The location specified is expected to have a MAT file containing parameters used for recording. If you used dca1000 object to record, the MAT file is automatically generated.

dr = dca1000FileReader(RecordLocation = loc,BoardName = boardName,ConfigFile = cfgFile) reads radar ADC data cubes from the binary files available at the file location loc, by using additional options. The data cube size is obtained from the Configuration file (.cfg) specified by the property ConfigFile (which is the Configuration file used for the configuring the TI mmWave radar). The board name specified is used to validate the Configuration file. For this syntax, it is mandatory to specify both the BoardName and ConfigFile.

You can use this syntax also if you used the DCA1000 CLI tools and the Out-of-Box Demo binary to record the IQ data.

Note

Radar data cube is radar data that is reshaped to the form Number of ADC samples * Number of Receiver Antennas * Number of chirps.

Input Arguments

expand all

Note

All input arguments are name-value pair, out of which recordLocation is mandatory.

Folder location (absolute folder path) where the recordings are stored on the host computer, specified as a string scalar. It is mandatory to specify RecordLocation as Name-Value pair when you create dca1000FileReader object.

Example: fr = dca1000FileReader(RecordLocation = "C:\Users\DCA_data")

Data Types: string

Name of the TI mmWave radar sensor board from which IQ data is read and recorded, specified as a string scalar.

Specify BoardName as Name-Value pair if you used DCA1000 CLI tools and Out-Of-Box Demo binary to record the IQ data. There is no need to specify BoardName if you are trying to read radar data cubes recorded using the startRecording function of dca1000 object. In this case, BoardName will be derived from the MAT file generated with the recording. If you are specifying BoardName, it is also mandatory to specify ConfigFile also using Name-Value pair.

Example: fr = dca1000FileReader(RecordLocation = "C:\Users\DCA_data", BoardName = "IWR6843ISK", ConfigFile = "Range10Hz.cfg")

Data Types: string

Configuration (.cfg) file used for configuring the TI radar before recording, specified as a string scalar.

Specify ConfigFile as a Name-Value pair if you used DCA1000 CLI tools and Out-Of-Box Demo binary to record the IQ data. There is no need to specify ConfigFile if you are trying to read radar data cubes recorded using the startRecording function of dca1000 object. In this case, ConfigFile will be derived from the MAT file generated with the recording. If you are specifying ConfigFile, it is also mandatory to specify BoardName using Name-Value pair.

For more details, see Configure Radar Using a Configuration (.cfg) File for Reading Detections.

Example: fr = dca1000FileReader(RecordLocation = "C:\Users\DCA_data", BoardName = "IWR6843ISK", ConfigFile = "Range10Hz.cfg")

Data Types: string

Properties

expand all

Note

You can specify any of the properties on this page, which are not read-only, as name-value pairs.

The values of the read-only properties are internally set. For the dca1000FileReader object, some of them are derived from the Configuration (.cfg) file. Therefore, you can indirectly modify such properties by updating the Configuration file. To generate the configuration file, see Configure Radar Using a Configuration (.cfg) File for Reading Detections.

Folder location (absolute folder path) where the recordings are stored on the host computer, specified as a string scalar. It is mandatory to specify RecordLocation as Name-Value pair when you create dca1000FileReader object.

Example: fr = dca1000FileReader(RecordLocation = "C:\Users\DCA_data")

Data Types: string

Name of the TI mmWave radar sensor board from which IQ data is read and recorded, specified as a string scalar.

Specify BoardName as Name-Value pair if you used DCA1000 CLI tools and Out-Of-Box Demo binary to record the IQ data. There is no need to specify BoardName if you are trying to read radar data cubes recorded using the startRecording function of dca1000 object. In this case, BoardName will be derived from the MAT file generated with the recording. If you are specifying BoardName, it is also mandatory to specify ConfigFile also using Name-Value pair.

Example: fr = dca1000FileReader(RecordLocation = "C:\Users\DCA_data", BoardName = "IWR6843ISK", ConfigFile = "Range10Hz.cfg")

Data Types: string

Configuration (.cfg) file used for configuring the TI radar before recording, specified as a string scalar.

Specify ConfigFile as a Name-Value pair if you used DCA1000 CLI tools and Out-Of-Box Demo binary to record the IQ data. There is no need to specify ConfigFile if you are trying to read radar data cubes recorded using the startRecording function of dca1000 object. In this case, ConfigFile will be derived from the MAT file generated with the recording. If you are specifying ConfigFile, it is also mandatory to specify BoardName using Name-Value pair.

For more details, see Configure Radar Using a Configuration (.cfg) File for Reading Detections.

Example: fr = dca1000FileReader(RecordLocation = "C:\Users\DCA_data", BoardName = "IWR6843ISK", ConfigFile = "Range10Hz.cfg")

Data Types: string

Prefix that is present in the file names of the binary files that you want to read, specified as a string scalar. By default, the file name of the first binary file is iqData_Raw_0.

Property type: Immutable

Data Types: string

Total number of radar data cubes available in all the files in the location specified by RecordLocation property. The files are identified by RecordFilePrefix property, if specified .

Property type: Read-only

Data Types: double

Index from which to read radar data cube in terms of number of radar cubes. The next call to the read() function starts reading from this index and after the read(), the CurrentPosition gets updated. The initial value of CurrentPosition is 1 and it can be updated till the value specified by NumDataCubes property.

Property type: Read-only

Data Types: double

Object Functions

readRead radar data cubes from the binary files using dca1000FileReader object
hasDataCheck if a radar data cube is available to read using dca1000FileReader object

Examples

Read IQ Data from the Recorded Data as Radar Data Cubes

Create a dca1000FileReader object by specifying the file location where the recorded files are stored.

fr = dca1000FileReader(RecordLocation = "C:\Users\User1\DCA_data")
fr =
 
  dca1000FileReader with properties:
 
                 BoardName: "IWR6843ISK"
                ConfigFile: "C:\Users\DCA_data\Range10Hz.cfg"
            RecordLocation: "C:\Users\DCA_data\"
          RecordFilePrefix: "iq_data"
              NumDataCubes: 63

Use the read function of the dca1000FileReader to read data as radar data cubes.

radarDataCube = read(fr)

Version History

Introduced in R2024b

See Also

Topics