MITK-IGT
IGT Extension of MITK
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
mitk::USImageMetadata Class Reference

This class encapsulates all necessary metadata to describe a US Image. More...

#include <mitkUSImageMetadata.h>

Inheritance diagram for mitk::USImageMetadata:

Public Member Functions

 mitkClassMacroItkParent (USImageMetadata, itk::Object)
 
 itkFactorylessNewMacro (Self)
 
 itkCloneMacro (Self)
 
 itkGetMacro (DeviceManufacturer, std::string)
 
 itkSetMacro (DeviceManufacturer, std::string)
 
 itkGetMacro (DeviceModel, std::string)
 
 itkSetMacro (DeviceModel, std::string)
 
 itkGetMacro (DeviceComment, std::string)
 
 itkSetMacro (DeviceComment, std::string)
 
 itkGetMacro (ProbeName, std::string)
 
 itkSetMacro (ProbeName, std::string)
 
 itkGetMacro (ProbeFrequency, std::string)
 
 itkSetMacro (ProbeFrequency, std::string)
 
 itkGetMacro (Zoom, std::string)
 
 itkSetMacro (Zoom, std::string)
 
 itkGetMacro (DeviceIsVideoOnly, bool)
 
 itkSetMacro (DeviceIsVideoOnly, bool)
 
 itkGetMacro (DeviceIsCalibrated, bool)
 
 itkSetMacro (DeviceIsCalibrated, bool)
 
 itkGetMacro (DeviceClass, std::string)
 
 itkSetMacro (DeviceClass, std::string)
 

Static Public Attributes

static const char * PROP_DEV_MANUFACTURER = "US.Device.Manufacturer"
 
static const char * PROP_DEV_MODEL = "US.Device.Model"
 
static const char * PROP_DEV_COMMENT = "US.Device.Comment"
 
static const char * PROP_DEV_ISVIDEOONLY = "US.Device.VideoOnly"
 
static const char * PROP_DEV_ISCALIBRATED = "US.Device.IsCalibrated"
 
static const char * PROP_PROBE_NAME = "US.Probe.Name"
 
static const char * PROP_PROBE_FREQUENCY = "US.Probe.Frequency"
 
static const char * PROP_ZOOM = "US.Zoom.Factor"
 
static const char * PROP_DEVICE_CLASS = "org.mitk.modules.us.USVideoDevice"
 

Protected Member Functions

 USImageMetadata ()
 Creates a new metadata object with all fields set to default values.
 
 ~USImageMetadata () override
 

Protected Attributes

std::string m_DeviceManufacturer
 
std::string m_DeviceModel
 
std::string m_DeviceComment
 
std::string m_ProbeName
 
std::string m_ProbeFrequency
 
std::string m_Zoom
 
std::string m_DeviceClass
 
bool m_DeviceIsVideoOnly
 
bool m_DeviceIsCalibrated
 

Detailed Description

This class encapsulates all necessary metadata to describe a US Image.

Documentation

Deprecated
Deprecated since 2014-06

Definition at line 28 of file mitkUSImageMetadata.h.

Constructor & Destructor Documentation

◆ USImageMetadata()

mitk::USImageMetadata::USImageMetadata ( )
protected

Creates a new metadata object with all fields set to default values.

Definition at line 25 of file mitkUSImageMetadata.cpp.

◆ ~USImageMetadata()

mitk::USImageMetadata::~USImageMetadata ( )
overrideprotected

Definition at line 38 of file mitkUSImageMetadata.cpp.

Member Function Documentation

◆ itkCloneMacro()

mitk::USImageMetadata::itkCloneMacro ( Self )

◆ itkFactorylessNewMacro()

mitk::USImageMetadata::itkFactorylessNewMacro ( Self )

◆ itkGetMacro() [1/9]

mitk::USImageMetadata::itkGetMacro ( DeviceClass ,
std::string  )

◆ itkGetMacro() [2/9]

mitk::USImageMetadata::itkGetMacro ( DeviceComment ,
std::string  )

◆ itkGetMacro() [3/9]

mitk::USImageMetadata::itkGetMacro ( DeviceIsCalibrated ,
bool  )

◆ itkGetMacro() [4/9]

mitk::USImageMetadata::itkGetMacro ( DeviceIsVideoOnly ,
bool  )

◆ itkGetMacro() [5/9]

mitk::USImageMetadata::itkGetMacro ( DeviceManufacturer ,
std::string  )

◆ itkGetMacro() [6/9]

mitk::USImageMetadata::itkGetMacro ( DeviceModel ,
std::string  )

◆ itkGetMacro() [7/9]

mitk::USImageMetadata::itkGetMacro ( ProbeFrequency ,
std::string  )

◆ itkGetMacro() [8/9]

mitk::USImageMetadata::itkGetMacro ( ProbeName ,
std::string  )

◆ itkGetMacro() [9/9]

mitk::USImageMetadata::itkGetMacro ( Zoom ,
std::string  )

◆ itkSetMacro() [1/9]

mitk::USImageMetadata::itkSetMacro ( DeviceClass ,
std::string  )

◆ itkSetMacro() [2/9]

mitk::USImageMetadata::itkSetMacro ( DeviceComment ,
std::string  )

◆ itkSetMacro() [3/9]

mitk::USImageMetadata::itkSetMacro ( DeviceIsCalibrated ,
bool  )

◆ itkSetMacro() [4/9]

mitk::USImageMetadata::itkSetMacro ( DeviceIsVideoOnly ,
bool  )

◆ itkSetMacro() [5/9]

mitk::USImageMetadata::itkSetMacro ( DeviceManufacturer ,
std::string  )

◆ itkSetMacro() [6/9]

mitk::USImageMetadata::itkSetMacro ( DeviceModel ,
std::string  )

◆ itkSetMacro() [7/9]

mitk::USImageMetadata::itkSetMacro ( ProbeFrequency ,
std::string  )

◆ itkSetMacro() [8/9]

mitk::USImageMetadata::itkSetMacro ( ProbeName ,
std::string  )

◆ itkSetMacro() [9/9]

mitk::USImageMetadata::itkSetMacro ( Zoom ,
std::string  )

◆ mitkClassMacroItkParent()

mitk::USImageMetadata::mitkClassMacroItkParent ( USImageMetadata ,
itk::Object  )

Member Data Documentation

◆ m_DeviceClass

std::string mitk::USImageMetadata::m_DeviceClass
protected

Definition at line 81 of file mitkUSImageMetadata.h.

◆ m_DeviceComment

std::string mitk::USImageMetadata::m_DeviceComment
protected

Definition at line 77 of file mitkUSImageMetadata.h.

◆ m_DeviceIsCalibrated

bool mitk::USImageMetadata::m_DeviceIsCalibrated
protected

Definition at line 83 of file mitkUSImageMetadata.h.

◆ m_DeviceIsVideoOnly

bool mitk::USImageMetadata::m_DeviceIsVideoOnly
protected

Definition at line 82 of file mitkUSImageMetadata.h.

◆ m_DeviceManufacturer

std::string mitk::USImageMetadata::m_DeviceManufacturer
protected

Definition at line 75 of file mitkUSImageMetadata.h.

◆ m_DeviceModel

std::string mitk::USImageMetadata::m_DeviceModel
protected

Definition at line 76 of file mitkUSImageMetadata.h.

◆ m_ProbeFrequency

std::string mitk::USImageMetadata::m_ProbeFrequency
protected

Definition at line 79 of file mitkUSImageMetadata.h.

◆ m_ProbeName

std::string mitk::USImageMetadata::m_ProbeName
protected

Definition at line 78 of file mitkUSImageMetadata.h.

◆ m_Zoom

std::string mitk::USImageMetadata::m_Zoom
protected

Definition at line 80 of file mitkUSImageMetadata.h.

◆ PROP_DEV_COMMENT

const char * mitk::USImageMetadata::PROP_DEV_COMMENT = "US.Device.Comment"
static

Definition at line 60 of file mitkUSImageMetadata.h.

◆ PROP_DEV_ISCALIBRATED

const char * mitk::USImageMetadata::PROP_DEV_ISCALIBRATED = "US.Device.IsCalibrated"
static

Definition at line 62 of file mitkUSImageMetadata.h.

◆ PROP_DEV_ISVIDEOONLY

const char * mitk::USImageMetadata::PROP_DEV_ISVIDEOONLY = "US.Device.VideoOnly"
static

Definition at line 61 of file mitkUSImageMetadata.h.

◆ PROP_DEV_MANUFACTURER

const char * mitk::USImageMetadata::PROP_DEV_MANUFACTURER = "US.Device.Manufacturer"
static

Definition at line 58 of file mitkUSImageMetadata.h.

◆ PROP_DEV_MODEL

const char * mitk::USImageMetadata::PROP_DEV_MODEL = "US.Device.Model"
static

Definition at line 59 of file mitkUSImageMetadata.h.

◆ PROP_DEVICE_CLASS

const char * mitk::USImageMetadata::PROP_DEVICE_CLASS = "org.mitk.modules.us.USVideoDevice"
static

Definition at line 66 of file mitkUSImageMetadata.h.

◆ PROP_PROBE_FREQUENCY

const char * mitk::USImageMetadata::PROP_PROBE_FREQUENCY = "US.Probe.Frequency"
static

Definition at line 64 of file mitkUSImageMetadata.h.

◆ PROP_PROBE_NAME

const char * mitk::USImageMetadata::PROP_PROBE_NAME = "US.Probe.Name"
static

Definition at line 63 of file mitkUSImageMetadata.h.

◆ PROP_ZOOM

const char * mitk::USImageMetadata::PROP_ZOOM = "US.Zoom.Factor"
static

Definition at line 65 of file mitkUSImageMetadata.h.

The documentation for this class was generated from the following files: