Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
mitkUSImageMetadata.h
Go to the documentation of this file.
1 /*===================================================================
2 
3 The Medical Imaging Interaction Toolkit (MITK)
4 
5 Copyright (c) German Cancer Research Center,
6 Division of Medical and Biological Informatics.
7 All rights reserved.
8 
9 This software is distributed WITHOUT ANY WARRANTY; without
10 even the implied warranty of MERCHANTABILITY or FITNESS FOR
11 A PARTICULAR PURPOSE.
12 
13 See LICENSE.txt or http://www.mitk.org for details.
14 
15 ===================================================================*/
16 
17 #ifndef MITKUSIMAGEMETADATA_H_HEADER_INCLUDED_
18 #define MITKUSIMAGEMETADATA_H_HEADER_INCLUDED_
19 
20 #include <MitkUSExports.h>
21 #include <mitkCommon.h>
22 #include <itkObject.h>
23 #include <itkObjectFactory.h>
24 
25 namespace mitk {
32  class MITKUS_EXPORT USImageMetadata : public itk::Object
33  {
34  public:
36  itkFactorylessNewMacro(Self)
37  itkCloneMacro(Self)
38 
39  //## getter and setter ##
40  itkGetMacro(DeviceManufacturer, std::string);
41  itkSetMacro(DeviceManufacturer, std::string);
42  itkGetMacro(DeviceModel, std::string);
43  itkSetMacro(DeviceModel, std::string);
44  itkGetMacro(DeviceComment, std::string);
45  itkSetMacro(DeviceComment, std::string);
46  itkGetMacro(ProbeName, std::string);
47  itkSetMacro(ProbeName, std::string);
48  itkGetMacro(ProbeFrequency, std::string);
49  itkSetMacro(ProbeFrequency, std::string);
50  itkGetMacro(Zoom, std::string);
51  itkSetMacro(Zoom, std::string);
52  itkGetMacro(DeviceIsVideoOnly, bool);
53  itkSetMacro(DeviceIsVideoOnly, bool);
54  itkGetMacro(DeviceIsCalibrated, bool);
55  itkSetMacro(DeviceIsCalibrated, bool);
56  itkGetMacro(DeviceClass, std::string);
57  itkSetMacro(DeviceClass, std::string);
58 
59  // The following constants define how metadata is written to and read from an mitk image
60  // when defining new properties, add them here, define them in the cpp, and add them to
61  // USImage's getMetadata and setMetadata methods as well
62  static const char* PROP_DEV_MANUFACTURER;
63  static const char* PROP_DEV_MODEL;
64  static const char* PROP_DEV_COMMENT;
65  static const char* PROP_DEV_ISVIDEOONLY;
66  static const char* PROP_DEV_ISCALIBRATED;
67  static const char* PROP_PROBE_NAME;
68  static const char* PROP_PROBE_FREQUENCY;
69  static const char* PROP_ZOOM;
70  static const char* PROP_DEVICE_CLASS;
71 
72  protected:
77  virtual ~USImageMetadata();
78 
79  std::string m_DeviceManufacturer;
80  std::string m_DeviceModel;
81  std::string m_DeviceComment;
82  std::string m_ProbeName;
83  std::string m_ProbeFrequency;
84  std::string m_Zoom;
85  std::string m_DeviceClass;
88  };
89 } // namespace mitk
90 #endif
static const char * PROP_DEV_MODEL
static const char * PROP_DEVICE_CLASS
DataCollection - Class to facilitate loading/accessing structured data.
This class encapsulates all necessary metadata to describe a US Image.
static const char * PROP_PROBE_FREQUENCY
#define mitkClassMacroItkParent(className, SuperClassName)
Definition: mitkCommon.h:53
static const char * PROP_PROBE_NAME
static const char * PROP_DEV_ISVIDEOONLY
static const char * PROP_DEV_ISCALIBRATED
static const char * PROP_DEV_COMMENT
static const char * PROP_DEV_MANUFACTURER
static const char * PROP_ZOOM