IUF-SDK-3
Interventional Ultrasound Library
iuf2DTransducer.h
Go to the documentation of this file.
1 #ifndef IUFLIBRARY_IUFHL2DTRANSDUCER_H
2 #define IUFLIBRARY_IUFHL2DTRANSDUCER_H
3 
4 #include <iuf2DTransducerElement.h>
5 
6 // ADT
7 typedef struct Iuf2DTransducer Iuf2DTransducer;
8 
13 typedef Iuf2DTransducer *iu2dt_t;
14 #define IU2DT_INVALID (iu2dt_t) NULL
15 
19 iu2dt_t iuf2DTransducerCreate
20 (
21  char *name,
22  IufTransducerShape shape,
23  float centerFrequency,
24  int numElements
25 );
26 
27 
28 int iuf2DTransducerDelete
29 (
30  iu2dt_t transducer
31 );
32 
33 //todo: move this to private
34 int iuf2DTransducerDeepDelete
35 (
36  iu2dt_t transducer
37 );
38 
42 int iuf2DTransducerCompare
43 (
44  iu2dt_t reference,
45  iu2dt_t actual
46 );
47 
51 iu2dte_t iuf2DTransducerGetElement
52 (
53  iu2dt_t transducer,
54  int index
55 );
56 
60 int iuf2DTransducerGetNumElements
61 (
62  iu2dt_t transducer
63 );
64 
68 int iuf2DTransducerSetElement(
69  iu2dt_t transducer,
70  int index,
71  iu2dte_t element
72 );
73 
74 #endif //IUFLIBRARY_IUFHL2DTRANSDUCER_H
IufTransducerShape
IufTransducerShape
Definition: iufTypes.h:106
iuf2DTransducerGetElement
iu2dte_t iuf2DTransducerGetElement(iu2dt_t transducer, int index)
Return the elemntIndex -th transducer element from the transducer&#39;s element list. /return the request...
Definition: iuf2DTransducer.c:90
iuf2DTransducerCreate
iu2dt_t iuf2DTransducerCreate(char *name, IufTransducerShape shape, float centerFrequency, int numElements)
Constructs the 2D transducer.
Definition: iuf2DTransducer.c:14
iuf2DTransducerDeepDelete
int iuf2DTransducerDeepDelete(iu2dt_t transducer)
Definition: iuf2DTransducer.c:42
iuf2DTransducerGetNumElements
int iuf2DTransducerGetNumElements(iu2dt_t transducer)
Gets the length of the transducer&#39;s element list. /return the size of the element list...
Definition: iuf2DTransducer.c:100
iuf2DTransducerDelete
int iuf2DTransducerDelete(iu2dt_t transducer)
Definition: iuf2DTransducer.c:52
iu2dt_t
Iuf2DTransducer * iu2dt_t
A 2D transducer is described by a name, 2D shape, centerfrequency and a list of elements. A transducer is created first by specifying these parameters with a call to iuf2DTransducerCreate(), followed by setting each of the elements using calls to iuf2DTransducerSetElement()
Definition: iuf2DTransducer.h:13
Iuf2DTransducerElement
Definition: iuf2DTransducerElementPrivate.h:8
iuf2DTransducerSetElement
int iuf2DTransducerSetElement(iu2dt_t transducer, int index, iu2dte_t element)
Set a element in the transducer&#39;s element list at position elementIndex /return IUF_ERR_VALUE is case...
Definition: iuf2DTransducer.c:136
Iuf2DTransducer
Definition: iuf2DTransducerADT.h:7
iuf2DTransducerCompare
int iuf2DTransducerCompare(iu2dt_t reference, iu2dt_t actual)
Comparing two transducers, return IUF_TRUE if they are equal and IUF_FALSE if they differ or in case ...
Definition: iuf2DTransducer.c:77