#include <iufAcquisition.h>
#include <iufIqPatternListDict.h>
#include <iufPulseDict.h>
#include <iufReceiveChannelMapDict.h>
#include <iufTransmitApodizationDict.h>
#include <iufFrameList.h>
#include "iufSourceDict.h"
#include "iufDemodulationDict.h"
#include "iufTransducer.h"
#include "iufData.h"
#include "iufOffset.h"

Macros
#define	IUIQF_INVALID (iuiqf_t) NULL

#define	IUF_DEFAULT_NUM_FRAMES 1

Typedefs
typedef IufIqFile *	iuiqf_t

Functions
iuiqf_t	iufIqFileCreate (const char *filename)
	Create an empty file instance with a filename. More...

iud_t	iufIqFileFrameCreate (iuiqf_t iqFile, char *label)
	Creates a datablock for the I or Q Component of a frame for the acquisition with the name `label`. Typically called on both components. More...

iud_t	iufIqFileResponseCreate (iuiqf_t iqFile, char *label)
	Creates a datablock for a response (numSamplesPerLine * numChannels) for the acquisition with the name `label`. Typically called on both components. More...

iud_t	iufIqFileChannelCreate (iuiqf_t iqFile, char *label)
	Creates a datablock for an single I channel (i.e. numSamplesPerLine floats) for the acquisition with the name `label`. Typically called on both components. More...

int	iufIqFileDelete (iuiqf_t iqFile)
	Creates a datablock for a single channel (i.e. numSamplesPerLine floats) for the acquisition with the name `label`. More...

iuiqf_t	iufIqFileNodeLoad (const char *pFilename)
	Load an iqFile instance from a file. More...

int	iufIqFileNodeSave (iuiqf_t iqFile)
	Save (serialize) the iqFile instance to file. More...

int	iufIqFileClose (iuiqf_t iqFile)
	Closes access to the iqFile. More...

int	iufIqFileCompare (iuiqf_t reference, iuiqf_t actual)
	Compares two iqFile instances with each other. More...

iufl_t	iufIqFileGetFrameList (iuiqf_t iqFile)
	Gets the IufFrameList object from an iqFile. More...

iuiqpald_t	iufIqFileGetIqPatternListDict (iuiqf_t iqFile)
	Gets the IufPatternListDict object from an iqFile. More...

iupd_t	iufIqFileGetPulseDict (iuiqf_t iqFile)
	Gets the IufPulseDict object from an iqFile. More...

iusd_t	iufIqFileGetSourceDict (iuiqf_t iqFile)
	Gets the IufSourceDict object from an iqFile. More...

iurcmd_t	iufIqFileGetReceiveChannelMapDict (iuiqf_t iqFile)
	Gets the IufReceiveChannelMapDict object from an iqFile. More...

iutad_t	iufIqFileGetTransmitApodizationDict (iuiqf_t iqFile)
	Gets the IufTransmitApodizationDict object from an iqFile. More...

iudmd_t	iufIqFileGetDemodulationDict (iuiqf_t iqFile)
	Gets the IufReceiveSettingsDict object from an iqFile. More...

iua_t	iufIqFileGetAcquisition (iuiqf_t iqFile)
	Gets the IufAcquisition object from an iqFile. More...

iut_t	iufIqFileGetTransducer (iuiqf_t iqFile)
	Gets the IufTransducer object from an iqFile. More...

int	iufIqFileGetNumFrames (iuiqf_t iqFile)
	Returns the number of frames an iqFile has. More...

int	iufIqFileGetNumResponses (iuiqf_t iqFile, char *label)
	Gets the number of responses for the patternList type `label`. More...

int	iufIqFileGetNumChannels (iuiqf_t iqFile, char *label)
	Gets the number of channels for the patternList type `label`. More...

int	iufIqFileGetSamplesPerLine (iuiqf_t iqFile, char *label)
	Gets the number of samples per line for this `label`. More...

int	iufIqFileSetFrameList (iuiqf_t iqFile, iufl_t frameList)
	Sets the frameList of an iqFile. More...

int	iufIqFileSetPatternListDict (iuiqf_t iqFile, iuiqpald_t iqPatternListDict)
	Sets the patternListDict of an iqFile. More...

int	iufIqFileSetPulseDict (iuiqf_t iqFile, iupd_t pulseDict)
	Sets the pulseDict of an iqFile. More...

int	iufIqFileSetSourceDict (iuiqf_t iqFile, iusd_t sourceDict)
	Sets the sourceDict of an iqFile. More...

int	iufIqFileSetReceiveChannelMapDict (iuiqf_t iqFile, iurcmd_t receiveChannelMapDict)
	Sets the receiveChannelMap of an iqFile. More...

int	iufIqFileSetTransmitApodizationDict (iuiqf_t iqFile, iutad_t transmitApodizationDict)
	Sets the transmitApodizationDict of an iqFile. More...

int	iufIqFileSetDemodulationDict (iuiqf_t iqFile, iudmd_t demodulationDict)
	Sets the receiveSettingsDict of an iqFile. More...

int	iufIqFileSetAcquisition (iuiqf_t iqFile, iua_t acquisition)
	Sets the acquisition info of an iqFile. More...

int	iufIqFileSetTransducer (iuiqf_t iqFile, iut_t transducer)
	Sets the transducer of an iqFile. More...

int	iufIqFileChannelSave (iuiqf_t iqFile, char *label, IufComponent component, iud_t channel, iuo_t channel_offset)
	Saves a channel of data to an iqFile. More...

int	iufIqFileChannelLoad (iuiqf_t iqFile, char *label, IufComponent component, iud_t channel, iuo_t channel_offset)
	Loads a single channel of data from an iqFile. More...

int	iufIqFileResponseSave (iuiqf_t iqFile, char *label, IufComponent component, iud_t response, iuo_t response_offset)
	Saves a channel of data to an iqFile. More...

int	iufIqFileResponseLoad (iuiqf_t iqFile, char *label, IufComponent component, iud_t response, iuo_t response_offset)
	Loads a single response of data from an iqFile. More...

int	iufIqFileFrameSave (iuiqf_t iqFile, char *label, IufComponent component, iud_t frame, iuo_t frame_offset)
	Saves a frame of data to an iqFile. More...

int	iufIqFileFrameLoad (iuiqf_t iqFile, char *label, IufComponent component, iud_t frame, iuo_t frame_offset)
	Loads a frame of data to an iqFile. More...

Macro Definition Documentation

◆ IUF_DEFAULT_NUM_FRAMES

#define IUF_DEFAULT_NUM_FRAMES 1

◆ IUIQF_INVALID

#define IUIQF_INVALID (iuiqf_t) NULL

Typedef Documentation

◆ iuiqf_t

typedef IufIqFile* iuiqf_t

The iq file is the instance for the "raw" file format with demodulation settings instead of sampling. It contains the unprocessed ultrasound aquisition. The instance contains a IufFrameList, a IufTransducer definition, IufAcquisition information and one or more data blocks referering to a patternList. In addition, node history can be added.

Function Documentation

◆ iufIqFileChannelCreate()

iud_t iufIqFileChannelCreate	(	iuiqf_t	iqFile,
		char *	label
	)

Creates a datablock for an single I channel (i.e. numSamplesPerLine floats) for the acquisition with the name label. Typically called on both components.

Returns: Returns an allocated memory block of a "label"-channel or IUD_INVALID in case of an error.

Parameters

iqFile	The IufIqFile of interest
label	The acquisition type

◆ iufIqFileChannelLoad()

int iufIqFileChannelLoad	(	iuiqf_t	iqFile,
		char *	label,
		IufComponent	component,
		iud_t	channel,
		iuo_t	channel_offset
	)

Loads a single channel of data from an iqFile.

Returns: Returns IUF_E_OK when succesful or <0 in case of an error.

Parameters

iqFile	The IufIqFile of interest
label	The label of the patternList
component	Is it an I or a Q component?
channel	The channel data block to be filled
channel_offset	The offset in the datablock

◆ iufIqFileChannelSave()

int iufIqFileChannelSave	(	iuiqf_t	iqFile,
		char *	label,
		IufComponent	component,
		iud_t	channel,
		iuo_t	channel_offset
	)

Saves a channel of data to an iqFile.

Returns: Returns IUF_E_OK when succesful or <0 in case of an error.

Parameters

iqFile	The IufIqFile of interest
label	The label of the patternList
component	Is it an I or a Q component?
channel	The channel data to save
channel_offset	The offsets in the datablock

◆ iufIqFileClose()

int iufIqFileClose ( iuiqf_t iqFile )

Closes access to the iqFile.

Returns: Returns IUF_E_OK when succesful or IUF_ERR_VALUE in case of an error

Parameters

iqFile The IufIqFile of interest

◆ iufIqFileCompare()

int iufIqFileCompare	(	iuiqf_t	reference,
		iuiqf_t	actual
	)

Compares two iqFile instances with each other.

Returns: Returns IUF_TRUE when the iqFiles are equal and IUF_FALSE otherwise.

Parameters

reference	The IufIqFile to compare to
actual	The IufIqFile to compare with

◆ iufIqFileCreate()

iuiqf_t iufIqFileCreate ( const char * filename )

Create an empty file instance with a filename.

Returns: Returns the empty file instance when succesful or IUIF_INVALID in case of an error.

Parameters

filename The filename for the file instance.

◆ iufIqFileDelete()

int iufIqFileDelete ( iuiqf_t iqFile )

Creates a datablock for a single channel (i.e. numSamplesPerLine floats) for the acquisition with the name label.

Returns: Returns an allocated memory block of a "label"-channel or IUD_INVALID in case of an error.

Parameters

iqFile The IufIqFile of interest

◆ iufIqFileFrameCreate()

iud_t iufIqFileFrameCreate	(	iuiqf_t	iqFile,
		char *	label
	)

Creates a datablock for the I or Q Component of a frame for the acquisition with the name label. Typically called on both components.

Returns: Returns an allocated memory block of a "label"-frame or IUD_INVALID in case of an error.

Parameters

iqFile	The IufIqFile of interest
label	The acquisition type

◆ iufIqFileFrameLoad()

int iufIqFileFrameLoad	(	iuiqf_t	iqFile,
		char *	label,
		IufComponent	component,
		iud_t	frame,
		iuo_t	frame_offset
	)

Loads a frame of data to an iqFile.

Returns: Returns IUF_E_OK when succesful or <0 in case of an error.

Parameters

iqFile	The IufIqFile of interest
label	The label of the patternList
component	Is it an I or a Q component?
frame	The frame of data
frame_offset	The offset in the datablock

◆ iufIqFileFrameSave()

int iufIqFileFrameSave	(	iuiqf_t	iqFile,
		char *	label,
		IufComponent	component,
		iud_t	frame,
		iuo_t	frame_offset
	)

Saves a frame of data to an iqFile.

Returns: Returns IUF_E_OK when succesful or <0 in case of an error.

Parameters

iqFile	The IufIqFile of interest
label	The label of the patternList
component	Is it an I or a Q component?
frame	The frame of data
frame_offset	The offset in the datablock

◆ iufIqFileGetAcquisition()

iua_t iufIqFileGetAcquisition ( iuiqf_t iqFile )

Gets the IufAcquisition object from an iqFile.

Returns: Returns the requested IufAcquisition or NULL in case of an error.

Parameters

iqFile The IufIqFile of interest

◆ iufIqFileGetDemodulationDict()

iudmd_t iufIqFileGetDemodulationDict ( iuiqf_t iqFile )

Gets the IufReceiveSettingsDict object from an iqFile.

Returns: Returns the requested IufReceiveSettingsDict or NULL in case of an error.

Parameters

iqFile The IufIqFile of interest

◆ iufIqFileGetFrameList()

iufl_t iufIqFileGetFrameList ( iuiqf_t iqFile )

Gets the IufFrameList object from an iqFile.

Returns: Returns the requested IufFrameList or IUFL_INVALID in case of an error.

Parameters

iqFile The IufIqFile of interest

◆ iufIqFileGetIqPatternListDict()

iuiqpald_t iufIqFileGetIqPatternListDict ( iuiqf_t iqFile )

Gets the IufPatternListDict object from an iqFile.

Returns: Returns the requested IufPatternListDict or NULL in case of an error.

Parameters

iqFile The IufIqFile of interest

◆ iufIqFileGetNumChannels()

int iufIqFileGetNumChannels	(	iuiqf_t	iqFile,
		char *	label
	)

Gets the number of channels for the patternList type label.

Returns: Returns the number of channels or -1 in case of an error.

Parameters

iqFile	The IufIqFile of interest
label	the patternList type

◆ iufIqFileGetNumFrames()

int iufIqFileGetNumFrames ( iuiqf_t iqFile )

Returns the number of frames an iqFile has.

Returns: Returns the number of frames or 0 if there are no frames, or -1 in case of an invalid argument.

Parameters

iqFile The IufIqFile of interest

◆ iufIqFileGetNumResponses()

int iufIqFileGetNumResponses	(	iuiqf_t	iqFile,
		char *	label
	)

Gets the number of responses for the patternList type label.

Returns: Returns the number of responses (numPatterns) or -1 in case of an error.

Parameters

iqFile	The IufIqFile of interest
label	the patternList type

◆ iufIqFileGetPulseDict()

iupd_t iufIqFileGetPulseDict ( iuiqf_t iqFile )

Gets the IufPulseDict object from an iqFile.

Returns: Returns the requested IufPulseDict or IUPD_INVALID in case of an error.

Parameters

iqFile The IufIqFile of interest

◆ iufIqFileGetReceiveChannelMapDict()

iurcmd_t iufIqFileGetReceiveChannelMapDict ( iuiqf_t iqFile )

Gets the IufReceiveChannelMapDict object from an iqFile.

Returns: Returns the requested IufReceiveChannelMapDict or IURCMD_INVALID in case of an error.

Parameters

iqFile The IufIqFile of interest

◆ iufIqFileGetSamplesPerLine()

int iufIqFileGetSamplesPerLine	(	iuiqf_t	iqFile,
		char *	label
	)

Gets the number of samples per line for this label.

Returns: Returns the number of channels or -1 in case of an error.

Parameters

iqFile	The IufIqFile of interest
label	the patternList type

◆ iufIqFileGetSourceDict()

iusd_t iufIqFileGetSourceDict ( iuiqf_t iqFile )

Gets the IufSourceDict object from an iqFile.

Returns: Returns the requested IufSourceDict or IUFD_INVALID in case of an error.

Parameters

iqFile The IufIqFile of interest

◆ iufIqFileGetTransducer()

iut_t iufIqFileGetTransducer ( iuiqf_t iqFile )

Gets the IufTransducer object from an iqFile.

Returns: Returns the requested IufTransducer or NULL in case of an error.

Parameters

iqFile The IufIqFile of interest

◆ iufIqFileGetTransmitApodizationDict()

iutad_t iufIqFileGetTransmitApodizationDict ( iuiqf_t iqFile )

Gets the IufTransmitApodizationDict object from an iqFile.

Returns: Returns the requested IufTransmitApodizationDict or NULL in case of an error.

Parameters

iqFile The IufIqFile of interest

◆ iufIqFileNodeLoad()

iuiqf_t iufIqFileNodeLoad ( const char * pFilename )

Load an iqFile instance from a file.

Returns: Returns an iq file instance or IUIF_INVALID the file could not be read.

Parameters

pFilename The filename of the iqFile

◆ iufIqFileNodeSave()

int iufIqFileNodeSave ( iuiqf_t iqFile )

Save (serialize) the iqFile instance to file.

Returns: Returns IUF_E_OK when succesful or IUF_ERR_VALUE in case of an error

Parameters

iqFile The IufIqFile of interest

◆ iufIqFileResponseCreate()

iud_t iufIqFileResponseCreate	(	iuiqf_t	iqFile,
		char *	label
	)

Creates a datablock for a response (numSamplesPerLine * numChannels) for the acquisition with the name label. Typically called on both components.

Returns: Returns an allocated memory block of a "label"-response or IUD_INVALID in case of an error.

Parameters

iqFile	The IufIqFile of interest
label	The acquisition type

◆ iufIqFileResponseLoad()

int iufIqFileResponseLoad	(	iuiqf_t	iqFile,
		char *	label,
		IufComponent	component,
		iud_t	response,
		iuo_t	response_offset
	)

Loads a single response of data from an iqFile.

Returns: Returns IUF_E_OK when succesful or <0 in case of an error.

Parameters

iqFile	The IufIqFile of interest
label	The label of the patternList
component	Is it an I or a Q component?
response	The response data to load
response_offset	The offset in the datablock

◆ iufIqFileResponseSave()

int iufIqFileResponseSave	(	iuiqf_t	iqFile,
		char *	label,
		IufComponent	component,
		iud_t	response,
		iuo_t	response_offset
	)

Saves a channel of data to an iqFile.

Returns: Returns IUF_E_OK when succesful or <0 in case of an error.

Parameters

iqFile	The IufIqFile of interest
label	The label of the patternList
component	Is it an I or a Q component?
response	the response data to save
response_offset	The offset in the datablock

◆ iufIqFileSetAcquisition()

int iufIqFileSetAcquisition	(	iuiqf_t	iqFile,
		iua_t	acquisition
	)

Sets the acquisition info of an iqFile.

Returns: Returns IUF_E_OK when succesful or IUF_ERR_VALUE in case of an error.

Parameters

iqFile	The IufIqFile of interest
acquisition	The IufAcquisition to set

◆ iufIqFileSetDemodulationDict()

int iufIqFileSetDemodulationDict	(	iuiqf_t	iqFile,
		iudmd_t	demodulationDict
	)

Sets the receiveSettingsDict of an iqFile.

Returns: Returns IUF_E_OK when succesful or IUF_ERR_VALUE in case of an error.

Parameters

iqFile	The IufIqFile of interest
demodulationDict	The IufTransmitApodizationDict to set

◆ iufIqFileSetFrameList()

int iufIqFileSetFrameList	(	iuiqf_t	iqFile,
		iufl_t	frameList
	)

Sets the frameList of an iqFile.

Returns: Returns IUF_E_OK when succesful or IUF_ERR_VALUE in case of an error.

Parameters

iqFile	The IufIqFile of interest
frameList	The IufFrameList to set

◆ iufIqFileSetPatternListDict()

int iufIqFileSetPatternListDict	(	iuiqf_t	iqFile,
		iuiqpald_t	iqPatternListDict
	)

Sets the patternListDict of an iqFile.

Returns: Returns IUF_E_OK when succesful or IUF_ERR_VALUE in case of an error.

Parameters

iqFile	The IufIqFile of interest
iqPatternListDict	The IufPatternListDict to set

◆ iufIqFileSetPulseDict()

int iufIqFileSetPulseDict	(	iuiqf_t	iqFile,
		iupd_t	pulseDict
	)

Sets the pulseDict of an iqFile.

Returns: Returns IUF_E_OK when succesful or IUF_ERR_VALUE in case of an error.

Parameters

iqFile	The IufIqFile of interest
pulseDict	The IufPulseDict to set

◆ iufIqFileSetReceiveChannelMapDict()

int iufIqFileSetReceiveChannelMapDict	(	iuiqf_t	iqFile,
		iurcmd_t	receiveChannelMapDict
	)

Sets the receiveChannelMap of an iqFile.

Returns: Returns IUF_E_OK when succesful or IUF_ERR_VALUE in case of an error.

Parameters

iqFile	The IufIqFile of interest
receiveChannelMapDict	The IufReceiveChannelMapDict to set

◆ iufIqFileSetSourceDict()

int iufIqFileSetSourceDict	(	iuiqf_t	iqFile,
		iusd_t	sourceDict
	)

Sets the sourceDict of an iqFile.

Returns: Returns IUF_E_OK when succesful or IUF_ERR_VALUE in case of an error.

Parameters

iqFile	The IufIqFile of interest
sourceDict	The IufSourceDict to set

◆ iufIqFileSetTransducer()

int iufIqFileSetTransducer	(	iuiqf_t	iqFile,
		iut_t	transducer
	)

Sets the transducer of an iqFile.

Returns: Returns IUF_E_OK when succesful or IUF_ERR_VALUE in case of an error.

Parameters

iqFile	The IufIqFile of interest
transducer	The IufTransducer to set

◆ iufIqFileSetTransmitApodizationDict()

int iufIqFileSetTransmitApodizationDict	(	iuiqf_t	iqFile,
		iutad_t	transmitApodizationDict
	)

Sets the transmitApodizationDict of an iqFile.

Returns: Returns IUF_E_OK when succesful or IUF_ERR_VALUE in case of an error.

Parameters

iqFile	The IufIqFile of interest
transmitApodizationDict	The IufTransmitApodizationDict to set

Macros

Typedefs

Functions

Macro Definition Documentation

◆ IUF_DEFAULT_NUM_FRAMES

◆ IUIQF_INVALID

Typedef Documentation

◆ iuiqf_t

Function Documentation

◆ iufIqFileChannelCreate()

◆ iufIqFileChannelLoad()

◆ iufIqFileChannelSave()

◆ iufIqFileClose()

◆ iufIqFileCompare()

◆ iufIqFileCreate()

◆ iufIqFileDelete()

◆ iufIqFileFrameCreate()

◆ iufIqFileFrameLoad()

◆ iufIqFileFrameSave()

◆ iufIqFileGetAcquisition()

◆ iufIqFileGetDemodulationDict()

◆ iufIqFileGetFrameList()

◆ iufIqFileGetIqPatternListDict()

◆ iufIqFileGetNumChannels()

◆ iufIqFileGetNumFrames()

◆ iufIqFileGetNumResponses()

◆ iufIqFileGetPulseDict()

◆ iufIqFileGetReceiveChannelMapDict()

◆ iufIqFileGetSamplesPerLine()

◆ iufIqFileGetSourceDict()

◆ iufIqFileGetTransducer()

◆ iufIqFileGetTransmitApodizationDict()

◆ iufIqFileNodeLoad()

◆ iufIqFileNodeSave()

◆ iufIqFileResponseCreate()

◆ iufIqFileResponseLoad()

◆ iufIqFileResponseSave()

◆ iufIqFileSetAcquisition()

◆ iufIqFileSetDemodulationDict()

◆ iufIqFileSetFrameList()

◆ iufIqFileSetPatternListDict()

◆ iufIqFileSetPulseDict()

◆ iufIqFileSetReceiveChannelMapDict()

◆ iufIqFileSetSourceDict()

◆ iufIqFileSetTransducer()

◆ iufIqFileSetTransmitApodizationDict()