ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private 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 >:

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.

Definition at line 43 of file itkBinaryThresholdImageFunction.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::ContinuousIndexType 
ContinuousIndexType
 
typedef Superclass::IndexType IndexType
 
typedef Superclass::InputImageType InputImageType
 
typedef TInputImage::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef
BinaryThresholdImageFunction 
Self
 
typedef ImageFunction
< TInputImage, bool, TCoordRep > 
Superclass
 
- Public Types inherited from itk::ImageFunction< TInputImage, bool, TCoordRep >
typedef SmartPointer< const SelfConstPointer
 
typedef ContinuousIndex
< TCoordRep,
itkGetStaticConstMacro(ImageDimension) > 
ContinuousIndexType
 
typedef TCoordRep CoordRepType
 
typedef InputImageType::IndexType IndexType
 
typedef
InputImageType::IndexValueType 
IndexValueType
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef TInputImage InputImageType
 
typedef InputImageType::PixelType InputPixelType
 
typedef bool OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Point< TCoordRep,
itkGetStaticConstMacro(ImageDimension) > 
PointType
 
typedef ImageFunction Self
 
typedef FunctionBase< Point
< TCoordRep,
itkGetStaticConstMacro(ImageDimension) >
, bool > 
Superclass
 
- Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, bool >
typedef SmartPointer< const SelfConstPointer
 
typedef Point< TCoordRep,
TInputImage::ImageDimension > 
InputType
 
typedef bool OutputType
 
typedef SmartPointer< SelfPointer
 
typedef FunctionBase Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual bool Evaluate (const PointType &point) const override
 
virtual bool EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override
 
virtual 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 >
void ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
 
void ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
 
void ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
 
virtual bool Evaluate (const PointType &point) const override=0
 
virtual bool EvaluateAtContinuousIndex (const ContinuousIndexType &index) const =0
 
virtual bool EvaluateAtIndex (const IndexType &index) const =0
 
virtual const ContinuousIndexTypeGetEndContinuousIndex () const
 
virtual const IndexTypeGetEndIndex () const
 
const InputImageTypeGetInputImage () const
 
virtual const ContinuousIndexTypeGetStartContinuousIndex () const
 
virtual const IndexTypeGetStartIndex () 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
 
- Public Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, bool >
virtual OutputType Evaluate (const InputType &input) const =0
 
- 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
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
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 const unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, bool, TCoordRep >
static const unsigned int ImageDimension
 

Protected Member Functions

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

 BinaryThresholdImageFunction (const Self &) ITK_DELETE_FUNCTION
 
void operator= (const Self &) ITK_DELETE_FUNCTION
 

Private Attributes

PixelType m_Lower
 
PixelType m_Upper
 

Additional Inherited Members

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

Member Typedef Documentation

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

Definition at line 51 of file itkBinaryThresholdImageFunction.h.

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

ContinuousIndex typedef support.

Definition at line 75 of file itkBinaryThresholdImageFunction.h.

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

Index typedef support.

Definition at line 72 of file itkBinaryThresholdImageFunction.h.

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

InputImageType typedef support.

Definition at line 57 of file itkBinaryThresholdImageFunction.h.

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

Typedef to describe the type of pixel.

Definition at line 63 of file itkBinaryThresholdImageFunction.h.

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

Definition at line 50 of file itkBinaryThresholdImageFunction.h.

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

Point typedef support.

Definition at line 69 of file itkBinaryThresholdImageFunction.h.

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

Standard class typedefs.

Definition at line 48 of file itkBinaryThresholdImageFunction.h.

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

Definition at line 49 of file itkBinaryThresholdImageFunction.h.

Constructor & Destructor Documentation

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

Definition at line 143 of file itkBinaryThresholdImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::BinaryThresholdImageFunction ( const Self )
private

Member Function Documentation

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 >.

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

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.

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

Definition at line 86 of file itkBinaryThresholdImageFunction.h.

References itk::ImageFunction< TInputImage, bool, TCoordRep >::ConvertPointToNearestIndex(), and itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex().

template<typename TInputImage , typename TCoordRep = float>
virtual bool itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::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 in itk::NeighborhoodBinaryThresholdImageFunction< TInputImage, TCoordRep >.

Definition at line 102 of file itkBinaryThresholdImageFunction.h.

References itk::ImageFunction< TInputImage, bool, TCoordRep >::ConvertContinuousIndexToNearestIndex(), and itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex().

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

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.

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

Definition at line 119 of file itkBinaryThresholdImageFunction.h.

References itk::ImageFunction< TInputImage, bool, TCoordRep >::GetInputImage(), itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::m_Lower, and itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::m_Upper.

Referenced by itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::Evaluate(), and itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex().

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

Get the lower threshold value.

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 >.

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

Get the upper threshold value.

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

Method for creation through the object factory.

template<typename TInputImage , typename TCoordRep = float>
void itk::BinaryThresholdImageFunction< TInputImage, TCoordRep >::operator= ( const Self )
private
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 >.

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

Values greater than or equal to the value are inside.

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

Values less than or equal to the value are inside.

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

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

Dimension underlying input image.

Definition at line 66 of file itkBinaryThresholdImageFunction.h.

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

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