ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | 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 theshold 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 doesn't 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: http://hdl.handle.net/10380/3279 or http://www.insight-journal.org/browse/publication/811

Definition at line 60 of file itkHistogramThresholdImageFilter.h.

Public Types

typedef CalculatorType::Pointer CalculatorPointer
 
typedef
HistogramThresholdCalculator
< HistogramType,
InputPixelType
CalculatorType
 
typedef SmartPointer< const SelfConstPointer
 
typedef HistogramType::ConstPointer HistogramConstPointer
 
typedef
HistogramType::MeasurementType 
HistogramMeasurementType
 
typedef
HistogramType::MeasurementVectorType 
HistogramMeasurementVectorType
 
typedef HistogramType::Pointer HistogramPointer
 
typedef HistogramType::SizeType HistogramSizeType
 
typedef Statistics::Histogram
< ValueRealType
HistogramType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef InputImageType::IndexType InputIndexType
 
typedef InputImageType::PixelType InputPixelType
 
typedef InputImageType::SizeType InputSizeType
 
typedef MaskImageType::Pointer MaskImagePointer
 
typedef MaskImageType::RegionType MaskImageRegionType
 
typedef TMaskImage MaskImageType
 
typedef MaskImageType::IndexType MaskIndexType
 
typedef MaskImageType::PixelType MaskPixelType
 
typedef MaskImageType::SizeType MaskSizeType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef OutputImageType::IndexType OutputIndexType
 
typedef OutputImageType::PixelType OutputPixelType
 
typedef OutputImageType::SizeType OutputSizeType
 
typedef SmartPointer< SelfPointer
 
typedef
HistogramThresholdImageFilter 
Self
 
typedef ImageToImageFilter
< TInputImage, TOutputImage > 
Superclass
 
typedef NumericTraits
< ValueType >::RealType 
ValueRealType
 
typedef NumericTraits
< InputPixelType >::ValueType 
ValueType
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
 
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToImageFilter Self
 
typedef ImageSource< TOutputImage > Superclass
 
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef OutputImageType::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject 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 OutputPixelType GetInsideValue () const
 
const MaskImageTypeGetMaskImage () 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)
 
void SetMaskImage (const TMaskImage *input)
 
virtual void SetOutsideValue (OutputPixelType _arg)
 
 typedef (Concept::EqualityComparable< OutputPixelType >) OutputEqualityComparableCheck
 
 typedef (Concept::OStreamWritable< InputPixelType >) InputOStreamWritableCheck
 
 typedef (Concept::OStreamWritable< OutputPixelType >) OutputOStreamWritableCheck
 
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
 
virtual void PopBackInput () override
 
virtual 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)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *output)
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
virtual
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 ()
 
MultiThreader * GetMultiThreader () 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)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
void SetProgress (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 SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () 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
 
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 InputImageDimension = InputImageType::ImageDimension
 
static const unsigned int OutputImageDimension = OutputImageType::ImageDimension
 
static const unsigned int MaskImageDimension = MaskImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const 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 ()
 
- 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 ()
 
virtual void VerifyInputInformation () override
 
 ~ImageToImageFilter ()
 
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 ()
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual ~ImageSource ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
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
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
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 ()
 
 ~ProcessObject ()
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) 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)
 
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 ()
 

Protected Attributes

bool m_AutoMinimumMaximum
 
CalculatorPointer m_Calculator
 
OutputPixelType m_InsideValue
 
bool m_MaskOutput
 
MaskPixelType m_MaskValue
 
unsigned m_NumberOfHistogramBins
 
OutputPixelType m_OutsideValue
 
InputPixelType m_Threshold
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Private Member Functions

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

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
 
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 

Member Typedef Documentation

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

Definition at line 110 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 109 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 68 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 104 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 106 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 107 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 103 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 105 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 102 of file itkHistogramThresholdImageFilter.h.

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

Image related typedefs.

Definition at line 86 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 92 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 74 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 91 of file itkHistogramThresholdImageFilter.h.

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

Image pixel value typedef.

Definition at line 81 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 90 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 88 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 98 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 78 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 97 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 83 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 96 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 87 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 95 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 77 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 94 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 82 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 93 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 67 of file itkHistogramThresholdImageFilter.h.

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

Standard Self typedef

Definition at line 65 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 66 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 101 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 100 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 ( )
inlineprotected

Definition at line 211 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::HistogramThresholdImageFilter ( const Self )
private

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 ThreadedGenerateData(). 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 an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See Also
ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

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>
const MaskImageType* itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::GetMaskImage ( ) const
inline

Get the marker image

Definition at line 131 of file itkHistogramThresholdImageFilter.h.

References itk::ProcessObject::GetInput().

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

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 >::operator= ( const Self )
private
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
template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::SetInput2 ( const TMaskImage *  input)
inline
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>
void itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::SetMaskImage ( const TMaskImage *  input)
inline

Set and Get the mask image Set the marker image

Definition at line 124 of file itkHistogramThresholdImageFilter.h.

References itk::ProcessObject::SetNthInput().

Referenced by itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::SetInput2().

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

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::typedef ( Concept::EqualityComparable< OutputPixelType )

This class requires OutputEqualityComparableCheck in the form of (Concept::EqualityComparable<OutputPixelType>)

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::typedef ( Concept::OStreamWritable< InputPixelType )

This class requires InputOStreamWritableCheck in the form of (Concept::OStreamWritable<InputPixelType>)

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::typedef ( Concept::OStreamWritable< OutputPixelType )

This class requires OutputOStreamWritableCheck in the form of (Concept::OStreamWritable<OutputPixelType>)

Member Data Documentation

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

Image related typedefs.

Definition at line 114 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 223 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 221 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 217 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
bool itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::m_MaskOutput
protected

Definition at line 224 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 220 of file itkHistogramThresholdImageFilter.h.

template<typename TInputImage , typename TOutputImage , typename TMaskImage = TOutputImage>
unsigned itk::HistogramThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::m_NumberOfHistogramBins
protected

Definition at line 222 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 218 of file itkHistogramThresholdImageFilter.h.

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

Definition at line 219 of file itkHistogramThresholdImageFilter.h.

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

Image related typedefs.

Definition at line 118 of file itkHistogramThresholdImageFilter.h.

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

Image related typedefs.

Definition at line 116 of file itkHistogramThresholdImageFilter.h.


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