ITK  4.3.0
Insight Segmentation and Registration Toolkit
Classes | 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::LabelStatisticsImageFilter< TInputImage, TLabelImage > Class Template Reference

#include <itkLabelStatisticsImageFilter.h>

+ Inheritance diagram for itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >:
+ Collaboration diagram for itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >:

Detailed Description

template<class TInputImage, class TLabelImage>
class itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >

Given an intensity image and a label map, compute min, max, variance and mean of the pixels associated with each label or segment.

LabelStatisticsImageFilter computes the minimum, maximum, sum, mean, median, variance and sigma of regions of an intensity image, where the regions are defined via a label map (a second input). The label image should be integral type. The filter needs all of its input image. It behaves as a filter with an input and output. Thus it can be inserted in a pipline with other filters and the statistics will only be recomputed if a downstream filter changes.

Optionally, the filter also computes intensity histograms on each object. If histograms are enabled, a median intensity value can also be computed, although its accuracy is limited to the bin width of the histogram. If histograms are not enabled, the median returns zero.

The filter passes its intensity input through unmodified. The filter is threaded. It computes statistics in each thread then combines them in its AfterThreadedGenerate method.

Wiki Examples:

Definition at line 60 of file itkLabelStatisticsImageFilter.h.

Classes

class  LabelStatistics
 Statistics stored per label. More...
 

Public Types

typedef std::vector
< IndexValueType
BoundingBoxType
 
typedef SmartPointer< const SelfConstPointer
 
typedef DataObject::Pointer DataObjectPointer
 
typedef HistogramType::Pointer HistogramPointer
 
typedef
itk::Statistics::Histogram
< RealType
HistogramType
 
typedef TInputImage::IndexType IndexType
 
typedef TInputImage::Pointer InputImagePointer
 
typedef TLabelImage::Pointer LabelImagePointer
 
typedef TLabelImage LabelImageType
 
typedef TLabelImage::IndexType LabelIndexType
 
typedef TLabelImage::PixelType LabelPixelType
 
typedef TLabelImage::RegionType LabelRegionType
 
typedef TLabelImage::SizeType LabelSizeType
 
typedef itksys::hash_map
< LabelPixelType,
LabelStatistics >
::const_iterator 
MapConstIterator
 
typedef itksys::hash_map
< LabelPixelType,
LabelStatistics >::iterator 
MapIterator
 
typedef IdentifierType MapSizeType
 
typedef itksys::hash_map
< LabelPixelType,
LabelStatistics
MapType
 
typedef TInputImage::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef
SimpleDataObjectDecorator
< RealType
RealObjectType
 
typedef NumericTraits
< PixelType >::RealType 
RealType
 
typedef TInputImage::RegionType RegionType
 
typedef LabelStatisticsImageFilter Self
 
typedef TInputImage::SizeType SizeType
 
typedef ImageToImageFilter
< TInputImage, TInputImage > 
Superclass
 
typedef std::vector
< LabelPixelType
ValidLabelValuesContainerType
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
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< TInputImage > Superclass
 
- Public Types inherited from itk::ImageSource< TInputImage >
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 TInputImage 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 (void) const
 
BoundingBoxType GetBoundingBox (LabelPixelType label) const
 
MapSizeType GetCount (LabelPixelType label) const
 
HistogramPointer GetHistogram (LabelPixelType label) const
 
const LabelImageTypeGetLabelInput () const
 
RealType GetMaximum (LabelPixelType label) const
 
RealType GetMean (LabelPixelType label) const
 
RealType GetMedian (LabelPixelType label) const
 
RealType GetMinimum (LabelPixelType label) const
 
virtual const char * GetNameOfClass () const
 
MapSizeType GetNumberOfLabels () const
 
MapSizeType GetNumberOfObjects () const
 
RegionType GetRegion (LabelPixelType label) const
 
RealType GetSigma (LabelPixelType label) const
 
RealType GetSum (LabelPixelType label) const
 
virtual bool GetUseHistograms () const
 
virtual const
ValidLabelValuesContainerType
GetValidLabelValues () const
 
RealType GetVariance (LabelPixelType label) const
 
bool HasLabel (LabelPixelType label) const
 
void SetHistogramParameters (const int numBins, RealType lowerBound, RealType upperBound)
 
void SetLabelInput (const TLabelImage *input)
 
virtual void SetUseHistograms (bool _arg)
 
 typedef (Concept::HasNumericTraits< PixelType >) InputHasNumericTraitsCheck
 
virtual void UseHistogramsOff ()
 
virtual void UseHistogramsOn ()
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
virtual double GetCoordinateTolerance ()
 
const InputImageTypeGetInput (void) const
 
const InputImageTypeGetInput (unsigned int idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int, const TInputImage *image)
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance ()
 
- Public Member Functions inherited from itk::ImageSource< TInputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
OutputImageTypeGetOutput (void)
 
const OutputImageTypeGetOutput (void) const
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData ()
 
NameArray GetInputNames () const
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
virtual const float & GetProgress ()
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetProgress (float _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float amount)
 
DataObjectPointerArray GetInputs ()
 
DataObjectPointerArray GetOutputs ()
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag ()
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads ()
 
- 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 (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) 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
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () 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 Attributes

static const unsigned int ImageDimension = TInputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
static const unsigned int InputImageDimension
 
static const unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TInputImage >
static const unsigned int OutputImageDimension
 

Protected Member Functions

void AfterThreadedGenerateData ()
 
void AllocateOutputs ()
 
void BeforeThreadedGenerateData ()
 
void EnlargeOutputRequestedRegion (DataObject *data)
 
void GenerateInputRequestedRegion ()
 
 LabelStatisticsImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
void ThreadedGenerateData (const RegionType &outputRegionForThread, ThreadIdType threadId)
 
 ~LabelStatisticsImageFilter ()
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void VerifyInputInformation ()
 
void PushBackInput (const DataObject *input)
 
void PushFrontInput (const DataObject *input)
 
 ImageToImageFilter ()
 
 ~ImageToImageFilter ()
 
- Protected Member Functions inherited from itk::ImageSource< TInputImage >
virtual void GenerateData ()
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, 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 &)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs ()
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (void SetNumberOfOutputs(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 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 (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType)
 
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
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs ()
 
- 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

 LabelStatisticsImageFilter (const Self &)
 
void operator= (const Self &)
 

Private Attributes

MapType m_LabelStatistics
 
std::vector< MapTypem_LabelStatisticsPerThread
 
RealType m_LowerBound
 
SimpleFastMutexLock m_Mutex
 
HistogramType::SizeType m_NumBins
 
RealType m_UpperBound
 
bool m_UseHistograms
 
ValidLabelValuesContainerType m_ValidLabelValues
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage, TInputImage >
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(OutputImageDimension),
itkGetStaticConstMacro(InputImageDimension) > 
InputToOutputRegionCopierType
 
typedef
ImageToImageFilterDetail::ImageRegionCopier
< itkGetStaticConstMacro(InputImageDimension),
itkGetStaticConstMacro(OutputImageDimension) > 
OutputToInputRegionCopierType
 
- Static Protected Member Functions inherited from itk::ImageSource< TInputImage >
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 

Member Typedef Documentation

template<class TInputImage , class TLabelImage >
typedef std::vector< IndexValueType > itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::BoundingBoxType

Bounding Box-related typedefs

Definition at line 105 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef SmartPointer< const Self > itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::ConstPointer

Definition at line 68 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef DataObject::Pointer itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::DataObjectPointer

Smart Pointer type to a DataObject.

Definition at line 99 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef HistogramType::Pointer itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::HistogramPointer

Definition at line 109 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef itk::Statistics::Histogram< RealType > itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::HistogramType

Histogram-related typedefs

Definition at line 108 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef TInputImage::IndexType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::IndexType

Definition at line 80 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef TInputImage::Pointer itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::InputImagePointer

Image related typedefs.

Definition at line 74 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef TLabelImage::Pointer itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::LabelImagePointer

Definition at line 85 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef TLabelImage itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::LabelImageType

Label image related typedefs.

Definition at line 84 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef TLabelImage::IndexType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::LabelIndexType

Definition at line 88 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef TLabelImage::PixelType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::LabelPixelType

Definition at line 89 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef TLabelImage::RegionType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::LabelRegionType

Definition at line 86 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef TLabelImage::SizeType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::LabelSizeType

Definition at line 87 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef itksys::hash_map< LabelPixelType, LabelStatistics >::const_iterator itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::MapConstIterator

Definition at line 231 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef itksys::hash_map< LabelPixelType, LabelStatistics >::iterator itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::MapIterator

Definition at line 230 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef IdentifierType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::MapSizeType

Definition at line 232 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef itksys::hash_map< LabelPixelType, LabelStatistics > itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::MapType

Type of the map used to store data per label

Definition at line 229 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef TInputImage::PixelType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::PixelType

Definition at line 81 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef SmartPointer< Self > itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::Pointer

Definition at line 67 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef SimpleDataObjectDecorator< RealType > itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::RealObjectType

Type of DataObjects used for scalar outputs

Definition at line 102 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef NumericTraits< PixelType >::RealType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::RealType

Type to use for computations.

Definition at line 96 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef TInputImage::RegionType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::RegionType

Definition at line 78 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef LabelStatisticsImageFilter itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::Self

Standard Self typedef

Definition at line 65 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef TInputImage::SizeType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::SizeType

Definition at line 79 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef ImageToImageFilter< TInputImage, TInputImage > itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::Superclass

Definition at line 66 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
typedef std::vector<LabelPixelType> itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::ValidLabelValuesContainerType

Type of the container used to store valid label values

Definition at line 235 of file itkLabelStatisticsImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TLabelImage >
itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::LabelStatisticsImageFilter ( )
protected

End concept checking

template<class TInputImage , class TLabelImage >
itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::~LabelStatisticsImageFilter ( )
inlineprotected

Definition at line 327 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::LabelStatisticsImageFilter ( const Self )
private

Member Function Documentation

template<class TInputImage , class TLabelImage >
void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::AfterThreadedGenerateData ( )
protectedvirtual

Do final mean and variance computation from data accumulated in threads.

Reimplemented from itk::ImageSource< TInputImage >.

template<class TInputImage , class TLabelImage >
void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::AllocateOutputs ( )
protectedvirtual

Pass the input through unmodified. Do this by Grafting in the AllocateOutputs method.

Reimplemented from itk::ImageSource< TInputImage >.

template<class TInputImage , class TLabelImage >
void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::BeforeThreadedGenerateData ( )
protectedvirtual

Initialize some accumulators before the threads run.

Reimplemented from itk::ImageSource< TInputImage >.

template<class TInputImage , class TLabelImage >
virtual::itk::LightObject::Pointer itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::CreateAnother ( void  ) 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.

template<class TInputImage , class TLabelImage >
void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::EnlargeOutputRequestedRegion ( DataObject )
protectedvirtual

Give the process object a chance to indictate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Reimplemented from itk::ProcessObject.

template<class TInputImage , class TLabelImage >
void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GenerateInputRequestedRegion ( void  )
protectedvirtual

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

template<class TInputImage , class TLabelImage >
BoundingBoxType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetBoundingBox ( LabelPixelType  label) const

Return the computed bounding box for a label.

template<class TInputImage , class TLabelImage >
MapSizeType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetCount ( LabelPixelType  label) const

Return the number of pixels for a label.

template<class TInputImage , class TLabelImage >
HistogramPointer itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetHistogram ( LabelPixelType  label) const

Return the histogram for a label

template<class TInputImage , class TLabelImage >
const LabelImageType* itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetLabelInput ( ) const
inline

Get the label image

Definition at line 256 of file itkLabelStatisticsImageFilter.h.

References itk::ProcessObject::GetInput().

template<class TInputImage , class TLabelImage >
RealType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetMaximum ( LabelPixelType  label) const

Return the computed Maximum for a label.

template<class TInputImage , class TLabelImage >
RealType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetMean ( LabelPixelType  label) const

Return the computed Mean for a label.

template<class TInputImage , class TLabelImage >
RealType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetMedian ( LabelPixelType  label) const

Return the computed Median for a label. Requires histograms to be enabled!

template<class TInputImage , class TLabelImage >
RealType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetMinimum ( LabelPixelType  label) const

Return the computed Minimum for a label.

template<class TInputImage , class TLabelImage >
virtual const char* itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetNameOfClass ( ) const
virtual

Runtime information support.

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

template<class TInputImage , class TLabelImage >
MapSizeType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetNumberOfLabels ( ) const
inline

Definition at line 274 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
MapSizeType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetNumberOfObjects ( ) const
inline

Get the number of labels used

Definition at line 269 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
RegionType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetRegion ( LabelPixelType  label) const

Return the computed region.

template<class TInputImage , class TLabelImage >
RealType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetSigma ( LabelPixelType  label) const

Return the computed Standard Deviation for a label.

template<class TInputImage , class TLabelImage >
RealType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetSum ( LabelPixelType  label) const

Return the compute Sum for a label.

template<class TInputImage , class TLabelImage >
virtual bool itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetUseHistograms ( ) const
virtual
template<class TInputImage , class TLabelImage >
virtual const ValidLabelValuesContainerType& itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetValidLabelValues ( ) const
inlinevirtual

Definition at line 243 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
RealType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::GetVariance ( LabelPixelType  label) const

Return the computed Variance for a label.

template<class TInputImage , class TLabelImage >
bool itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::HasLabel ( LabelPixelType  label) const
inline

Does the specified label exist? Can only be called after a call a call to Update().

Definition at line 263 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
static Pointer itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::New ( )
static

Method for creation through the object factory.

template<class TInputImage , class TLabelImage >
void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::operator= ( const Self )
private
template<class TInputImage , class TLabelImage >
void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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

template<class TInputImage , class TLabelImage >
void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::SetHistogramParameters ( const int  numBins,
RealType  lowerBound,
RealType  upperBound 
)

specify Histogram parameters

template<class TInputImage , class TLabelImage >
void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::SetLabelInput ( const TLabelImage *  input)
inline

Set the label image

Definition at line 249 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
virtual void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::SetUseHistograms ( bool  _arg)
virtual
template<class TInputImage , class TLabelImage >
void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::ThreadedGenerateData ( const RegionType outputRegionForThread,
ThreadIdType  threadId 
)
protected

Multi-thread version GenerateData.

template<class TInputImage , class TLabelImage >
itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::typedef ( Concept::HasNumericTraits< PixelType )

Begin concept checking This class requires InputHasNumericTraitsCheck in the form of ( Concept::HasNumericTraits< PixelType > )

template<class TInputImage , class TLabelImage >
virtual void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::UseHistogramsOff ( )
virtual
template<class TInputImage , class TLabelImage >
virtual void itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::UseHistogramsOn ( )
virtual

Member Data Documentation

template<class TInputImage , class TLabelImage >
const unsigned int itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::ImageDimension = TInputImage::ImageDimension
static

Image related typedefs.

Definition at line 93 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
MapType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::m_LabelStatistics
private

Definition at line 357 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
std::vector< MapType > itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::m_LabelStatisticsPerThread
private

Definition at line 356 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
RealType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::m_LowerBound
private

Definition at line 364 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
SimpleFastMutexLock itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::m_Mutex
private

Definition at line 366 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
HistogramType::SizeType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::m_NumBins
private

Definition at line 362 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
RealType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::m_UpperBound
private

Definition at line 365 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
bool itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::m_UseHistograms
private

Definition at line 360 of file itkLabelStatisticsImageFilter.h.

template<class TInputImage , class TLabelImage >
ValidLabelValuesContainerType itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::m_ValidLabelValues
private

Definition at line 358 of file itkLabelStatisticsImageFilter.h.


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