ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate > Class Template Reference
Data Processing Objects » Functions » Image FunctionsGroup Core » | Module ITKImageFunction

#include <itkNeighborhoodBinaryThresholdImageFunction.h>

Detailed Description

template<typename TInputImage, typename TCoordinate = float>
class itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >

Determine whether all the pixels in the specified neighborhood meet a threshold criteria.

Determine whether all the pixels in the specified neighborhood meet a threshold criteria.

If called with a ContinuousIndex or Point, the calculation is performed at the nearest neighbor.

This class is templated over the input image type and the coordinate representation type (e.g. float or double).

Definition at line 42 of file itkNeighborhoodBinaryThresholdImageFunction.h.

+ Inheritance diagram for itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >:
+ Collaboration diagram for itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using InputImageType = TInputImage
 
using InputSizeType = typename InputImageType::SizeType
 
using Pointer = SmartPointer< Self >
 
using Self = NeighborhoodBinaryThresholdImageFunction
 
using Superclass = BinaryThresholdImageFunction< TInputImage, TCoordinate >
 
- Public Types inherited from itk::BinaryThresholdImageFunction< TInputImage, TCoordinate >
using ConstPointer = SmartPointer< const Self >
 
using PixelType = typename TInputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using Self = BinaryThresholdImageFunction
 
using Superclass = ImageFunction< TInputImage, bool, TCoordinate >
 
- Public Types inherited from itk::ImageFunction< TInputImage, bool, TCoordinate >
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = ContinuousIndex< TCoordinate, Self::ImageDimension >
 
using CoordinateType = TCoordinate
 
using IndexType = typename InputImageType::IndexType
 
using IndexValueType = typename InputImageType::IndexValueType
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImageType = TInputImage
 
using InputPixelType = typename InputImageType::PixelType
 
using OutputType = bool
 
using Pointer = SmartPointer< Self >
 
using PointType = Point< TCoordinate, Self::ImageDimension >
 
using Self = ImageFunction
 
using Superclass = FunctionBase< Point< TCoordinate, Self::ImageDimension >, bool >
 
- Public Types inherited from itk::FunctionBase< Point< TCoordinate, TInputImage::ImageDimension >, bool >
using ConstPointer = SmartPointer< const Self >
 
using InputType = Point< TCoordinate, TInputImage::ImageDimension >
 
using OutputType = bool
 
using Pointer = SmartPointer< Self >
 
using Self = FunctionBase
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

bool Evaluate (const PointType &point) const override
 
bool EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const override
 
bool EvaluateAtIndex (const IndexType &index) const override
 
const char * GetNameOfClass () const override
 
virtual const InputSizeType & GetRadius () const
 
virtual void SetRadius (InputSizeType _arg)
 
- Public Member Functions inherited from itk::BinaryThresholdImageFunction< TInputImage, TCoordinate >
virtual const PixelType & GetLower () const
 
virtual const PixelType & GetUpper () const
 
void ThresholdAbove (PixelType thresh)
 
void ThresholdBelow (PixelType thresh)
 
void ThresholdBetween (PixelType lower, PixelType upper)
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, bool, TCoordinate >
void ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
 
void ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
 
virtual const ContinuousIndexType & GetEndContinuousIndex () const
 
virtual const IndexType & GetEndIndex () const
 
const InputImageType * GetInputImage () const
 
const char * GetNameOfClass () const override
 
virtual const ContinuousIndexType & GetStartContinuousIndex () const
 
virtual const IndexType & GetStartIndex () const
 
virtual void SetInputImage (const InputImageType *ptr)
 
virtual bool IsInsideBuffer (const IndexType &index) const
 
virtual bool IsInsideBuffer (const ContinuousIndexType &index) const
 
virtual bool IsInsideBuffer (const PointType &point) const
 
void ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStamp & GetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::BinaryThresholdImageFunction< TInputImage, TCoordinate >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = InputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::BinaryThresholdImageFunction< TInputImage, TCoordinate >
static constexpr unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, bool, TCoordinate >
static constexpr unsigned int ImageDimension
 

Protected Member Functions

 NeighborhoodBinaryThresholdImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~NeighborhoodBinaryThresholdImageFunction () override=default
 
- Protected Member Functions inherited from itk::BinaryThresholdImageFunction< TInputImage, TCoordinate >
 BinaryThresholdImageFunction ()
 
 ~BinaryThresholdImageFunction () override=default
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, bool, TCoordinate >
 ImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageFunction () override=default
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordinate, TInputImage::ImageDimension >, bool >
 FunctionBase ()=default
 
 ~FunctionBase () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

InputSizeType m_Radius {}
 

Additional Inherited Members

- Protected Attributes inherited from itk::ImageFunction< TInputImage, bool, TCoordinate >
ContinuousIndexType m_EndContinuousIndex
 
IndexType m_EndIndex
 
InputImageConstPointer m_Image
 
ContinuousIndexType m_StartContinuousIndex
 
IndexType m_StartIndex
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TCoordinate = float>
using itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >::ConstPointer = SmartPointer<const Self>

Definition at line 52 of file itkNeighborhoodBinaryThresholdImageFunction.h.

◆ InputImageType

template<typename TInputImage , typename TCoordinate = float>
using itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >::InputImageType = TInputImage

InputImageType type alias support

Definition at line 61 of file itkNeighborhoodBinaryThresholdImageFunction.h.

◆ InputSizeType

template<typename TInputImage , typename TCoordinate = float>
using itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >::InputSizeType = typename InputImageType::SizeType

SizeType of the input image

Definition at line 82 of file itkNeighborhoodBinaryThresholdImageFunction.h.

◆ Pointer

template<typename TInputImage , typename TCoordinate = float>
using itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >::Pointer = SmartPointer<Self>

Definition at line 51 of file itkNeighborhoodBinaryThresholdImageFunction.h.

◆ Self

template<typename TInputImage , typename TCoordinate = float>
using itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >::Self = NeighborhoodBinaryThresholdImageFunction

Standard class type aliases.

Definition at line 49 of file itkNeighborhoodBinaryThresholdImageFunction.h.

◆ Superclass

template<typename TInputImage , typename TCoordinate = float>
using itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >::Superclass = BinaryThresholdImageFunction<TInputImage, TCoordinate>

Definition at line 50 of file itkNeighborhoodBinaryThresholdImageFunction.h.

Constructor & Destructor Documentation

◆ NeighborhoodBinaryThresholdImageFunction()

template<typename TInputImage , typename TCoordinate = float>
itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >::NeighborhoodBinaryThresholdImageFunction ( )
protected

◆ ~NeighborhoodBinaryThresholdImageFunction()

template<typename TInputImage , typename TCoordinate = float>
itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >::~NeighborhoodBinaryThresholdImageFunction ( )
overrideprotecteddefault

Member Function Documentation

◆ Evaluate()

template<typename TInputImage , typename TCoordinate = float>
bool itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >::Evaluate ( const PointType &  point) const
inlineoverridevirtual

Evaluate the function at non-integer positions

Reimplemented from itk::BinaryThresholdImageFunction< TInputImage, TCoordinate >.

Definition at line 96 of file itkNeighborhoodBinaryThresholdImageFunction.h.

References itk::point().

◆ EvaluateAtContinuousIndex()

template<typename TInputImage , typename TCoordinate = float>
bool itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >::EvaluateAtContinuousIndex ( const ContinuousIndexType &  index) const
inlineoverridevirtual

BinaryThreshold the image at a continuous index position

Returns true if the image intensity at the specified point position satisfies the threshold criteria. The point is assumed to lie within the image buffer.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

Reimplemented from itk::BinaryThresholdImageFunction< TInputImage, TCoordinate >.

Definition at line 105 of file itkNeighborhoodBinaryThresholdImageFunction.h.

◆ EvaluateAtIndex()

template<typename TInputImage , typename TCoordinate = float>
bool itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >::EvaluateAtIndex ( const IndexType &  index) const
overridevirtual

Evaluate the function at specified index

Reimplemented from itk::BinaryThresholdImageFunction< TInputImage, TCoordinate >.

◆ GetNameOfClass()

template<typename TInputImage , typename TCoordinate = float>
const char* itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::BinaryThresholdImageFunction< TInputImage, TCoordinate >.

◆ GetRadius()

template<typename TInputImage , typename TCoordinate = float>
virtual const InputSizeType& itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >::GetRadius ( ) const
virtual

Get the radius of the neighborhood used in computation

◆ New()

template<typename TInputImage , typename TCoordinate = float>
static Pointer itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TCoordinate = float>
void itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::BinaryThresholdImageFunction< TInputImage, TCoordinate >.

◆ SetRadius()

template<typename TInputImage , typename TCoordinate = float>
virtual void itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >::SetRadius ( InputSizeType  _arg)
virtual

Set the radius of the neighborhood used in computation.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TCoordinate = float>
constexpr unsigned int itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >::ImageDimension = InputImageType::ImageDimension
staticconstexpr

Dimension of the underlying image.

Definition at line 79 of file itkNeighborhoodBinaryThresholdImageFunction.h.

◆ m_Radius

template<typename TInputImage , typename TCoordinate = float>
InputSizeType itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordinate >::m_Radius {}
private

Definition at line 120 of file itkNeighborhoodBinaryThresholdImageFunction.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16