This specialization of mitk::Image only appends necessary Metadata to an MITK image. Otherwise it can safely be treated like it's mother class. To generate an USImage from a standard mitkImage, call the appropriate constructor USImage(image::Pointer) More...

#include <mitkUSImage.h>

Inheritance diagram for mitk::USImage:

Public Member Functions
	mitkClassMacro (USImage, mitk::Image)

	itkFactorylessNewMacro (Self)

	itkCloneMacro (Self) mitkNewMacro1Param(Self
	this constructor creates an US Image identical to the recieved mitkImage. The Metadata are set to default. The image data is shared, so don't continue to manipulate the original image.

mitk::USImageMetadata::Pointer	GetMetadata () const
	Reads out this image's Metadata set from the properties and returns a corresponding USImageMetadata object.

void	SetMetadata (mitk::USImageMetadata::Pointer metadata)
	Writes the information of the metadata object into the image's properties.

Protected Member Functions
	USImage ()
	This constructor creates an empty USImage. The Metadata are set to default.

	USImage (mitk::Image::Pointer image)
	this constructor creates an US Image identical to the recieved mitkImage. The Metadata are set to default. The image data is shared, so don't continue to manipulate the original image.

	~USImage () override

Detailed Description

This specialization of mitk::Image only appends necessary Metadata to an MITK image. Otherwise it can safely be treated like it's mother class. To generate an USImage from a standard mitkImage, call the appropriate constructor USImage(image::Pointer)

DocumentationZ

Deprecated: Deprecated since 2014-06 -> use mitk::Image instead

Definition at line 31 of file mitkUSImage.h.

Constructor & Destructor Documentation

◆ USImage() [1/2]

mitk::USImage::USImage ( )

protected

This constructor creates an empty USImage. The Metadata are set to default.

Definition at line 19 of file mitkUSImage.cpp.

◆ USImage() [2/2]

mitk::USImage::USImage ( mitk::Image::Pointer image )

protected

this constructor creates an US Image identical to the recieved mitkImage. The Metadata are set to default. The image data is shared, so don't continue to manipulate the original image.

Definition at line 24 of file mitkUSImage.cpp.

◆ ~USImage()

mitk::USImage::~USImage ( )

overrideprotected

Definition at line 38 of file mitkUSImage.cpp.

Member Function Documentation

◆ GetMetadata()

mitk::USImageMetadata::Pointer mitk::USImage::GetMetadata ( ) const

Reads out this image's Metadata set from the properties and returns a corresponding USImageMetadata object.

Definition at line 43 of file mitkUSImage.cpp.

◆ itkCloneMacro()

mitk::USImage::itkCloneMacro ( Self )

this constructor creates an US Image identical to the recieved mitkImage. The Metadata are set to default. The image data is shared, so don't continue to manipulate the original image.

Exceptions

mitk::Exception Throws an exception if there is a problem with access to the data while constructing the image.

◆ itkFactorylessNewMacro()

mitk::USImage::itkFactorylessNewMacro ( Self )

◆ mitkClassMacro()

mitk::USImage::mitkClassMacro	(	USImage	,
		mitk::Image	)

◆ SetMetadata()

void mitk::USImage::SetMetadata ( mitk::USImageMetadata::Pointer metadata )

Writes the information of the metadata object into the image's properties.

Definition at line 59 of file mitkUSImage.cpp.

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

Modules/US/USModel/mitkUSImage.h
Modules/US/USModel/mitkUSImage.cpp

Public Member Functions

Protected Member Functions