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

#include <mitkIGTLMessageToUSImageFilter.h>

Inheritance diagram for mitk::IGTLMessageToUSImageFilter:
Collaboration diagram for mitk::IGTLMessageToUSImageFilter:

Public Member Functions

 mitkClassMacro (IGTLMessageToUSImageFilter, USImageSource)
 
Pointer Clone () const
 
void SetNumberOfExpectedOutputs (unsigned int numOutputs)
 Sets the number of expected outputs. More...
 
void ConnectTo (mitk::IGTLMessageSource *UpstreamFilter)
 Connects the input of this filter to the outputs of the given IGTLMessageSource. 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

 IGTLMessageToUSImageFilter ()
 
void GetNextRawImage (std::vector< mitk::Image::Pointer > &imgVector) override
 Copies the data from the next OIGTL message to an mitk::Image. More...
 
- 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...
 

Additional Inherited Members

- Static Public Attributes inherited from mitk::USImageSource
static const char * IMAGE_PROPERTY_IDENTIFIER
 
- 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...
 

Detailed Description

Definition at line 24 of file mitkIGTLMessageToUSImageFilter.h.

Constructor & Destructor Documentation

◆ IGTLMessageToUSImageFilter()

mitk::IGTLMessageToUSImageFilter::IGTLMessageToUSImageFilter ( )
protected

Member Function Documentation

◆ Clone()

Pointer mitk::IGTLMessageToUSImageFilter::Clone ( ) const

◆ ConnectTo()

void mitk::IGTLMessageToUSImageFilter::ConnectTo ( mitk::IGTLMessageSource UpstreamFilter)

Connects the input of this filter to the outputs of the given IGTLMessageSource.

This method does not support smartpointer. use FilterX.GetPointer() to retrieve a dumbpointer.

◆ GetNextRawImage()

void mitk::IGTLMessageToUSImageFilter::GetNextRawImage ( std::vector< mitk::Image::Pointer > &  imgVector)
overrideprotectedvirtual

Copies the data from the next OIGTL message to an mitk::Image.

Parameters
imgVectorthe image to fill with the data from the OIGTL message.

Implements mitk::USImageSource.

◆ mitkClassMacro()

mitk::IGTLMessageToUSImageFilter::mitkClassMacro ( IGTLMessageToUSImageFilter  ,
USImageSource   
)

◆ New()

static Pointer mitk::IGTLMessageToUSImageFilter::New ( )
static

◆ SetNumberOfExpectedOutputs()

void mitk::IGTLMessageToUSImageFilter::SetNumberOfExpectedOutputs ( unsigned int  numOutputs)

Sets the number of expected outputs.

Normally, this is done automatically by the filter concept. However, in our case we can not know, for example, how many tracking elements are stored in the incoming igtl message. Therefore, we have to set the number here to the expected value.


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