Medical Imaging Interaction Toolkit  2018.4.99-18ddd2ed
Medical Imaging Interaction Toolkit
mitk::BeamformingFilter Class Reference

Class implementing an mitk::ImageToImageFilter for beamforming on both CPU and GPU. More...

#include <mitkBeamformingFilter.h>

Inheritance diagram for mitk::BeamformingFilter:
Collaboration diagram for mitk::BeamformingFilter:

Public Member Functions

 mitkClassMacro (BeamformingFilter, ImageToImageFilter)
 
 mitkNewMacro1Param (Self, mitk::BeamformingSettings::Pointer)
 
Pointer Clone () const
 
void SetProgressHandle (std::function< void(int, std::string)> progressHandle)
 Sets a callback for progress checking. More...
 
- Public Member Functions inherited from mitk::ImageToImageFilter
virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const InputImageType *image)
 
InputImageTypeGetInput (void)
 
InputImageTypeGetInput (unsigned int idx)
 
const InputImageTypeGetInput (void) const
 
const InputImageTypeGetInput (unsigned int idx) const
 
- Public Member Functions inherited from mitk::ImageSource
Pointer Clone () const
 
OutputTypeGetOutput ()
 Get the output data of this image source object. More...
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (DataObjectPointerArraySizeType idx) const
 
itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 Make a DataObject of the correct type to used as the specified output. More...
 
itk::DataObject::Pointer MakeOutput (const DataObjectIdentifierType &name) override
 
virtual vtkImageData * GetVtkImageData ()
 
virtual const vtkImageData * GetVtkImageData () const
 
- Public Member Functions inherited from mitk::BaseDataSource
OutputTypeGetOutput ()
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void GraftOutput (OutputType *output)
 Graft the specified BaseData onto this BaseDataSource's output. More...
 
virtual void GraftOutput (const DataObjectIdentifierType &key, OutputType *output)
 
virtual void GraftNthOutput (unsigned int idx, OutputType *output)
 Graft the specified base data object onto this BaseDataSource's idx'th output. More...
 
bool Updating () const
 Access itk::ProcessObject::m_Updating. More...
 

Protected Member Functions

 BeamformingFilter (mitk::BeamformingSettings::Pointer settings)
 
 ~BeamformingFilter () override
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputInformation () override
 
void GenerateData () override
 
- Protected Member Functions inherited from mitk::ImageToImageFilter
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
void GenerateInputRequestedRegion () override
 
- Protected Member Functions inherited from mitk::ImageSource
 ImageSource ()
 
 ~ImageSource () override
 
void GenerateData () override
 A version of GenerateData() specific for image processing filters. More...
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
 If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). More...
 
void PrepareOutputs () override
 This method is intentionally left blank. More...
 
virtual void AllocateOutputs ()
 The GenerateData method normally allocates the buffers for all of the outputs of a filter. More...
 
virtual void BeforeThreadedGenerateData ()
 If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). More...
 
virtual void AfterThreadedGenerateData ()
 If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). More...
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
 Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". More...
 
- Protected Member Functions inherited from mitk::BaseDataSource
 BaseDataSource ()
 
 ~BaseDataSource () override
 

Protected Attributes

itk::TimeStamp m_TimeOfHeaderInitialization
 
std::function< void(int, std::string)> m_ProgressHandle
 The std::function<void(int, std::string)>, through which progress of the currently updating filter is reported. More...
 
float * m_OutputData
 
float * m_InputData
 
float * m_InputDataPuffer
 
unsigned short * m_MinMaxLines
 
BeamformingSettings::Pointer m_Conf
 Current configuration set. More...
 
int m_LastApodizationArraySize
 
mitk::PhotoacousticOCLBeamformingFilter::Pointer m_BeamformingOclFilter
 Pointer to the GPU beamforming filter class; for performance reasons the filter is initialized within the constructor and kept for all later computations. More...
 

Additional Inherited Members

- Public Types inherited from mitk::ImageToImageFilter
typedef ImageToImageFilter Self
 
typedef ImageSource Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef Superclass::OutputImageRegionType OutputImageRegionType
 
typedef mitk::Image InputImageType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::ConstPointer InputImageConstPointer
 
typedef SlicedData::RegionType InputImageRegionType
 
- Public Types inherited from mitk::ImageSource
typedef ImageSource Self
 
typedef BaseDataSource Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef mitk::Image OutputImageType
 Some convenient typedefs. More...
 
typedef OutputImageType OutputType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef SlicedData::RegionType OutputImageRegionType
 
- Public Types inherited from mitk::BaseDataSource
typedef BaseDataSource Self
 
typedef itk::ProcessObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef BaseData OutputType
 
typedef itk::DataObject::DataObjectIdentifierType DataObjectIdentifierType
 
- Static Public Member Functions inherited from mitk::ImageToImageFilter
static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from mitk::ImageSource
static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 Method for creation through the object factory. More...
 
- Static Public Member Functions inherited from mitk::BaseDataSource
static const char * GetStaticNameOfClass ()
 
- Static Protected Member Functions inherited from mitk::ImageSource
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 Static function used as a "callback" by the MultiThreader. More...
 
- Static Protected Member Functions inherited from mitk::BaseDataSource
static Pointer New ()
 

Detailed Description

Class implementing an mitk::ImageToImageFilter for beamforming on both CPU and GPU.

The class must be given a configuration class instance of mitk::BeamformingSettings for beamforming parameters through mitk::BeamformingFilter::Configure(BeamformingSettings settings) Whether the GPU is used can be set in the configuration. For significant problems or important messages a string is written, which can be accessed via GetMessageString().

Definition at line 32 of file mitkBeamformingFilter.h.

Constructor & Destructor Documentation

◆ BeamformingFilter()

mitk::BeamformingFilter::BeamformingFilter ( mitk::BeamformingSettings::Pointer  settings)
protected

◆ ~BeamformingFilter()

mitk::BeamformingFilter::~BeamformingFilter ( )
overrideprotected

Definition at line 48 of file mitkBeamformingFilter.cpp.

References MITK_INFO.

Member Function Documentation

◆ Clone()

Pointer mitk::BeamformingFilter::Clone ( ) const

◆ GenerateData()

◆ GenerateInputRequestedRegion()

void mitk::BeamformingFilter::GenerateInputRequestedRegion ( )
overrideprotected

◆ GenerateOutputInformation()

void mitk::BeamformingFilter::GenerateOutputInformation ( )
overrideprotected

◆ mitkClassMacro()

mitk::BeamformingFilter::mitkClassMacro ( BeamformingFilter  ,
ImageToImageFilter   
)

◆ mitkNewMacro1Param()

mitk::BeamformingFilter::mitkNewMacro1Param ( Self  ,
mitk::BeamformingSettings::Pointer   
)

◆ SetProgressHandle()

void mitk::BeamformingFilter::SetProgressHandle ( std::function< void(int, std::string)>  progressHandle)

Sets a callback for progress checking.

An std::function<void(int, std::string)> can be set, through which progress of the currently updating filter is reported. The integer argument is a number between 0 an 100 to indicate how far completion has been achieved, the std::string argument indicates what the filter is currently doing.

Definition at line 43 of file mitkBeamformingFilter.cpp.

References m_ProgressHandle.

Member Data Documentation

◆ m_BeamformingOclFilter

mitk::PhotoacousticOCLBeamformingFilter::Pointer mitk::BeamformingFilter::m_BeamformingOclFilter
protected

Pointer to the GPU beamforming filter class; for performance reasons the filter is initialized within the constructor and kept for all later computations.

Definition at line 82 of file mitkBeamformingFilter.h.

Referenced by BeamformingFilter(), and GenerateData().

◆ m_Conf

BeamformingSettings::Pointer mitk::BeamformingFilter::m_Conf
protected

Current configuration set.

Definition at line 73 of file mitkBeamformingFilter.h.

Referenced by BeamformingFilter(), GenerateData(), and GenerateOutputInformation().

◆ m_InputData

float* mitk::BeamformingFilter::m_InputData
protected

Definition at line 67 of file mitkBeamformingFilter.h.

Referenced by GenerateData().

◆ m_InputDataPuffer

float* mitk::BeamformingFilter::m_InputDataPuffer
protected

Definition at line 68 of file mitkBeamformingFilter.h.

◆ m_LastApodizationArraySize

int mitk::BeamformingFilter::m_LastApodizationArraySize
protected

The size of the apodization array when it last changed.

Definition at line 78 of file mitkBeamformingFilter.h.

◆ m_MinMaxLines

unsigned short* mitk::BeamformingFilter::m_MinMaxLines
protected

Definition at line 69 of file mitkBeamformingFilter.h.

◆ m_OutputData

float* mitk::BeamformingFilter::m_OutputData
protected

Definition at line 66 of file mitkBeamformingFilter.h.

Referenced by GenerateData().

◆ m_ProgressHandle

std::function<void(int, std::string)> mitk::BeamformingFilter::m_ProgressHandle
protected

The std::function<void(int, std::string)>, through which progress of the currently updating filter is reported.

Definition at line 64 of file mitkBeamformingFilter.h.

Referenced by BeamformingFilter(), GenerateData(), and SetProgressHandle().

◆ m_TimeOfHeaderInitialization

itk::TimeStamp mitk::BeamformingFilter::m_TimeOfHeaderInitialization
protected

Definition at line 60 of file mitkBeamformingFilter.h.

Referenced by GenerateData(), and GenerateOutputInformation().


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