Medical Imaging Interaction Toolkit  2023.12.00
Medical Imaging Interaction Toolkit
mitk::USTelemedImageSource Class Reference

Implementation of mitk::USImageSource for Telemed API devices. The method mitk::USImageSource::GetNextRawImage() is implemented for getting images from the Telemed API. More...

#include <mitkUSTelemedImageSource.h>

Inheritance diagram for mitk::USTelemedImageSource:
Collaboration diagram for mitk::USTelemedImageSource:

Public Member Functions

 mitkClassMacro (USTelemedImageSource, USImageSource)
 
Pointer Clone () const
 
virtual void GetNextRawImage (std::vector< mitk::Image::Pointer > &)
 
void UpdateImageGeometry ()
 
bool CreateAndConnectConverterPlugin (Usgfw2Lib::IUsgDataView *, Usgfw2Lib::tagScanMode)
 Connect this object to the Telemed API. This method is for being used by mitk::USTelemedDevice. More...
 
- Public Member Functions inherited from mitk::USImageSource
 mitkClassMacroItkParent (USImageSource, itk::Object)
 
virtual mitk::BasicCombinationOpenCVImageFilter::Pointer GetImageFilter ()
 
void PushFilter (AbstractOpenCVImageFilter::Pointer filter)
 
bool RemoveFilter (AbstractOpenCVImageFilter::Pointer filter)
 
bool GetIsFilterInThePipeline (AbstractOpenCVImageFilter::Pointer filter)
 
std::vector< mitk::Image::PointerGetNextImage ()
 Retrieves the next frame. This will typically be the next frame in a file or the last cached file in a device. The image is filtered if a filter was set by mitk::USImageSource::SetImageFilter(). More...
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 USTelemedImageSource ()
 
virtual ~USTelemedImageSource ()
 
- Protected Member Functions inherited from mitk::USImageSource
 USImageSource ()
 
 ~USImageSource () override
 
virtual void GetNextRawImage (std::vector< cv::Mat > &)
 Set the given OpenCV image matrix to the next image received from the device or file. More...
 

Protected Attributes

Usgfw2Lib::IUsgScanConverterPlugin * m_Plugin
 
USTelemedScanConverterPluginm_PluginCallback
 
Usgfw2Lib::IUsgDataView * m_UsgDataView
 
Usgfw2Lib::IUsgImageProperties * m_ImageProperties
 
Usgfw2Lib::IUsgDepth * m_DepthProperties
 
long m_OldnXPelsPerUnit
 
long m_OldnYPelsPerUnit
 
mitk::Image::Pointer m_Image
 
std::mutex * m_ImageMutex
 
- Protected Attributes inherited from mitk::USImageSource
mitk::OpenCVToMitkImageFilter::Pointer m_OpenCVToMitkFilter
 Used to convert from OpenCV Images to MITK Images. More...
 
mitk::ImageToOpenCVImageFilter::Pointer m_MitkToOpenCVFilter
 Used to convert from MITK Images to OpenCV Images. More...
 

Additional Inherited Members

- Static Public Attributes inherited from mitk::USImageSource
static const char * IMAGE_PROPERTY_IDENTIFIER
 

Detailed Description

Implementation of mitk::USImageSource for Telemed API devices. The method mitk::USImageSource::GetNextRawImage() is implemented for getting images from the Telemed API.

A method for connecting this ImageSource to the Telemed API is implemented (mitk::USTelemedImageSource::CreateAndConnectConverterPlugin()). This method is available for being used by mitk::USTelemedDevice.

Definition at line 30 of file mitkUSTelemedImageSource.h.

Constructor & Destructor Documentation

◆ USTelemedImageSource()

mitk::USTelemedImageSource::USTelemedImageSource ( )
protected

◆ ~USTelemedImageSource()

virtual mitk::USTelemedImageSource::~USTelemedImageSource ( )
protectedvirtual

Member Function Documentation

◆ Clone()

Pointer mitk::USTelemedImageSource::Clone ( ) const

◆ CreateAndConnectConverterPlugin()

bool mitk::USTelemedImageSource::CreateAndConnectConverterPlugin ( Usgfw2Lib::IUsgDataView *  ,
Usgfw2Lib::tagScanMode   
)

Connect this object to the Telemed API. This method is for being used by mitk::USTelemedDevice.

◆ GetNextRawImage()

virtual void mitk::USTelemedImageSource::GetNextRawImage ( std::vector< mitk::Image::Pointer > &  )
virtual

Implementation of the superclass method. Returns the pointer to the mitk::Image filled by Telemed API callback.

Implements mitk::USImageSource.

◆ mitkClassMacro()

mitk::USTelemedImageSource::mitkClassMacro ( USTelemedImageSource  ,
USImageSource   
)

◆ New()

static Pointer mitk::USTelemedImageSource::New ( )
static

◆ UpdateImageGeometry()

void mitk::USTelemedImageSource::UpdateImageGeometry ( )

Updates the geometry of the current image from the API. Is used internally when a new image is initialized, but also needs to be called if, e.g., the zoom factor is changed.

Member Data Documentation

◆ m_DepthProperties

Usgfw2Lib::IUsgDepth* mitk::USTelemedImageSource::m_DepthProperties
protected

Definition at line 67 of file mitkUSTelemedImageSource.h.

◆ m_Image

mitk::Image::Pointer mitk::USTelemedImageSource::m_Image
protected

Definition at line 72 of file mitkUSTelemedImageSource.h.

◆ m_ImageMutex

std::mutex* mitk::USTelemedImageSource::m_ImageMutex
protected

Definition at line 73 of file mitkUSTelemedImageSource.h.

◆ m_ImageProperties

Usgfw2Lib::IUsgImageProperties* mitk::USTelemedImageSource::m_ImageProperties
protected

Definition at line 66 of file mitkUSTelemedImageSource.h.

◆ m_OldnXPelsPerUnit

long mitk::USTelemedImageSource::m_OldnXPelsPerUnit
protected

Definition at line 68 of file mitkUSTelemedImageSource.h.

◆ m_OldnYPelsPerUnit

long mitk::USTelemedImageSource::m_OldnYPelsPerUnit
protected

Definition at line 69 of file mitkUSTelemedImageSource.h.

◆ m_Plugin

Usgfw2Lib::IUsgScanConverterPlugin* mitk::USTelemedImageSource::m_Plugin
protected

Definition at line 60 of file mitkUSTelemedImageSource.h.

◆ m_PluginCallback

USTelemedScanConverterPlugin* mitk::USTelemedImageSource::m_PluginCallback
protected

Definition at line 61 of file mitkUSTelemedImageSource.h.

◆ m_UsgDataView

Usgfw2Lib::IUsgDataView* mitk::USTelemedImageSource::m_UsgDataView
protected

Definition at line 63 of file mitkUSTelemedImageSource.h.


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