IUF-SDK-3
Interventional Ultrasound Library
iufInputFile.h
Go to the documentation of this file.
1 #ifndef IUFLIBRARY_IUFHLINPUTFILE_H
2 #define IUFLIBRARY_IUFHLINPUTFILE_H
3 
4 #include <iufAcquisition.h>
5 #include <iufPatternListDict.h>
6 #include <iufPulseDict.h>
9 #include <iufFrameList.h>
10 #include "iufSourceDict.h"
11 #include "iufReceiveSettingsDict.h"
12 #include "iufTransducer.h"
13 #include "iufData.h"
14 #include "iufOffset.h"
15 
16 // ADT
17 typedef struct IufHistoryNode IufInputFile;
23 
24 #define IUIF_INVALID (iuif_t) NULL
25 #define IUF_DEFAULT_NUM_FRAMES 1
26 
31 (
32  const char *filename
33 );
34 
39 (
40  iuif_t inputFile,
41  char *label
42 );
43 
49 (
50  iuif_t inputFile,
51  char *label
52 );
53 
59 (
60  iuif_t inputFile,
61  char *label
62 );
63 
69 (
70  iuif_t inputFile
71 );
72 
77 (
78  const char *pFilename
79 );
80 
85 (
86  iuif_t inputFile
87 );
88 
93 (
94  iuif_t inputFile
95 );
96 
101 (
102  iuif_t reference,
103  iuif_t actual
104 );
105 
110 (
111  iuif_t inputFile
112 );
113 
118 (
119  iuif_t inputFile
120 );
121 
126 (
127  iuif_t inputFile
128 );
129 
134 (
135  iuif_t inputFile
136 );
137 
142 (
143  iuif_t inputFile
144 );
145 
150 (
151  iuif_t inputFile
152 );
153 
158 (
159  iuif_t inputFile
160 );
161 
166 (
167  iuif_t inputFile
168 );
169 
174 (
175  iuif_t inputFile
176 );
177 
182 (
183  iuif_t inputFile
184 );
185 
190 (
191  iuif_t inputFile,
192  char *label
193 );
194 
199 (
200  iuif_t inputFile,
201  char *label
202 );
203 
204 
209 (
210  iuif_t inputFile,
211  char *label
212 );
213 
214 // Setters
219 (
220  iuif_t inputFile,
221  iufl_t frameList
222 );
223 
228 (
229  iuif_t inputFile,
230  iupald_t patternListDict
231 );
232 
237 (
238  iuif_t inputFile,
239  iupd_t pulseDict
240 );
241 
246 (
247  iuif_t inputFile,
248  iusd_t sourceDict
249 );
250 
255 (
256  iuif_t inputFile,
257  iurcmd_t receiveChannelMapDict
258 );
259 
264 (
265  iuif_t inputFile,
266  iutad_t transmitApodizationDict
267 );
268 
273 (
274  iuif_t inputFile,
275  iursd_t receiveSettingsDict
276 );
277 
282 (
283  iuif_t inputFile,
284  iua_t acquisition
285 );
286 
291 (
292  iuif_t inputFile,
293  iut_t transducer
294 );
295 
300 (
301  iuif_t inputFile,
302  char *label,
303  iud_t channel,
304  iuo_t channel_offset
305 );
306 
311 (
312  iuif_t inputFile,
313  char *label,
314  iud_t channel,
315  iuo_t channel_offset
316 );
317 
322 (
323  iuif_t inputFile,
324  char *label,
325  iud_t response,
326  iuo_t response_offset
327 );
328 
333 (
334  iuif_t inputFile,
335  char *label,
336  iud_t response,
337  iuo_t response_offset
338 );
339 
344 (
345  iuif_t inputFile,
346  char *label,
347  iud_t frame,
348  iuo_t frame_offset
349 );
350 
355 (
356  iuif_t inputFile,
357  char *label,
358  iud_t frame,
359  iuo_t frame_offset
360 );
361 
362 
363 #endif //IUFLIBRARY_IUFHLINPUTFILE_H
Definition: iufData.c:7
int iufInputFileNodeSave(iuif_t inputFile)
Save (serialize) the inputFile instance to file.
Definition: iufInputFile.c:405
int iufInputFileSetReceiveSettingsDict(iuif_t inputFile, iursd_t receiveSettingsDict)
Sets the receiveSettingsDict of an inputFile.
Definition: iufInputFile.c:649
int iufInputFileFrameLoad(iuif_t inputFile, char *label, iud_t frame, iuo_t frame_offset)
Loads a frame of data to an inputFile.
Definition: iufInputFile.c:941
iud_t iufInputFileFrameCreate(iuif_t inputFile, char *label)
Creates a datablock for a frame for the acquisition with the name label.
Definition: iufInputFile.c:217
iuif_t iufInputFileNodeLoad(const char *pFilename)
Load an inputFile instance from a file.
Definition: iufInputFile.c:356
int iufInputFileChannelLoad(iuif_t inputFile, char *label, iud_t channel, iuo_t channel_offset)
Loads a single channel of data from an inputFile.
Definition: iufInputFile.c:1048
int iufInputFileChannelSave(iuif_t inputFile, char *label, iud_t channel, iuo_t channel_offset)
Saves a channel of data to an inputFile.
Definition: iufInputFile.c:889
int iufInputFileSetFrameList(iuif_t inputFile, iufl_t frameList)
Sets the frameList of an inputFile.
Definition: iufInputFile.c:569
int iufInputFileSetPulseDict(iuif_t inputFile, iupd_t pulseDict)
Sets the pulseDict of an inputFile.
Definition: iufInputFile.c:595
int iufInputFileClose(iuif_t inputFile)
Closes access to the inputFile.
Definition: iufInputFile.c:418
int iufInputFileSetSourceDict(iuif_t inputFile, iusd_t sourceDict)
Sets the sourceDict of an inputFile.
Definition: iufInputFile.c:610
Definition: iufHistoryNodeADT.h:4
iupd_t iufInputFileGetPulseDict(iuif_t inputFile)
Gets the IufPulseDict object from an inputFile.
Definition: iufInputFile.c:495
iusd_t iufInputFileGetSourceDict(iuif_t inputFile)
Gets the IufSourceDict object from an inputFile.
Definition: iufInputFile.c:505
Definition: iufReceiveSettingsDictADT.h:15
Definition: iufPulseDict.c:21
int iufInputFileSetTransducer(iuif_t inputFile, iut_t transducer)
Sets the transducer of an inputFile.
Definition: iufInputFile.c:677
int iufInputFileSetTransmitApodizationDict(iuif_t inputFile, iutad_t transmitApodizationDict)
Sets the transmitApodizationDict of an inputFile.
Definition: iufInputFile.c:636
int iufInputFileResponseLoad(iuif_t inputFile, char *label, iud_t response, iuo_t response_offset)
Loads a single response of data from an inputFile.
Definition: iufInputFile.c:995
Definition: iufTransmitApodizationDictADT.h:16
iut_t iufInputFileGetTransducer(iuif_t inputFile)
Gets the IufTransducer object from an inputFile.
Definition: iufInputFile.c:556
int iufInputFileGetSamplesPerLine(iuif_t inputFile, char *label)
Gets the number of samples per line for this label.
Definition: iufInputFile.c:168
int iufInputFileGetNumChannels(iuif_t inputFile, char *label)
Gets the number of channels for the patternList type label.
Definition: iufInputFile.c:152
iutad_t iufInputFileGetTransmitApodizationDict(iuif_t inputFile)
Gets the IufTransmitApodizationDict object from an inputFile.
Definition: iufInputFile.c:526
int iufInputFileSetPatternListDict(iuif_t inputFile, iupald_t patternListDict)
Sets the patternListDict of an inputFile.
Definition: iufInputFile.c:582
Definition: iufFrameList.c:9
int iufInputFileSetAcquisition(iuif_t inputFile, iua_t acquisition)
Sets the acquisition info of an inputFile.
Definition: iufInputFile.c:663
iua_t iufInputFileGetAcquisition(iuif_t inputFile)
Gets the IufAcquisition object from an inputFile.
Definition: iufInputFile.c:546
Definition: iufReceiveChannelMapDictADT.h:16
iufl_t iufInputFileGetFrameList(iuif_t inputFile)
Gets the IufFrameList object from an inputFile.
Definition: iufInputFile.c:474
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
IufInputFile * iuif_t
Definition: iufInputFile.h:22
iud_t iufInputFileChannelCreate(iuif_t inputFile, char *label)
Creates a datablock for a single channel (i.e. numSamplesPerLine floats) for the acquisition with the...
Definition: iufInputFile.c:248
int iufInputFileResponseSave(iuif_t inputFile, char *label, iud_t response, iuo_t response_offset)
Saves a channel of data to an inputFile.
Definition: iufInputFile.c:838
iuif_t iufInputFileCreate(const char *filename)
Create an empty file instance with a filename.
Definition: iufInputFile.c:114
iud_t iufInputFileResponseCreate(iuif_t inputFile, char *label)
Creates a datablock for a response (numSamplesPerLine * numChannels) for the acquisition with the nam...
Definition: iufInputFile.c:234
int iufInputFileDelete(iuif_t inputFile)
Creates a datablock for a single channel (i.e. numSamplesPerLine floats) for the acquisition with the...
Definition: iufInputFile.c:102
iupald_t iufInputFileGetPatternListDict(iuif_t inputFile)
Gets the IufPatternListDict object from an inputFile.
Definition: iufInputFile.c:484
Definition: iufInputFile.c:43
int iufInputFileGetNumResponses(iuif_t inputFile, char *label)
Gets the number of responses for the patternList type label.
Definition: iufInputFile.c:192
Definition: iufTransducerADT.h:4
int iufInputFileSetReceiveChannelMapDict(iuif_t inputFile, iurcmd_t receiveChannelMapDict)
Sets the receiveChannelMap of an inputFile.
Definition: iufInputFile.c:623
int iufInputFileFrameSave(iuif_t inputFile, char *label, iud_t frame, iuo_t frame_offset)
Saves a frame of data to an inputFile.
Definition: iufInputFile.c:784
int iufInputFileGetNumFrames(iuif_t inputFile)
Returns the number of frames an inputFile has.
Definition: iufInputFile.c:141
Definition: iufOffset.h:6
iurcmd_t iufInputFileGetReceiveChannelMapDict(iuif_t inputFile)
Gets the IufReceiveChannelMapDict object from an inputFile.
Definition: iufInputFile.c:516
iursd_t iufInputFileGetReceiveSettingsDict(iuif_t inputFile)
Gets the IufReceiveSettingsDict object from an inputFile.
Definition: iufInputFile.c:536
Definition: iufPatternListDictADT.h:16
int iufInputFileCompare(iuif_t reference, iuif_t actual)
Compares two inputFile instances with each other.
Definition: iufInputFile.c:455