UsTK : Ultrasound ToolKit  version 2.0.1 under development (2023-12-07)
us.h
1 /****************************************************************************
2  *
3  * This file is part of the ustk software.
4  * Copyright (C) 2016 - 2017 by Inria. All rights reserved.
5  *
6  * This software is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * ("GPL") version 2 as published by the Free Software Foundation.
9  * See the file LICENSE.txt at the root directory of this source
10  * distribution for additional information about the GNU GPL.
11  *
12  * For using ustk with software that can not be combined with the GNU
13  * GPL, please contact Inria about acquiring a ViSP Professional
14  * Edition License.
15  *
16  * This software was developed at:
17  * Inria Rennes - Bretagne Atlantique
18  * Campus Universitaire de Beaulieu
19  * 35042 Rennes Cedex
20  * France
21  *
22  * If you have questions regarding the use of this file, please contact
23  * Inria at ustk@inria.fr
24  *
25  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
26  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
27  *
28  * Authors:
29  * Marc Pouliquen
30  *
31  *****************************************************************************/
32 
38 #ifndef __us_h_
39 #define __us_h_
40 
41 #include <visp3/core/vpConfig.h>
42 
43 // includes for uint64 type
44 #if defined(VISP_HAVE_CPP11_COMPATIBILITY) // CPP 11
45 #include <cstdint>
46 #else
47 #include <stdint.h>
48 #endif
49 
50 #include <visp3/core/vpIoTools.h>
51 
52 #include <visp3/ustk_core/usImagePreScanSettings.h>
53 #include <visp3/ustk_core/usMotorSettings.h>
54 
60 namespace us
61 {
62 
65 typedef enum {
66  UNKNOWN = -1,
74 } ImageType;
75 
79 struct usImageHeader {
80  usImageHeader() : headerId(2) {} // set header Id to 2 by default
81  int headerId;
84  uint32_t frameCount;
85  uint64_t timeStamp;
87  double dataRate;
89  int dataLength;
90  int ss;
92  int imageType;
94  int frameWidth;
97  double pixelWidth;
98  double pixelHeight;
108  double scanLinePitch;
109  unsigned int scanLineNumber;
112 
117  double anglePerFr;
119  double motorRadius;
120  int motorType;
122 };
123 VISP_EXPORT std::string getDataSetPath();
124 };
125 
126 #endif // __us_h_
General tools.
ImageType
Definition: us.h:65
@ PRESCAN_2D
Definition: us.h:70
@ UNKNOWN
Definition: us.h:66
@ POSTSCAN_2D
Definition: us.h:72
@ RF_2D
Definition: us.h:68
@ PRESCAN_3D
Definition: us.h:71
@ NOT_SET
Definition: us.h:67
@ POSTSCAN_3D
Definition: us.h:73
@ RF_3D
Definition: us.h:69
VISP_EXPORT std::string getDataSetPath()
Definition: us.cpp:54
int motorType
Definition: us.h:120
double anglePerFr
Definition: us.h:117
int dataLength
Definition: us.h:89
int frameWidth
Definition: us.h:94
double dataRate
Definition: us.h:87
unsigned int scanLineNumber
Definition: us.h:109
int imageDepth
Definition: us.h:110
usImageHeader()
Definition: us.h:80
uint32_t frameCount
Definition: us.h:84
int samplingFrequency
Definition: us.h:101
int framesPerVolume
Definition: us.h:118
double pixelHeight
Definition: us.h:98
double motorRadius
Definition: us.h:119
int transmitFrequency
Definition: us.h:100
int frameHeight
Definition: us.h:95
int imageType
Definition: us.h:92
double pixelWidth
Definition: us.h:97
int headerId
Definition: us.h:81
uint64_t timeStamp
Definition: us.h:85
double transducerRadius
Definition: us.h:107
double scanLinePitch
Definition: us.h:108