Binary projection. More...

#include <sitkBinaryProjectionImageFilter.h>

Inheritance diagram for itk::simple::BinaryProjectionImageFilter:

Collaboration diagram for itk::simple::BinaryProjectionImageFilter:

Detailed Description

Binary projection.

This class was contributed to the Insight Journal by Gaetan Lehmann. The original paper can be found at https://doi.org/10.54294/0pjyho

Author: Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

See also: ProjectionImageFilter; MedianProjectionImageFilter; MeanProjectionImageFilter; MeanProjectionImageFilter; MaximumProjectionImageFilter; MinimumProjectionImageFilter; StandardDeviationProjectionImageFilter; SumProjectionImageFilter; itk::simple::BinaryProjection for the procedural interface; itk::BinaryProjectionImageFilter for the Doxygen on the original ITK class.

Definition at line 67 of file sitkBinaryProjectionImageFilter.h.

Public Types
using	PixelIDTypeList = BasicPixelIDTypeList

using	Self = BinaryProjectionImageFilter

Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter

Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
	BinaryProjectionImageFilter ()

Image	Execute (const Image &image1)

double	GetBackgroundValue () const

double	GetForegroundValue () const

std::string	GetName () const

unsigned int	GetProjectionDimension () const

Self &	SetBackgroundValue (double BackgroundValue)

Self &	SetForegroundValue (double ForegroundValue)

Self &	SetProjectionDimension (unsigned int ProjectionDimension)

std::string	ToString () const

virtual	~BinaryProjectionImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter
	ImageFilter ()

virtual	~ImageFilter ()=0

Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()

virtual int	AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
	Directly add a callback to observe an event. More...

virtual int	AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
	Add a Command Object to observer the event. More...

virtual float	GetProgress () const
	An Active Measurement of the progress of execution. More...

virtual bool	HasCommand (itk::simple::EventEnum event) const
	Query of this object has any registered commands for event. More...

	ProcessObject ()

virtual void	RemoveAllCommands ()
	Remove all registered commands. More...

virtual	~ProcessObject ()

virtual void	DebugOn ()

virtual void	DebugOff ()

virtual bool	GetDebug () const

virtual void	SetDebug (bool debugFlag)

virtual void	SetNumberOfThreads (unsigned int n)

virtual unsigned int	GetNumberOfThreads () const

virtual void	SetNumberOfWorkUnits (unsigned int n)

virtual unsigned int	GetNumberOfWorkUnits () const

Private Types
using	MemberFunctionType = Image(Self::*)(const Image &image1)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image &image1)

Private Attributes
double	m_BackgroundValue {0.0}

double	m_ForegroundValue {1.0}

std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

unsigned int	m_ProjectionDimension {0u}

Friends
struct	detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members
Static Public Member Functions inherited from itk::simple::ProcessObject
static bool	GetGlobalDefaultDebug ()

static void	GlobalDefaultDebugOff ()

static void	GlobalDefaultDebugOn ()

static void	SetGlobalDefaultDebug (bool debugFlag)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static void	SetGlobalWarningDisplay (bool flag)

static bool	GetGlobalWarningDisplay ()

static double	GetGlobalDefaultCoordinateTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultCoordinateTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

static double	GetGlobalDefaultDirectionTolerance ()
	Access the global tolerance to determine congruent spaces. More...

static void	SetGlobalDefaultDirectionTolerance (double)
	Access the global tolerance to determine congruent spaces. More...

static bool	SetGlobalDefaultThreader (const std::string &threader)
	Set/Get the default threader used for process objects. More...

static std::string	GetGlobalDefaultThreader ()
	Set/Get the default threader used for process objects. More...

static void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()
	Set/Get the default threader used for process objects. More...

Protected Member Functions inherited from itk::simple::ImageFilter
void	CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)

void	CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)

Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long	AddITKObserver (const itk::EventObject &, itk::Command *)

virtual itk::ProcessObject *	GetActiveProcess ()

virtual void	OnActiveProcessDelete ()

virtual void	onCommandDelete (const itk::simple::Command *cmd) noexcept

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()=default

	NonCopyable (const NonCopyable &)=delete

NonCopyable &	operator= (const NonCopyable &)=delete

Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
static void	FixNonZeroIndex (TImageType *img)

Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer	CastImageToITK (const Image &img)

template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)

template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)

template<class TImageType >
static Image	CastITKToImage (TImageType *img)

static const itk::EventObject &	GetITKEventObject (EventEnum e)

template<typename T >
static std::ostream &	ToStringHelper (std::ostream &os, const T &v)

static std::ostream &	ToStringHelper (std::ostream &os, const char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const signed char &v)

static std::ostream &	ToStringHelper (std::ostream &os, const unsigned char &v)

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::BinaryProjectionImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )

private

Setup for member function dispatching

Definition at line 125 of file sitkBinaryProjectionImageFilter.h.

◆ PixelIDTypeList

using itk::simple::BinaryProjectionImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 79 of file sitkBinaryProjectionImageFilter.h.

◆ Self

using itk::simple::BinaryProjectionImageFilter::Self = BinaryProjectionImageFilter

Definition at line 69 of file sitkBinaryProjectionImageFilter.h.

Constructor & Destructor Documentation

◆ ~BinaryProjectionImageFilter()

virtual itk::simple::BinaryProjectionImageFilter::~BinaryProjectionImageFilter ( )

virtual

Destructor

◆ BinaryProjectionImageFilter()

itk::simple::BinaryProjectionImageFilter::BinaryProjectionImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

Image itk::simple::BinaryProjectionImageFilter::Execute ( const Image & image1 )

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >

Image itk::simple::BinaryProjectionImageFilter::ExecuteInternal ( const Image & image1 )

private

◆ GetBackgroundValue()

double itk::simple::BinaryProjectionImageFilter::GetBackgroundValue ( ) const

inline

Get the value used as "background". Any pixel value which is not DilateValue is considered background. BackgroundValue is used for defining boundary conditions. Defaults to NumericTraits<PixelType>::NonpositiveMin() .

Definition at line 108 of file sitkBinaryProjectionImageFilter.h.

◆ GetForegroundValue()

double itk::simple::BinaryProjectionImageFilter::GetForegroundValue ( ) const

inline

Get the value in the image considered as "foreground". Defaults to maximum value of PixelType.

Definition at line 98 of file sitkBinaryProjectionImageFilter.h.

◆ GetName()

std::string itk::simple::BinaryProjectionImageFilter::GetName ( ) const

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 111 of file sitkBinaryProjectionImageFilter.h.

◆ GetProjectionDimension()

unsigned int itk::simple::BinaryProjectionImageFilter::GetProjectionDimension ( ) const

inline

Definition at line 88 of file sitkBinaryProjectionImageFilter.h.

◆ SetBackgroundValue()

Self& itk::simple::BinaryProjectionImageFilter::SetBackgroundValue ( double BackgroundValue )

inline

Set the value used as "background". Any pixel value which is not DilateValue is considered background. BackgroundValue is used for defining boundary conditions. Defaults to NumericTraits<PixelType>::NonpositiveMin() .

Definition at line 103 of file sitkBinaryProjectionImageFilter.h.

◆ SetForegroundValue()

Self& itk::simple::BinaryProjectionImageFilter::SetForegroundValue ( double ForegroundValue )

inline

Set the value in the image to consider as "foreground". Defaults to maximum value of PixelType. Subclasses may alias this to DilateValue or ErodeValue.

Definition at line 93 of file sitkBinaryProjectionImageFilter.h.