SimpleITK
|
Produce a binary image where foreground is the regional minima of the input image. More...
#include <sitkRegionalMinimaImageFilter.h>
Produce a binary image where foreground is the regional minima of the input image.
Regional minima are flat zones surrounded by pixels of greater value.
If the input image is constant, the entire image can be considered as a minima or not. The SetFlatIsMinima() method let the user choose which behavior to use.
This class was contributed to the Insight Journal by
Definition at line 54 of file sitkRegionalMinimaImageFilter.h.
Public Types | |
using | PixelIDTypeList = ScalarPixelIDTypeList |
using | Self = RegionalMinimaImageFilter |
![]() | |
using | Self = ImageFilter |
![]() | |
using | Self = ProcessObject |
Public Member Functions | |
Image | Execute (const Image &image1) |
Self & | FlatIsMinimaOff () |
Self & | FlatIsMinimaOn () |
Self & | FullyConnectedOff () |
Self & | FullyConnectedOn () |
double | GetBackgroundValue () const |
bool | GetFlatIsMinima () const |
double | GetForegroundValue () const |
bool | GetFullyConnected () const |
std::string | GetName () const |
RegionalMinimaImageFilter () | |
Self & | SetBackgroundValue (double BackgroundValue) |
Self & | SetFlatIsMinima (bool FlatIsMinima) |
Self & | SetForegroundValue (double ForegroundValue) |
Self & | SetFullyConnected (bool FullyConnected) |
std::string | ToString () const |
virtual | ~RegionalMinimaImageFilter () |
![]() | |
ImageFilter () | |
virtual | ~ImageFilter ()=0 |
![]() | |
virtual void | Abort () |
virtual int | AddCommand (itk::simple::EventEnum event, const std::function< void()> &func) |
Directly add a callback to observe an event. | |
virtual int | AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd) |
Add a Command Object to observer the event. | |
virtual float | GetProgress () const |
An Active Measurement of the progress of execution. | |
virtual bool | HasCommand (itk::simple::EventEnum event) const |
Query of this object has any registered commands for event. | |
ProcessObject () | |
virtual void | RemoveAllCommands () |
Remove all registered commands. | |
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} |
bool | m_FlatIsMinima {true} |
double | m_ForegroundValue {1.0} |
bool | m_FullyConnected {false} |
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > | m_MemberFactory |
Friends | |
struct | detail::MemberFunctionAddressor< MemberFunctionType > |
Additional Inherited Members | |
![]() | |
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. | |
static void | SetGlobalDefaultCoordinateTolerance (double) |
Access the global tolerance to determine congruent spaces. | |
static double | GetGlobalDefaultDirectionTolerance () |
Access the global tolerance to determine congruent spaces. | |
static void | SetGlobalDefaultDirectionTolerance (double) |
Access the global tolerance to determine congruent spaces. | |
static bool | SetGlobalDefaultThreader (const std::string &threader) |
Set/Get the default threader used for process objects. | |
static std::string | GetGlobalDefaultThreader () |
Set/Get the default threader used for process objects. | |
static void | SetGlobalDefaultNumberOfThreads (unsigned int n) |
static unsigned int | GetGlobalDefaultNumberOfThreads () |
Set/Get the default threader used for process objects. | |
![]() | |
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) |
![]() | |
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) |
![]() | |
NonCopyable ()=default | |
NonCopyable (const NonCopyable &)=delete | |
NonCopyable & | operator= (const NonCopyable &)=delete |
![]() | |
template<class TImageType> | |
static void | FixNonZeroIndex (TImageType *img) |
![]() | |
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) |
|
private |
Setup for member function dispatching
Definition at line 132 of file sitkRegionalMinimaImageFilter.h.
Define the pixels types supported by this filter
Definition at line 66 of file sitkRegionalMinimaImageFilter.h.
Definition at line 56 of file sitkRegionalMinimaImageFilter.h.
|
virtual |
Destructor
itk::simple::RegionalMinimaImageFilter::RegionalMinimaImageFilter | ( | ) |
Default Constructor that takes no arguments and initializes default parameters
Execute the filter on the input image
|
private |
Referenced by detail::MemberFunctionAddressor< MemberFunctionType >.
|
inline |
Definition at line 110 of file sitkRegionalMinimaImageFilter.h.
References SetFlatIsMinima().
|
inline |
Set the value of FlatIsMinima to true or false respectfully.
Definition at line 109 of file sitkRegionalMinimaImageFilter.h.
References SetFlatIsMinima().
|
inline |
Definition at line 96 of file sitkRegionalMinimaImageFilter.h.
References SetFullyConnected().
|
inline |
Set the value of FullyConnected to true or false respectfully.
Definition at line 95 of file sitkRegionalMinimaImageFilter.h.
References SetFullyConnected().
|
inline |
Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::NonpositiveMin() .
Definition at line 77 of file sitkRegionalMinimaImageFilter.h.
References m_BackgroundValue.
|
inline |
Set/Get whether a flat image must be considered as a minima or not. Defaults to true.
Definition at line 115 of file sitkRegionalMinimaImageFilter.h.
References m_FlatIsMinima.
|
inline |
Set/Get the value in the output image to consider as "foreground". Defaults to maximum value of PixelType.
Definition at line 87 of file sitkRegionalMinimaImageFilter.h.
References m_ForegroundValue.
|
inline |
Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.
Definition at line 101 of file sitkRegionalMinimaImageFilter.h.
References m_FullyConnected.
|
inlinevirtual |
Name of this class
Implements itk::simple::ProcessObject.
Definition at line 118 of file sitkRegionalMinimaImageFilter.h.
|
inline |
Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::NonpositiveMin() .
Definition at line 72 of file sitkRegionalMinimaImageFilter.h.
References m_BackgroundValue.
|
inline |
Set/Get whether a flat image must be considered as a minima or not. Defaults to true.
Definition at line 106 of file sitkRegionalMinimaImageFilter.h.
References m_FlatIsMinima.
Referenced by FlatIsMinimaOff(), and FlatIsMinimaOn().
|
inline |
Set/Get the value in the output image to consider as "foreground". Defaults to maximum value of PixelType.
Definition at line 82 of file sitkRegionalMinimaImageFilter.h.
References m_ForegroundValue.
|
inline |
Set/Get whether the connected components are defined strictly by face connectivity or by face+edge+vertex connectivity. Default is FullyConnectedOff. For objects that are 1 pixel wide, use FullyConnectedOn.
Definition at line 92 of file sitkRegionalMinimaImageFilter.h.
References m_FullyConnected.
Referenced by FullyConnectedOff(), and FullyConnectedOn().
|
virtual |
Print ourselves out
Reimplemented from itk::simple::ProcessObject.
|
friend |
Definition at line 133 of file sitkRegionalMinimaImageFilter.h.
References ExecuteInternal().
|
private |
Definition at line 142 of file sitkRegionalMinimaImageFilter.h.
Referenced by GetBackgroundValue(), and SetBackgroundValue().
|
private |
Definition at line 150 of file sitkRegionalMinimaImageFilter.h.
Referenced by GetFlatIsMinima(), and SetFlatIsMinima().
|
private |
Definition at line 145 of file sitkRegionalMinimaImageFilter.h.
Referenced by GetForegroundValue(), and SetForegroundValue().
|
private |
Definition at line 148 of file sitkRegionalMinimaImageFilter.h.
Referenced by GetFullyConnected(), and SetFullyConnected().
|
private |
Definition at line 138 of file sitkRegionalMinimaImageFilter.h.