The OclBinaryThresholdImageFilter computes a binary segmentation based on given threshold values. More...

#include <mitkOclBinaryThresholdImageFilter.h>

Inheritance diagram for mitk::OclBinaryThresholdImageFilter:

[legend]

Collaboration diagram for mitk::OclBinaryThresholdImageFilter:

[legend]

Public Member Functions
	mitkClassMacroItkParent (OclBinaryThresholdImageFilter, itk::Object)

void	SetInput (Image::Pointer image)
	SetInput Set the input image. Only 3D images are supported for now. More...

void	Update ()

void	SetLowerThreshold (int lowerThreshold)

void	SetUpperThreshold (int upperThreshold)

void	SetOutsideValue (int outsideValue)

void	SetInsideValue (int insideValue)

Public Member Functions inherited from mitk::OclImageToImageFilter
mitk::Image::Pointer	GetOutput ()
	Returns an mitk::Image::Pointer containing the filtered data. More...

mitk::OclImage::Pointer	GetGPUOutput ()
	Returns a pointer to the graphics memory. More...

Public Member Functions inherited from mitk::OclImageFilter
void	SetInput (mitk::OclImage::Pointer image)
	SetInput SetInput Set the input image (as mitk::OclImage). More...

void	SetInput (mitk::Image::Pointer image)
	SetInput Set the input image (as mitk::Image). More...

Public Member Functions inherited from mitk::OclFilter
void	AddSourceFile (const char *filename)
	Add a source file from the resource files to the OpenCL shader file list. Multiple files can be added to the list. More...

void	SetCompilerFlags (const char *flags)
	Set specific compilerflags to compile the CL source. Default is set to nullptr; example: "-cl-fast-relaxed-math -cl-mad-enable -cl-strict-aliasing". More...

virtual bool	IsInitialized ()
	Returns true if the initialization was successfull. More...

virtual unsigned long	GetDeviceMemory ()
	Returns the amount of global memory of the used device in bytes. More...

virtual	~OclFilter ()
	Destructor. More...

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	OclBinaryThresholdImageFilter ()

virtual	~OclBinaryThresholdImageFilter ()

bool	Initialize ()

void	Execute ()

mitk::PixelType	GetOutputType ()
	(Virtual) method returning the format in which the output image will be returned More...

int	GetBytesPerElem ()
	Get the memory size needed for each element. More...

virtual us::Module *	GetModule ()
	Get the Module of the filter. Needs to be implemented by every subclass. The filter will load the OpenCL sourcefiles from this module context. More...

Protected Member Functions inherited from mitk::OclImageToImageFilter
	OclImageToImageFilter ()
	OclImageToImageFilter Default constructor. More...

virtual	~OclImageToImageFilter ()
	Destructor. More...

bool	InitExec (cl_kernel ckKernel)
	InitExec Initialize the execution. More...

bool	InitExec (cl_kernel ckKernel, unsigned int *dimensions)

Protected Member Functions inherited from mitk::OclImageFilter
	OclImageFilter ()

virtual	~OclImageFilter ()

Protected Member Functions inherited from mitk::OclFilter
	OclFilter ()
	Constructor. More...

	OclFilter (const char *filename)
	Constructor ( overloaded ) More...

void	SetWorkingSize (unsigned int locx, unsigned int dimx, unsigned int locy=1, unsigned int dimy=1, unsigned int locz=1, unsigned int dimz=1)
	Set the working size for the following OpenCL kernel call. More...

bool	ExecuteKernel (cl_kernel kernel, unsigned int workSizeDim)
	Execute the given kernel on the OpenCL Index-Space defined by the local and global work sizes. More...

bool	ExecuteKernelChunks (cl_kernel kernel, unsigned int workSizeDim, size_t *chunksDim)
	Execute the given kernel on the OpenCL Index-Space defined by the local and global work sizes, but divide it into chunks of dimension chunksDim. More...

bool	ExecuteKernelChunksInBatches (cl_kernel kernel, unsigned int workSizeDim, size_t *chunksDim, size_t batchSize, int waitTimems)
	Execute the given kernel on the OpenCL Index-Space defined by the local and global work sizes, but divide it into chunks of dimension chunksDim and wait between batches of batchSize chunks a time of waitTimems milliseconds. More...

bool	Initialize ()
	Initialize all necessary parts of the filter. More...

void	CompileSource ()
	Compile the program source. More...

void	SetSourcePreambel (const char *preambel)
	Add some source code on the beginning of the loaded source. More...

void	LoadSourceFiles (CStringList &SourceCodeList, ClSizeList &SourceCodeSizeList)
	Helper functions that load sourcefiles from the module context in the Initialize function. More...

Additional Inherited Members
Protected Types inherited from mitk::OclFilter
typedef std::vector< const char * >	CStringList

typedef std::vector< size_t >	ClSizeList

Protected Attributes inherited from mitk::OclImageToImageFilter
mitk::OclImage::Pointer	m_Output

Protected Attributes inherited from mitk::OclImageFilter
mitk::OclImage::Pointer	m_Input

short	m_CurrentType

Protected Attributes inherited from mitk::OclFilter
const char *	m_ClCompilerFlags
	String that contains the compiler flags. More...

cl_program	m_ClProgram
	The compiled OpenCL program. More...

cl_command_queue	m_CommandQue
	Command queue for the filter. More...

std::string	m_FilterID
	Unique ID of the filter, needs to be specified in the constructor of the derived class. More...

const char *	m_Preambel
	source preambel for e.g. `#define` commands to be inserted into the OpenCL source More...

CStringList	m_ClFiles
	List of sourcefiles that will be compiled for this filter. More...

bool	m_Initialized
	status of the filter More...

size_t	m_LocalWorkSize [3]
	The local work size fo the filter. More...

size_t	m_GlobalWorkSize [3]
	The global work size of the filter. More...

Detailed Description

The OclBinaryThresholdImageFilter computes a binary segmentation based on given threshold values.

Documentation

The filter requires two threshold values ( the upper and the lower threshold ) and two image values ( inside and outside ). The resulting voxel of the segmentation image is assigned the inside value 1 if the image value is between the given thresholds and the outside value otherwise.

Definition at line 31 of file mitkOclBinaryThresholdImageFilter.h.

Constructor & Destructor Documentation

◆ OclBinaryThresholdImageFilter()

mitk::OclBinaryThresholdImageFilter::OclBinaryThresholdImageFilter ( )

protected

Constructor

◆ ~OclBinaryThresholdImageFilter()

virtual mitk::OclBinaryThresholdImageFilter::~OclBinaryThresholdImageFilter ( )

protectedvirtual

Destructor

Member Function Documentation

◆ Execute()

void mitk::OclBinaryThresholdImageFilter::Execute ( )

protected

◆ GetBytesPerElem()

int mitk::OclBinaryThresholdImageFilter::GetBytesPerElem ( )

inlineprotectedvirtual

Get the memory size needed for each element.

Reimplemented from mitk::OclImageToImageFilter.

Definition at line 99 of file mitkOclBinaryThresholdImageFilter.h.

◆ GetModule()

virtual us::Module* mitk::OclBinaryThresholdImageFilter::GetModule ( )

protectedvirtual

Get the Module of the filter. Needs to be implemented by every subclass. The filter will load the OpenCL sourcefiles from this module context.

Implements mitk::OclFilter.

◆ GetOutputType()

mitk::PixelType mitk::OclBinaryThresholdImageFilter::GetOutputType ( )

inlineprotectedvirtual

(Virtual) method returning the format in which the output image will be returned

Reimplemented from mitk::OclImageToImageFilter.

Definition at line 94 of file mitkOclBinaryThresholdImageFilter.h.

◆ Initialize()

bool mitk::OclBinaryThresholdImageFilter::Initialize ( )

protected

Initialize the filter

◆ mitkClassMacroItkParent()

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

◆ New()

static Pointer mitk::OclBinaryThresholdImageFilter::New ( )

static

◆ SetInput()

void mitk::OclBinaryThresholdImageFilter::SetInput ( Image::Pointer image )

SetInput Set the input image. Only 3D images are supported for now.

Parameters

image a 3D image.

Exceptions

mitk::Exception if the dimesion is not 3.

◆ SetInsideValue()

void mitk::OclBinaryThresholdImageFilter::SetInsideValue ( int insideValue )

inline

Set the inside value

Parameters

insideValue The inside value

Definition at line 76 of file mitkOclBinaryThresholdImageFilter.h.

◆ SetLowerThreshold()

void mitk::OclBinaryThresholdImageFilter::SetLowerThreshold ( int lowerThreshold )

inline

Set the lower threshold

Parameters

lowerThreshold Threshold value

Definition at line 51 of file mitkOclBinaryThresholdImageFilter.h.

◆ SetOutsideValue()

void mitk::OclBinaryThresholdImageFilter::SetOutsideValue ( int outsideValue )

inline

Set the outside value

Parameters

outsideValue The outside value

Definition at line 68 of file mitkOclBinaryThresholdImageFilter.h.

◆ SetUpperThreshold()

void mitk::OclBinaryThresholdImageFilter::SetUpperThreshold ( int upperThreshold )

inline

Set the upper threshold

Parameters

upperThreshold Threshold value

Definition at line 59 of file mitkOclBinaryThresholdImageFilter.h.

◆ Update()

void mitk::OclBinaryThresholdImageFilter::Update ( )

virtual

Update the filter

Implements mitk::OclImageToImageFilter.

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

mitkOclBinaryThresholdImageFilter.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OclBinaryThresholdImageFilter()

◆ ~OclBinaryThresholdImageFilter()

Member Function Documentation

◆ Execute()

◆ GetBytesPerElem()

◆ GetModule()

◆ GetOutputType()

◆ Initialize()

◆ mitkClassMacroItkParent()

◆ New()

◆ SetInput()

◆ SetInsideValue()

◆ SetLowerThreshold()

◆ SetOutsideValue()

◆ SetUpperThreshold()

◆ Update()