SimpleITK
2.1.0
|
Threshold an image using the RenyiEntropy Threshold. More...
#include <sitkRenyiEntropyThresholdImageFilter.h>
Public Types | |
using | PixelIDTypeList = BasicPixelIDTypeList |
using | Self = RenyiEntropyThresholdImageFilter |
Public Types inherited from itk::simple::ImageFilter | |
using | Self = ImageFilter |
Public Types inherited from itk::simple::ProcessObject | |
using | Self = ProcessObject |
Public Member Functions | |
Image | Execute (const Image &image) |
Image | Execute (const Image &image, const Image &maskImage) |
uint8_t | GetInsideValue () const |
bool | GetMaskOutput () const |
uint8_t | GetMaskValue () const |
std::string | GetName () const |
uint32_t | GetNumberOfHistogramBins () const |
uint8_t | GetOutsideValue () const |
double | GetThreshold () const |
Get the computed threshold. More... | |
Self & | MaskOutputOff () |
Self & | MaskOutputOn () |
RenyiEntropyThresholdImageFilter () | |
Self & | SetInsideValue (uint8_t InsideValue) |
Self & | SetMaskOutput (bool MaskOutput) |
Self & | SetMaskValue (uint8_t MaskValue) |
Self & | SetNumberOfHistogramBins (uint32_t NumberOfHistogramBins) |
Self & | SetOutsideValue (uint8_t OutsideValue) |
std::string | ToString () const |
virtual | ~RenyiEntropyThresholdImageFilter () |
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 *image, const Image *maskImage) |
Private Member Functions | |
template<class TImageType > | |
Image | ExecuteInternal (const Image *image, const Image *maskImage) |
Private Attributes | |
uint8_t | m_InsideValue {1u} |
bool | m_MaskOutput {true} |
uint8_t | m_MaskValue {255u} |
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > | m_MemberFactory |
uint32_t | m_NumberOfHistogramBins {256u} |
uint8_t | m_OutsideValue {0u} |
double | m_Threshold {0.0} |
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<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) |
Threshold an image using the RenyiEntropy Threshold.
This filter creates a binary thresholded image that separates an image into foreground and background components. The filter computes the threshold using the RenyiEntropyThresholdCalculator and applies that threshold to the input image using the BinaryThresholdImageFilter .
This implementation was taken from the Insight Journal paper: https://hdl.handle.net/10380/3279 or http://www.insight-journal.org/browse/publication/811
Definition at line 52 of file sitkRenyiEntropyThresholdImageFilter.h.
|
private |
Setup for member function dispatching
Definition at line 147 of file sitkRenyiEntropyThresholdImageFilter.h.
Define the pixels types supported by this filter
Definition at line 64 of file sitkRenyiEntropyThresholdImageFilter.h.
Definition at line 54 of file sitkRenyiEntropyThresholdImageFilter.h.
|
virtual |
Destructor
itk::simple::RenyiEntropyThresholdImageFilter::RenyiEntropyThresholdImageFilter | ( | ) |
Default Constructor that takes no arguments and initializes default parameters
Image itk::simple::RenyiEntropyThresholdImageFilter::Execute | ( | const Image & | image, |
const Image & | maskImage | ||
) |
Execute the filter on the input image
|
private |
|
inline |
Get the "inside" pixel value.
Definition at line 77 of file sitkRenyiEntropyThresholdImageFilter.h.
|
inline |
Definition at line 112 of file sitkRenyiEntropyThresholdImageFilter.h.
|
inline |
Definition at line 121 of file sitkRenyiEntropyThresholdImageFilter.h.
|
inlinevirtual |
Name of this class
Implements itk::simple::ProcessObject.
Definition at line 132 of file sitkRenyiEntropyThresholdImageFilter.h.
|
inline |
Definition at line 99 of file sitkRenyiEntropyThresholdImageFilter.h.
|
inline |
Get the "outside" pixel value.
Definition at line 89 of file sitkRenyiEntropyThresholdImageFilter.h.
|
inline |
Get the computed threshold.
This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.
Definition at line 128 of file sitkRenyiEntropyThresholdImageFilter.h.
|
inline |
Definition at line 108 of file sitkRenyiEntropyThresholdImageFilter.h.
|
inline |
Set the value of MaskOutput to true or false respectfully.
Definition at line 107 of file sitkRenyiEntropyThresholdImageFilter.h.
Set the "inside" pixel value.
Definition at line 71 of file sitkRenyiEntropyThresholdImageFilter.h.
|
inline |
Do you want the output to be masked by the mask used in histogram construction. Only relevant if masking is in use.
Definition at line 104 of file sitkRenyiEntropyThresholdImageFilter.h.
The value in the mask image, if used, indicating voxels that should be included. Default is the max of pixel type, as in the MaskedImageToHistogramFilter
Definition at line 117 of file sitkRenyiEntropyThresholdImageFilter.h.
|
inline |
Set/Get the number of histogram bins.
Definition at line 95 of file sitkRenyiEntropyThresholdImageFilter.h.
Set the "outside" pixel value. The default value NumericTraits<OutputPixelType>::Zero.
Definition at line 83 of file sitkRenyiEntropyThresholdImageFilter.h.
|
virtual |
Print ourselves out
Reimplemented from itk::simple::ProcessObject.
|
friend |
Definition at line 151 of file sitkRenyiEntropyThresholdImageFilter.h.
|
private |
Definition at line 156 of file sitkRenyiEntropyThresholdImageFilter.h.
|
private |
Definition at line 162 of file sitkRenyiEntropyThresholdImageFilter.h.
|
private |
Definition at line 164 of file sitkRenyiEntropyThresholdImageFilter.h.
|
private |
Definition at line 153 of file sitkRenyiEntropyThresholdImageFilter.h.
|
private |
Definition at line 160 of file sitkRenyiEntropyThresholdImageFilter.h.
|
private |
Definition at line 158 of file sitkRenyiEntropyThresholdImageFilter.h.
|
private |
Definition at line 167 of file sitkRenyiEntropyThresholdImageFilter.h.