IUF-SDK-3
Interventional Ultrasound Library
iufIqFile.h
Go to the documentation of this file.
1 #ifndef IUFLIBRARY_IUFHLIQFILE_H
2 #define IUFLIBRARY_IUFHLIQFILE_H
3 
4 #include <iufAcquisition.h>
5 #include <iufIqPatternListDict.h>
6 #include <iufPulseDict.h>
9 #include <iufFrameList.h>
10 #include "iufSourceDict.h"
11 #include "iufDemodulationDict.h"
12 #include "iufTransducer.h"
13 #include "iufData.h"
14 #include "iufOffset.h"
15 
16 // ADT
17 typedef struct IufHistoryNode IufIqFile;
22 typedef IufIqFile *iuiqf_t;
23 
24 #define IUIQF_INVALID (iuiqf_t) NULL
25 #define IUF_DEFAULT_NUM_FRAMES 1
26 
31 (
32  const char *filename
33 );
34 
39 (
40  iuiqf_t iqFile,
41  char *label
42 );
43 
44 
50 (
51  iuiqf_t iqFile,
52  char *label
53 );
54 
60 (
61  iuiqf_t iqFile,
62  char *label
63 );
64 
70 (
71  iuiqf_t iqFile
72 );
73 
78 (
79  const char *pFilename
80 );
81 
86 (
87  iuiqf_t iqFile
88 );
89 
94 (
95  iuiqf_t iqFile
96 );
97 
102 (
103  iuiqf_t reference,
104  iuiqf_t actual
105 );
106 
111 (
112  iuiqf_t iqFile
113 );
114 
119 (
120  iuiqf_t iqFile
121 );
122 
127 (
128  iuiqf_t iqFile
129 );
130 
135 (
136  iuiqf_t iqFile
137 );
138 
143 (
144  iuiqf_t iqFile
145 );
146 
151 (
152  iuiqf_t iqFile
153 );
154 
159 (
160  iuiqf_t iqFile
161 );
162 
167 (
168  iuiqf_t iqFile
169 );
170 
175 (
176  iuiqf_t iqFile
177 );
178 
183 (
184  iuiqf_t iqFile
185 );
186 
191 (
192  iuiqf_t iqFile,
193  char *label
194 );
195 
200 (
201  iuiqf_t iqFile,
202  char *label
203 );
204 
205 
210 (
211  iuiqf_t iqFile,
212  char *label
213 );
214 
215 // Setters
220 (
221  iuiqf_t iqFile,
222  iufl_t frameList
223 );
224 
229 (
230  iuiqf_t iqFile,
231  iuiqpald_t iqPatternListDict
232 );
233 
238 (
239  iuiqf_t iqFile,
240  iupd_t pulseDict
241 );
242 
247 (
248  iuiqf_t iqFile,
249  iusd_t sourceDict
250 );
251 
256 (
257  iuiqf_t iqFile,
258  iurcmd_t receiveChannelMapDict
259 );
260 
265 (
266  iuiqf_t iqFile,
267  iutad_t transmitApodizationDict
268 );
269 
274 (
275  iuiqf_t iqFile,
276  iudmd_t demodulationDict
277 );
278 
283 (
284  iuiqf_t iqFile,
285  iua_t acquisition
286 );
287 
292 (
293  iuiqf_t iqFile,
294  iut_t transducer
295 );
296 
301 (
302  iuiqf_t iqFile,
303  char *label,
304  IufComponent component,
305  iud_t channel,
306  iuo_t channel_offset
307 );
308 
313 (
314  iuiqf_t iqFile,
315  char *label,
316  IufComponent component,
317  iud_t channel,
318  iuo_t channel_offset
319 );
320 
325 (
326  iuiqf_t iqFile,
327  char *label,
328  IufComponent component,
329  iud_t response,
330  iuo_t response_offset
331 );
332 
337 (
338  iuiqf_t iqFile,
339  char *label,
340  IufComponent component,
341  iud_t response,
342  iuo_t response_offset
343 );
344 
349 (
350  iuiqf_t iqFile,
351  char *label,
352  IufComponent component,
353  iud_t frame,
354  iuo_t frame_offset
355 );
356 
361 (
362  iuiqf_t iqFile,
363  char *label,
364  IufComponent component,
365  iud_t frame,
366  iuo_t frame_offset
367 );
368 
369 
370 #endif //IUFLIBRARY_IUFHLIQFILE_H
iusd_t iufIqFileGetSourceDict(iuiqf_t iqFile)
Gets the IufSourceDict object from an iqFile.
Definition: iufIqFile.c:482
Definition: iufData.c:7
iudmd_t iufIqFileGetDemodulationDict(iuiqf_t iqFile)
Gets the IufReceiveSettingsDict object from an iqFile.
Definition: iufIqFile.c:513
Definition: iufDemodulationDictADT.h:15
iutad_t iufIqFileGetTransmitApodizationDict(iuiqf_t iqFile)
Gets the IufTransmitApodizationDict object from an iqFile.
Definition: iufIqFile.c:503
iuiqpald_t iufIqFileGetIqPatternListDict(iuiqf_t iqFile)
Gets the IufPatternListDict object from an iqFile.
int iufIqFileCompare(iuiqf_t reference, iuiqf_t actual)
Compares two iqFile instances with each other.
Definition: iufIqFile.c:431
Definition: iufHistoryNodeADT.h:4
iurcmd_t iufIqFileGetReceiveChannelMapDict(iuiqf_t iqFile)
Gets the IufReceiveChannelMapDict object from an iqFile.
Definition: iufIqFile.c:493
int iufIqFileFrameSave(iuiqf_t iqFile, char *label, IufComponent component, iud_t frame, iuo_t frame_offset)
Saves a frame of data to an iqFile.
Definition: iufIqFile.c:827
IufComponent
Definition: iufTypes.h:60
IufIqFile * iuiqf_t
Definition: iufIqFile.h:22
int iufIqFileClose(iuiqf_t iqFile)
Closes access to the iqFile.
Definition: iufIqFile.c:395
Definition: iufPulseDict.c:21
iud_t iufIqFileChannelCreate(iuiqf_t iqFile, char *label)
Creates a datablock for an single I channel (i.e. numSamplesPerLine floats) for the acquisition with ...
Definition: iufIqFile.c:229
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.
Definition: iufIqFile.c:1055
int iufIqFileSetPulseDict(iuiqf_t iqFile, iupd_t pulseDict)
Sets the pulseDict of an iqFile.
Definition: iufIqFile.c:572
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...
Definition: iufIqFile.c:197
Definition: iufTransmitApodizationDictADT.h:16
int iufIqFileGetNumChannels(iuiqf_t iqFile, char *label)
Gets the number of channels for the patternList type label.
Definition: iufIqFile.c:150
int iufIqFileSetReceiveChannelMapDict(iuiqf_t iqFile, iurcmd_t receiveChannelMapDict)
Sets the receiveChannelMap of an iqFile.
Definition: iufIqFile.c:598
Definition: iufFrameList.c:9
int iufIqFileNodeSave(iuiqf_t iqFile)
Save (serialize) the iqFile instance to file.
Definition: iufIqFile.c:381
Definition: iufReceiveChannelMapDictADT.h:16
int iufIqFileDelete(iuiqf_t iqFile)
Creates a datablock for a single channel (i.e. numSamplesPerLine floats) for the acquisition with the...
Definition: iufIqFile.c:100
Definition: iufSourceDict.c:18
An Ultrasound acquisition is identified by a date and a description, also the speed of sound has been...
Definition: iufAcquisitionADT.h:6
int iufIqFileSetTransmitApodizationDict(iuiqf_t iqFile, iutad_t transmitApodizationDict)
Sets the transmitApodizationDict of an iqFile.
iud_t iufIqFileResponseCreate(iuiqf_t iqFile, char *label)
Creates a datablock for a response (numSamplesPerLine * numChannels) for the acquisition with the nam...
Definition: iufIqFile.c:214
Definition: iufIqPatternListDictADT.h:15
int iufIqFileGetNumResponses(iuiqf_t iqFile, char *label)
Gets the number of responses for the patternList type label.
Definition: iufIqFile.c:181
iuiqf_t iufIqFileNodeLoad(const char *pFilename)
Load an iqFile instance from a file.
Definition: iufIqFile.c:338
iut_t iufIqFileGetTransducer(iuiqf_t iqFile)
Gets the IufTransducer object from an iqFile.
Definition: iufIqFile.c:533
int iufIqFileSetDemodulationDict(iuiqf_t iqFile, iudmd_t demodulationDict)
Sets the receiveSettingsDict of an iqFile.
Definition: iufIqFile.c:624
int iufIqFileGetSamplesPerLine(iuiqf_t iqFile, char *label)
Gets the number of samples per line for this label.
Definition: iufIqFile.c:165
int iufIqFileChannelSave(iuiqf_t iqFile, char *label, IufComponent component, iud_t channel, iuo_t channel_offset)
Saves a channel of data to an iqFile.
Definition: iufIqFile.c:940
int iufIqFileResponseSave(iuiqf_t iqFile, char *label, IufComponent component, iud_t response, iuo_t response_offset)
Saves a channel of data to an iqFile.
Definition: iufIqFile.c:884
iuiqf_t iufIqFileCreate(const char *filename)
Create an empty file instance with a filename.
Definition: iufIqFile.c:112
int iufIqFileSetTransducer(iuiqf_t iqFile, iut_t transducer)
Sets the transducer of an iqFile.
Definition: iufIqFile.c:652
Definition: iufIqFile.c:40
Definition: iufTransducerADT.h:4
int iufIqFileSetFrameList(iuiqf_t iqFile, iufl_t frameList)
Sets the frameList of an iqFile.
Definition: iufIqFile.c:546
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.
Definition: iufIqFile.c:1113
int iufIqFileSetAcquisition(iuiqf_t iqFile, iua_t acquisition)
Sets the acquisition info of an iqFile.
Definition: iufIqFile.c:638
iua_t iufIqFileGetAcquisition(iuiqf_t iqFile)
Gets the IufAcquisition object from an iqFile.
Definition: iufIqFile.c:523
Definition: iufOffset.h:6
iufl_t iufIqFileGetFrameList(iuiqf_t iqFile)
Gets the IufFrameList object from an iqFile.
Definition: iufIqFile.c:451
int iufIqFileFrameLoad(iuiqf_t iqFile, char *label, IufComponent component, iud_t frame, iuo_t frame_offset)
Loads a frame of data to an iqFile.
Definition: iufIqFile.c:997
iupd_t iufIqFileGetPulseDict(iuiqf_t iqFile)
Gets the IufPulseDict object from an iqFile.
Definition: iufIqFile.c:472
int iufIqFileSetPatternListDict(iuiqf_t iqFile, iuiqpald_t iqPatternListDict)
Sets the patternListDict of an iqFile.
Definition: iufIqFile.c:559
int iufIqFileGetNumFrames(iuiqf_t iqFile)
Returns the number of frames an iqFile has.
Definition: iufIqFile.c:139
int iufIqFileSetSourceDict(iuiqf_t iqFile, iusd_t sourceDict)
Sets the sourceDict of an iqFile.
Definition: iufIqFile.c:585