ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage > Class Template Reference

#include <itkHistogramThresholdImageFilter.h>

+ Inheritance diagram for itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >:
+ Collaboration diagram for itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >:

Detailed Description

template<typename TInputImage, typename TOutputImage, typename TMaskImage = TOutputImage>
class itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >

Threshold an image using a HistogramThresholdCalculator.

This filter creates a binary thresholded image that separates an image into foreground and background components. The filter computes the threshold using a user provided HistogramThresholdCalculator and applies that threshold to the input image using the BinaryThresholdImageFilter.

The filter also has the option of providing a mask, in which case the histogram and therefore the threshold is computed from the parts of the mask with values indicated by MaskValue. The output image is, by default, masked by the same image. This output masking can be disabled using SetMaskOutput(false). Note that there is an inconsistency here. The MaskImageFilter (used internally) masks by non zero values, where as the MaskedImageToHistogramFilter uses explicit values. If this does not match your usage then the output masking will need to be managed by the user.

Author
Richard Beare. Department of Medicine, Monash University, Melbourne, Australia.
Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

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 61 of file itkHistogramThresholdImageFilter.h.

Public Types

using CalculatorPointer = typename CalculatorType::Pointer
 
using CalculatorType = HistogramThresholdCalculator< HistogramType, InputPixelType >
 
using ConstPointer = SmartPointer< const Self >
 
using HistogramConstPointer = typename HistogramType::ConstPointer
 
using HistogramMeasurementType = typename HistogramType::MeasurementType
 
using HistogramMeasurementVectorType = typename HistogramType::MeasurementVectorType
 
using HistogramPointer = typename HistogramType::Pointer
 
using HistogramSizeType = typename HistogramType::SizeType
 
using HistogramType = Statistics::Histogram< ValueRealType >
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using InputIndexType = typename InputImageType::IndexType
 
using InputPixelType = typename InputImageType::PixelType
 
using InputSizeType = typename InputImageType::SizeType
 
using MaskImagePointer = typename MaskImageType::Pointer
 
using MaskImageRegionType = typename MaskImageType::RegionType
 
using MaskImageType = TMaskImage
 
using MaskIndexType = typename MaskImageType::IndexType
 
using MaskPixelType = typename MaskImageType::PixelType
 
using MaskSizeType = typename MaskImageType::SizeType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using OutputIndexType = typename OutputImageType::IndexType
 
using OutputPixelType = typename OutputImageType::PixelType
 
using OutputSizeType = typename OutputImageType::SizeType
 
using Pointer = SmartPointer< Self >
 
using Self = HistogramThresholdImageFilter
 
using Superclass = ImageToImageFilter< TInputImage, TOutputImage >
 
using ValueRealType = typename NumericTraits< ValueType >::RealType
 
using ValueType = typename NumericTraits< InputPixelType >::ValueType
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using OutputImagePixelType = typename Superclass::OutputImagePixelType
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< TOutputImage >
 
- Public Types inherited from itk::ImageSource< TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
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
 
virtual OutputPixelType GetInsideValue () const
 
virtual const char * GetNameOfClass () const
 
virtual OutputPixelType GetOutsideValue () const
 
virtual InputPixelType GetThreshold () const
 
void SetInput1 (const TInputImage *input)
 
void SetInput2 (const TMaskImage *input)
 
virtual void SetInsideValue (OutputPixelType _arg)
 
virtual void SetOutsideValue (OutputPixelType _arg)
 
virtual void SetMaskImage (const TMaskImage *input)
 
virtual const TMaskImage * GetMaskImage () const
 
virtual void SetNumberOfHistogramBins (unsigned int _arg)
 
virtual unsigned int GetNumberOfHistogramBins () const
 
virtual void SetAutoMinimumMaximum (bool _arg)
 
virtual bool GetAutoMinimumMaximum () const
 
virtual void AutoMinimumMaximumOn ()
 
virtual void AutoMinimumMaximumOff ()
 
virtual void SetMaskOutput (bool _arg)
 
virtual bool GetMaskOutput () const
 
virtual void MaskOutputOn ()
 
virtual void MaskOutputOff ()
 
virtual void SetMaskValue (MaskPixelType _arg)
 
virtual MaskPixelType GetMaskValue () const
 
virtual void SetCalculator (CalculatorType *_arg)
 
virtual CalculatorTypeGetModifiableCalculator ()
 
virtual const CalculatorTypeGetCalculator () const
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () 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 noexceptoverride
 
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 InputImageDimension = InputImageType::ImageDimension
 
static constexpr unsigned int MaskImageDimension = MaskImageType::ImageDimension
 
static constexpr unsigned int OutputImageDimension = OutputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 

Protected Member Functions

void GenerateData () override
 
void GenerateInputRequestedRegion () override
 
 HistogramThresholdImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~HistogramThresholdImageFilter () override=default
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
 ImageToImageFilter ()
 
void VerifyInputInformation () ITKv5_CONST override
 
 ~ImageToImageFilter () override
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
virtual void DynamicMultiThreadingOff ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
 ~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

bool m_AutoMinimumMaximum
 
CalculatorPointer m_Calculator
 
OutputPixelType m_InsideValue
 
bool m_MaskOutput { true }
 
MaskPixelType m_MaskValue
 
unsigned m_NumberOfHistogramBins { 256 }
 
OutputPixelType m_OutsideValue
 
InputPixelType m_Threshold
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static
ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION 
ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::CalculatorPointer = typename CalculatorType::Pointer

Definition at line 113 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::CalculatorType = HistogramThresholdCalculator<HistogramType, InputPixelType>

Definition at line 112 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::ConstPointer = SmartPointer<const Self>

Definition at line 71 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::HistogramConstPointer = typename HistogramType::ConstPointer

Definition at line 107 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::HistogramMeasurementType = typename HistogramType::MeasurementType

Definition at line 109 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::HistogramMeasurementVectorType = typename HistogramType::MeasurementVectorType

Definition at line 110 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::HistogramPointer = typename HistogramType::Pointer

Definition at line 106 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::HistogramSizeType = typename HistogramType::SizeType

Definition at line 108 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::HistogramType = Statistics::Histogram< ValueRealType >

Definition at line 105 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::InputImagePointer = typename InputImageType::Pointer

Image related type alias.

Definition at line 89 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 95 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::InputImageType = TInputImage

Definition at line 79 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::InputIndexType = typename InputImageType::IndexType

Definition at line 94 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::InputPixelType = typename InputImageType::PixelType

Image pixel value type alias.

Definition at line 84 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::InputSizeType = typename InputImageType::SizeType

Definition at line 93 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::MaskImagePointer = typename MaskImageType::Pointer

Definition at line 91 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::MaskImageRegionType = typename MaskImageType::RegionType

Definition at line 101 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::MaskImageType = TMaskImage

Definition at line 81 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::MaskIndexType = typename MaskImageType::IndexType

Definition at line 100 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::MaskPixelType = typename MaskImageType::PixelType

Definition at line 86 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::MaskSizeType = typename MaskImageType::SizeType

Definition at line 99 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 90 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 98 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputImageType = TOutputImage

Definition at line 80 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputIndexType = typename OutputImageType::IndexType

Definition at line 97 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputPixelType = typename OutputImageType::PixelType

Definition at line 85 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputSizeType = typename OutputImageType::SizeType

Definition at line 96 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::Pointer = SmartPointer<Self>

Definition at line 70 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::Self = HistogramThresholdImageFilter

Standard Self type alias

Definition at line 68 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::Superclass = ImageToImageFilter<TInputImage,TOutputImage>

Definition at line 69 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::ValueRealType = typename NumericTraits< ValueType >::RealType

Definition at line 104 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
using itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::ValueType = typename NumericTraits< InputPixelType >::ValueType

Definition at line 103 of file itkHistogramThresholdImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::HistogramThresholdImageFilter ( )
protected
template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::~HistogramThresholdImageFilter ( )
overrideprotecteddefault

Member Function Documentation

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::AutoMinimumMaximumOff ( )
virtual

Does histogram generator compute min and max from data? Default is true for all but char types

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::AutoMinimumMaximumOn ( )
virtual

Does histogram generator compute min and max from data? Default is true for all but char types

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual::itk::LightObject::Pointer itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::CreateAnother ( ) const
virtual
template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::GenerateData ( )
overrideprotectedvirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling DynamicThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter can be threaded, it should NOT provide a GenerateData() method but should provide a DynamicThreadedGenerateData() instead.

See Also
ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in itk::OtsuThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >.

Referenced by itk::OtsuThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::GenerateData().

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::GenerateInputRequestedRegion ( )
overrideprotectedvirtual

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierarchy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.

See Also
ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual bool itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::GetAutoMinimumMaximum ( ) const
virtual

Does histogram generator compute min and max from data? Default is true for all but char types

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual const CalculatorType* itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::GetCalculator ( ) const
virtual

Set/Get the calculator to use to compute the threshold

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual OutputPixelType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::GetInsideValue ( ) const
virtual

Get the "inside" pixel value.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual const TMaskImage* itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::GetMaskImage ( ) const
virtual

Set and Get the mask image

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual bool itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::GetMaskOutput ( ) const
virtual

Do you want the output to be masked by the mask used in histogram construction. Only relevant if masking is in use. Default is true.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual MaskPixelType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::GetMaskValue ( ) const
virtual

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

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual CalculatorType* itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::GetModifiableCalculator ( )
virtual

Set/Get the calculator to use to compute the threshold

Referenced by itk::OtsuThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::GenerateData().

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual const char* itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::GetNameOfClass ( ) const
virtual
template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual unsigned int itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::GetNumberOfHistogramBins ( ) const
virtual

Set the number of histogram bins

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual OutputPixelType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::GetOutsideValue ( ) const
virtual

Get the "outside" pixel value.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual InputPixelType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::GetThreshold ( ) const
virtual

Get the computed threshold.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::MaskOutputOff ( )
virtual

Do you want the output to be masked by the mask used in histogram construction. Only relevant if masking is in use. Default is true.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::MaskOutputOn ( )
virtual

Do you want the output to be masked by the mask used in histogram construction. Only relevant if masking is in use. Default is true.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
static Pointer itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::New ( )
static

Method for creation through the object factory.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::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::ImageToImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::IntermodesThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >.

Referenced by itk::IntermodesThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::PrintSelf().

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::SetAutoMinimumMaximum ( bool  _arg)
virtual

Does histogram generator compute min and max from data? Default is true for all but char types

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::SetCalculator ( CalculatorType _arg)
virtual
template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::SetInput1 ( const TInputImage *  input)
inline

Set the input image

Definition at line 126 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::SetInput2 ( const TMaskImage *  input)
inline

Set the marker image

Definition at line 132 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::SetInsideValue ( OutputPixelType  _arg)
virtual

Set the "inside" pixel value. The default value NumericTraits<OutputPixelType>::max()

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::SetMaskImage ( const TMaskImage *  input)
virtual

Set and Get the mask image

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::SetMaskOutput ( bool  _arg)
virtual

Do you want the output to be masked by the mask used in histogram construction. Only relevant if masking is in use. Default is true.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::SetMaskValue ( MaskPixelType  _arg)
virtual

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

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::SetNumberOfHistogramBins ( unsigned int  _arg)
virtual

Set the number of histogram bins

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
virtual void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::SetOutsideValue ( OutputPixelType  _arg)
virtual

Set the "outside" pixel value. The default value NumericTraits<OutputPixelType>::ZeroValue().

Member Data Documentation

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
constexpr unsigned int itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::InputImageDimension = InputImageType::ImageDimension
static

Image related type alias.

Definition at line 116 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
bool itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::m_AutoMinimumMaximum
private

Definition at line 212 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
CalculatorPointer itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::m_Calculator
private

Definition at line 210 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
OutputPixelType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::m_InsideValue
private

Definition at line 206 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
bool itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::m_MaskOutput { true }
private

Definition at line 213 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
MaskPixelType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::m_MaskValue
private

Definition at line 209 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
unsigned itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::m_NumberOfHistogramBins { 256 }
private

Definition at line 211 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
OutputPixelType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::m_OutsideValue
private

Definition at line 207 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
InputPixelType itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::m_Threshold
private

Definition at line 208 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
constexpr unsigned int itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::MaskImageDimension = MaskImageType::ImageDimension
static

Definition at line 118 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
constexpr unsigned int itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::OutputImageDimension = OutputImageType::ImageDimension
static

Definition at line 117 of file itkHistogramThresholdImageFilter.h.


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