Medical Imaging Interaction Toolkit  2023.04.00
Medical Imaging Interaction Toolkit
Public Member Functions | Static 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:
Inheritance graph
[legend]
Collaboration diagram for mitk::USImageMetadata:
Collaboration graph
[legend]

Public Member Functions

 mitkClassMacroItkParent (USImageMetadata, itk::Object)
 
Pointer Clone () const
 
virtual std::string GetDeviceManufacturer ()
 
virtual void SetDeviceManufacturer (std::string _arg)
 
virtual std::string GetDeviceModel ()
 
virtual void SetDeviceModel (std::string _arg)
 
virtual std::string GetDeviceComment ()
 
virtual void SetDeviceComment (std::string _arg)
 
virtual std::string GetProbeName ()
 
virtual void SetProbeName (std::string _arg)
 
virtual std::string GetProbeFrequency ()
 
virtual void SetProbeFrequency (std::string _arg)
 
virtual std::string GetZoom ()
 
virtual void SetZoom (std::string _arg)
 
virtual bool GetDeviceIsVideoOnly ()
 
virtual void SetDeviceIsVideoOnly (bool _arg)
 
virtual bool GetDeviceIsCalibrated ()
 
virtual void SetDeviceIsCalibrated (bool _arg)
 
virtual std::string GetDeviceClass ()
 
virtual void SetDeviceClass (std::string _arg)
 

Static Public Member Functions

static Pointer New ()
 

Static Public Attributes

static const char * PROP_DEV_MANUFACTURER
 
static const char * PROP_DEV_MODEL
 
static const char * PROP_DEV_COMMENT
 
static const char * PROP_DEV_ISVIDEOONLY
 
static const char * PROP_DEV_ISCALIBRATED
 
static const char * PROP_PROBE_NAME
 
static const char * PROP_PROBE_FREQUENCY
 
static const char * PROP_ZOOM
 
static const char * PROP_DEVICE_CLASS
 

Protected Member Functions

 USImageMetadata ()
 Creates a new metadata object with all fields set to default values. More...
 
 ~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.

◆ ~USImageMetadata()

mitk::USImageMetadata::~USImageMetadata ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::USImageMetadata::Clone ( ) const

◆ GetDeviceClass()

virtual std::string mitk::USImageMetadata::GetDeviceClass ( )
virtual

◆ GetDeviceComment()

virtual std::string mitk::USImageMetadata::GetDeviceComment ( )
virtual

◆ GetDeviceIsCalibrated()

virtual bool mitk::USImageMetadata::GetDeviceIsCalibrated ( )
virtual

◆ GetDeviceIsVideoOnly()

virtual bool mitk::USImageMetadata::GetDeviceIsVideoOnly ( )
virtual

◆ GetDeviceManufacturer()

virtual std::string mitk::USImageMetadata::GetDeviceManufacturer ( )
virtual

◆ GetDeviceModel()

virtual std::string mitk::USImageMetadata::GetDeviceModel ( )
virtual

◆ GetProbeFrequency()

virtual std::string mitk::USImageMetadata::GetProbeFrequency ( )
virtual

◆ GetProbeName()

virtual std::string mitk::USImageMetadata::GetProbeName ( )
virtual

◆ GetZoom()

virtual std::string mitk::USImageMetadata::GetZoom ( )
virtual

◆ mitkClassMacroItkParent()

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

◆ New()

static Pointer mitk::USImageMetadata::New ( )
static

◆ SetDeviceClass()

virtual void mitk::USImageMetadata::SetDeviceClass ( std::string  _arg)
virtual

◆ SetDeviceComment()

virtual void mitk::USImageMetadata::SetDeviceComment ( std::string  _arg)
virtual

◆ SetDeviceIsCalibrated()

virtual void mitk::USImageMetadata::SetDeviceIsCalibrated ( bool  _arg)
virtual

◆ SetDeviceIsVideoOnly()

virtual void mitk::USImageMetadata::SetDeviceIsVideoOnly ( bool  _arg)
virtual

◆ SetDeviceManufacturer()

virtual void mitk::USImageMetadata::SetDeviceManufacturer ( std::string  _arg)
virtual

◆ SetDeviceModel()

virtual void mitk::USImageMetadata::SetDeviceModel ( std::string  _arg)
virtual

◆ SetProbeFrequency()

virtual void mitk::USImageMetadata::SetProbeFrequency ( std::string  _arg)
virtual

◆ SetProbeName()

virtual void mitk::USImageMetadata::SetProbeName ( std::string  _arg)
virtual

◆ SetZoom()

virtual void mitk::USImageMetadata::SetZoom ( std::string  _arg)
virtual

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
static

Definition at line 60 of file mitkUSImageMetadata.h.

◆ PROP_DEV_ISCALIBRATED

const char* mitk::USImageMetadata::PROP_DEV_ISCALIBRATED
static

Definition at line 62 of file mitkUSImageMetadata.h.

◆ PROP_DEV_ISVIDEOONLY

const char* mitk::USImageMetadata::PROP_DEV_ISVIDEOONLY
static

Definition at line 61 of file mitkUSImageMetadata.h.

◆ PROP_DEV_MANUFACTURER

const char* mitk::USImageMetadata::PROP_DEV_MANUFACTURER
static

Definition at line 53 of file mitkUSImageMetadata.h.

◆ PROP_DEV_MODEL

const char* mitk::USImageMetadata::PROP_DEV_MODEL
static

Definition at line 59 of file mitkUSImageMetadata.h.

◆ PROP_DEVICE_CLASS

const char* mitk::USImageMetadata::PROP_DEVICE_CLASS
static

Definition at line 66 of file mitkUSImageMetadata.h.

◆ PROP_PROBE_FREQUENCY

const char* mitk::USImageMetadata::PROP_PROBE_FREQUENCY
static

Definition at line 64 of file mitkUSImageMetadata.h.

◆ PROP_PROBE_NAME

const char* mitk::USImageMetadata::PROP_PROBE_NAME
static

Definition at line 63 of file mitkUSImageMetadata.h.

◆ PROP_ZOOM

const char* mitk::USImageMetadata::PROP_ZOOM
static

Definition at line 65 of file mitkUSImageMetadata.h.

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