ITK  5.2.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::BinaryThresholdImageFunction< TInputImage, TCoordRep > Class Template Reference

#include <itkBinaryThresholdImageFunction.h>

+ Inheritance diagram for itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >:
+ Collaboration diagram for itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = typename Superclass::ContinuousIndexType
 
using IndexType = typename Superclass::IndexType
 
using InputImageType = typename Superclass::InputImageType
 
using PixelType = typename TInputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename Superclass::PointType
 
using Self = BinaryThresholdImageFunction
 
using Superclass = ImageFunction< TInputImage, bool, TCoordRep >
 
- Public Types inherited from itk::ImageFunction< TInputImage, bool, TCoordRep >
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = ContinuousIndex< TCoordRep, Self::ImageDimension >
 
using CoordRepType = TCoordRep
 
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< TCoordRep, Self::ImageDimension >
 
using Self = ImageFunction
 
using Superclass = FunctionBase< Point< TCoordRep, Self::ImageDimension >, bool >
 
- Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, bool >
using ConstPointer = SmartPointer< const Self >
 
using InputType = Point< TCoordRep, 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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
bool Evaluate (const PointType &point) const override
 
bool EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override
 
bool EvaluateAtIndex (const IndexType &index) const override
 
virtual const PixelTypeGetLower () const
 
virtual const char * GetNameOfClass () const
 
virtual const PixelTypeGetUpper () const
 
void ThresholdAbove (PixelType thresh)
 
void ThresholdBelow (PixelType thresh)
 
void ThresholdBetween (PixelType lower, PixelType upper)
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, bool, TCoordRep >
bool Evaluate (const PointType &point) const override=0
 
virtual bool EvaluateAtContinuousIndex (const ContinuousIndexType &index) const=0
 
virtual bool EvaluateAtIndex (const IndexType &index) const=0
 
const InputImageTypeGetInputImage () 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
 
void ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
 
void ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
 
virtual const IndexTypeGetStartIndex () const
 
virtual const IndexTypeGetEndIndex () const
 
virtual const ContinuousIndexTypeGetStartContinuousIndex () const
 
virtual const ContinuousIndexTypeGetEndContinuousIndex () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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)
 
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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

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

Protected Member Functions

 BinaryThresholdImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~BinaryThresholdImageFunction () override=default
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, bool, TCoordRep >
 ImageFunction ()
 
 ~ImageFunction () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, bool >
 FunctionBase ()=default
 
 ~FunctionBase () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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

PixelType m_Lower
 
PixelType m_Upper
 

Additional Inherited Members

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

Detailed Description

template<typename TInputImage, typename TCoordRep = float>
class itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >

Returns true is the value of an image lies within a range of thresholds This ImageFunction returns true (or false) if the pixel value lies within (outside) a lower and upper threshold value. The threshold range can be set with the ThresholdBelow, ThresholdBetween or ThresholdAbove methods. The input image is set via method SetInputImage().

Methods Evaluate, EvaluateAtIndex and EvaluateAtContinuousIndex respectively evaluate the function at an geometric point, image index and continuous image index.

Examples
SphinxExamples/src/Core/Common/IterateImageStartingAtSeed/Code.cxx.

Definition at line 44 of file itkBinaryThresholdImageFunction.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TCoordRep = float>
using itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::ConstPointer = SmartPointer<const Self>

Definition at line 53 of file itkBinaryThresholdImageFunction.h.

◆ ContinuousIndexType

template<typename TInputImage , typename TCoordRep = float>
using itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::ContinuousIndexType = typename Superclass::ContinuousIndexType

ContinuousIndex type alias support

Definition at line 77 of file itkBinaryThresholdImageFunction.h.

◆ IndexType

template<typename TInputImage , typename TCoordRep = float>
using itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::IndexType = typename Superclass::IndexType

Index type alias support

Definition at line 74 of file itkBinaryThresholdImageFunction.h.

◆ InputImageType

template<typename TInputImage , typename TCoordRep = float>
using itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::InputImageType = typename Superclass::InputImageType

InputImageType type alias support

Definition at line 62 of file itkBinaryThresholdImageFunction.h.

◆ PixelType

template<typename TInputImage , typename TCoordRep = float>
using itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::PixelType = typename TInputImage::PixelType

Typedef to describe the type of pixel.

Definition at line 65 of file itkBinaryThresholdImageFunction.h.

◆ Pointer

template<typename TInputImage , typename TCoordRep = float>
using itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::Pointer = SmartPointer<Self>

Definition at line 52 of file itkBinaryThresholdImageFunction.h.

◆ PointType

template<typename TInputImage , typename TCoordRep = float>
using itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::PointType = typename Superclass::PointType

Point type alias support

Definition at line 71 of file itkBinaryThresholdImageFunction.h.

◆ Self

template<typename TInputImage , typename TCoordRep = float>
using itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::Self = BinaryThresholdImageFunction

Standard class type aliases.

Definition at line 50 of file itkBinaryThresholdImageFunction.h.

◆ Superclass

template<typename TInputImage , typename TCoordRep = float>
using itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::Superclass = ImageFunction<TInputImage, bool, TCoordRep>

Definition at line 51 of file itkBinaryThresholdImageFunction.h.

Constructor & Destructor Documentation

◆ BinaryThresholdImageFunction()

template<typename TInputImage , typename TCoordRep = float>
itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::BinaryThresholdImageFunction ( )
protected

◆ ~BinaryThresholdImageFunction()

template<typename TInputImage , typename TCoordRep = float>
itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::~BinaryThresholdImageFunction ( )
overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TInputImage , typename TCoordRep = float>
virtual::itk::LightObject::Pointer itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

Reimplemented in itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >.

◆ Evaluate()

template<typename TInputImage , typename TCoordRep = float>
bool itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::Evaluate ( const PointType point) const
inlineoverride

BinaryThreshold the image at a point 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.

Definition at line 89 of file itkBinaryThresholdImageFunction.h.

◆ EvaluateAtContinuousIndex()

template<typename TInputImage , typename TCoordRep = float>
bool itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType index) const
inlineoverride

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.

Definition at line 106 of file itkBinaryThresholdImageFunction.h.

◆ EvaluateAtIndex()

template<typename TInputImage , typename TCoordRep = float>
bool itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex ( const IndexType index) const
inlineoverride

BinaryThreshold the image at an 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.

Definition at line 123 of file itkBinaryThresholdImageFunction.h.

◆ GetLower()

template<typename TInputImage , typename TCoordRep = float>
virtual const PixelType& itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::GetLower ( ) const
virtual

Get the lower threshold value.

◆ GetNameOfClass()

template<typename TInputImage , typename TCoordRep = float>
virtual const char* itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageFunction< TInputImage, bool, TCoordRep >.

Reimplemented in itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >.

◆ GetUpper()

template<typename TInputImage , typename TCoordRep = float>
virtual const PixelType& itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::GetUpper ( ) const
virtual

Get the upper threshold value.

◆ New()

template<typename TInputImage , typename TCoordRep = float>
static Pointer itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TCoordRep = float>
void itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::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::Object.

Reimplemented in itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >.

◆ ThresholdAbove()

template<typename TInputImage , typename TCoordRep = float>
void itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::ThresholdAbove ( PixelType  thresh)

Values greater than or equal to the value are inside.

◆ ThresholdBelow()

template<typename TInputImage , typename TCoordRep = float>
void itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::ThresholdBelow ( PixelType  thresh)

Values less than or equal to the value are inside.

◆ ThresholdBetween()

template<typename TInputImage , typename TCoordRep = float>
void itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::ThresholdBetween ( PixelType  lower,
PixelType  upper 
)

Values that lie between lower and upper inclusive are inside.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TCoordRep = float>
constexpr unsigned int itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::ImageDimension = Superclass::ImageDimension
staticconstexpr

Dimension underlying input image.

Definition at line 68 of file itkBinaryThresholdImageFunction.h.

◆ m_Lower

template<typename TInputImage , typename TCoordRep = float>
PixelType itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::m_Lower
private

Definition at line 155 of file itkBinaryThresholdImageFunction.h.

◆ m_Upper

template<typename TInputImage , typename TCoordRep = float>
PixelType itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::m_Upper
private

Definition at line 156 of file itkBinaryThresholdImageFunction.h.


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