ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Private Attributes | List of all members
itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage > Class Template Reference
Group Numerics » Module ITKStatistics

#include <itkImageToListSampleFilter.h>

Detailed Description

template<typename TImage, typename TMaskImage = TImage>
class itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >

The class takes an image as input and generates a list sample as output.

There are differences between this class and ImageToListSampleAdaptor. This class is not an adaptor. It creates a new list sample and does not provide a pseudo interface to the actual image to make it look like a list sample.

The class optionally allows you to specify a mask image as an input. The list sample (if a mask is specified) is constructed from pixels that are within the mask

Todo:
In future allow the filter to take a Spatial object as input so a generic spatial object like an ellipse etc can be used as a mask. Sure the ImageMaskSpatialObject can represent image masks too, so why not make SpatialObjects the default. I think the ImageMaskSpatialObject is slow in terms of inefficient iteration through the image.
See also
ImageToListSampleAdaptor

Definition at line 56 of file itkImageToListSampleFilter.h.

+ Inheritance diagram for itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >:
+ Collaboration diagram for itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ImageConstPointer = typename ImageType::ConstPointer
 
using ImagePointer = typename ImageType::Pointer
 
using ImageType = TImage
 
using ListSampleType = ListSample< MeasurementVectorType >
 
using MaskImageConstPointer = typename MaskImageType::ConstPointer
 
using MaskImagePointer = typename MaskImageType::Pointer
 
using MaskImageType = TMaskImage
 
using MaskPixelType = typename MaskImageType::PixelType
 
using MeasurementVectorType = typename MeasurementVectorPixelTraits< PixelType >::MeasurementVectorType
 
using PixelType = typename ImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToListSampleFilter
 
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

const ImageType * GetInput () const
 
const MaskImageType * GetMaskImage () const
 
unsigned int GetMeasurementVectorSize () const
 
const char * GetNameOfClass () const override
 
const ListSampleType * GetOutput () const
 
void SetInput (const ImageType *image)
 
void SetMaskImage (const MaskImageType *image)
 
virtual void SetMaskValue (MaskPixelType _arg)
 
virtual MaskPixelType GetMaskValue () const
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderType * GetMultiThreader () const
 
const char * GetNameOfClass () const override
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
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 val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdType & GetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStamp & GetTimeStamp () 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) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

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

Protected Types

using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 

Protected Member Functions

void GenerateData () override
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputInformation () override
 
 ImageToListSampleFilter ()
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageToListSampleFilter () override=default
 
- 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 GenerateData ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (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
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
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 idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation () const
 
virtual void VerifyPreconditions () const
 
 ~ProcessObject () override
 
DataObject * GetInput (DataObjectPointerArraySizeType idx)
 
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
 
DataObject * GetPrimaryInput ()
 
const DataObject * GetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObject * GetOutput (const DataObjectIdentifierType &key)
 
const DataObject * GetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObject * GetOutput (DataObjectPointerArraySizeType i)
 
const DataObject * GetOutput (DataObjectPointerArraySizeType i) const
 
DataObject * GetPrimaryOutput ()
 
const DataObject * GetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~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 PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

MaskPixelType m_MaskValue {}
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
 
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- 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

◆ ConstPointer

template<typename TImage , typename TMaskImage = TImage>
using itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::ConstPointer = SmartPointer<const Self>

Definition at line 65 of file itkImageToListSampleFilter.h.

◆ DataObjectPointer

template<typename TImage , typename TMaskImage = TImage>
using itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::DataObjectPointer = DataObject::Pointer
protected

Standard itk::ProcessObject subclass method.

Definition at line 129 of file itkImageToListSampleFilter.h.

◆ DataObjectPointerArraySizeType

template<typename TImage , typename TMaskImage = TImage>
using itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
protected

Definition at line 130 of file itkImageToListSampleFilter.h.

◆ ImageConstPointer

template<typename TImage , typename TMaskImage = TImage>
using itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::ImageConstPointer = typename ImageType::ConstPointer

Definition at line 76 of file itkImageToListSampleFilter.h.

◆ ImagePointer

template<typename TImage , typename TMaskImage = TImage>
using itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::ImagePointer = typename ImageType::Pointer

Definition at line 75 of file itkImageToListSampleFilter.h.

◆ ImageType

template<typename TImage , typename TMaskImage = TImage>
using itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::ImageType = TImage

Image type alias

Definition at line 74 of file itkImageToListSampleFilter.h.

◆ ListSampleType

template<typename TImage , typename TMaskImage = TImage>
using itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::ListSampleType = ListSample<MeasurementVectorType>

Type of the output list sample

Definition at line 87 of file itkImageToListSampleFilter.h.

◆ MaskImageConstPointer

template<typename TImage , typename TMaskImage = TImage>
using itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::MaskImageConstPointer = typename MaskImageType::ConstPointer

Definition at line 83 of file itkImageToListSampleFilter.h.

◆ MaskImagePointer

template<typename TImage , typename TMaskImage = TImage>
using itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::MaskImagePointer = typename MaskImageType::Pointer

Definition at line 82 of file itkImageToListSampleFilter.h.

◆ MaskImageType

template<typename TImage , typename TMaskImage = TImage>
using itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::MaskImageType = TMaskImage

Mask Image type alias

Definition at line 81 of file itkImageToListSampleFilter.h.

◆ MaskPixelType

template<typename TImage , typename TMaskImage = TImage>
using itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::MaskPixelType = typename MaskImageType::PixelType

Definition at line 84 of file itkImageToListSampleFilter.h.

◆ MeasurementVectorType

template<typename TImage , typename TMaskImage = TImage>
using itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::MeasurementVectorType = typename MeasurementVectorPixelTraits<PixelType>::MeasurementVectorType

Definition at line 78 of file itkImageToListSampleFilter.h.

◆ PixelType

template<typename TImage , typename TMaskImage = TImage>
using itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::PixelType = typename ImageType::PixelType

Definition at line 77 of file itkImageToListSampleFilter.h.

◆ Pointer

template<typename TImage , typename TMaskImage = TImage>
using itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::Pointer = SmartPointer<Self>

Definition at line 64 of file itkImageToListSampleFilter.h.

◆ Self

template<typename TImage , typename TMaskImage = TImage>
using itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::Self = ImageToListSampleFilter

Standard class type aliases

Definition at line 62 of file itkImageToListSampleFilter.h.

◆ Superclass

template<typename TImage , typename TMaskImage = TImage>
using itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::Superclass = ProcessObject

Definition at line 63 of file itkImageToListSampleFilter.h.

Constructor & Destructor Documentation

◆ ImageToListSampleFilter()

template<typename TImage , typename TMaskImage = TImage>
itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::ImageToListSampleFilter ( )
protected

◆ ~ImageToListSampleFilter()

template<typename TImage , typename TMaskImage = TImage>
itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::~ImageToListSampleFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ GenerateData()

template<typename TImage , typename TMaskImage = TImage>
void itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GenerateData ( )
overrideprotectedvirtual

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

◆ GenerateInputRequestedRegion()

template<typename TImage , typename TMaskImage = TImage>
void itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GenerateInputRequestedRegion ( )
overrideprotectedvirtual

This method ensures that a mask image if specified has requested regions that at least contain the input image's buffered region.

Reimplemented from itk::ProcessObject.

◆ GenerateOutputInformation()

template<typename TImage , typename TMaskImage = TImage>
void itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GenerateOutputInformation ( )
overrideprotectedvirtual

Generate the information describing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented from itk::ProcessObject.

◆ GetInput()

template<typename TImage , typename TMaskImage = TImage>
const ImageType * itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GetInput ( ) const

◆ GetMaskImage()

template<typename TImage , typename TMaskImage = TImage>
const MaskImageType * itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GetMaskImage ( ) const

◆ GetMaskValue()

template<typename TImage , typename TMaskImage = TImage>
virtual MaskPixelType itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GetMaskValue ( ) const
virtual

Set the pixel value treated as on in the mask. If a mask has been specified, only pixels with this value will be added to the list sample, if no mask has been specified all pixels will be added as measurement vectors to the list sample.

◆ GetMeasurementVectorSize()

template<typename TImage , typename TMaskImage = TImage>
unsigned int itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GetMeasurementVectorSize ( ) const

return the number of components of the input image

◆ GetNameOfClass()

template<typename TImage , typename TMaskImage = TImage>
const char * itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

◆ GetOutput()

template<typename TImage , typename TMaskImage = TImage>
const ListSampleType * itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::GetOutput ( ) const

Method to get the list sample, the generated output. Note that this does not invoke Update(). You should have called update on this class to get any meaningful output.

◆ MakeOutput()

template<typename TImage , typename TMaskImage = TImage>
DataObjectPointer itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::MakeOutput ( DataObjectPointerArraySizeType  idx)
overrideprotectedvirtual

Make a DataObject of the correct type to used as the specified output.

Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a itkSmartPointer to a DataObject. ImageSource and MeshSource override this method to create the correct type of image and mesh respectively. If a filter has multiple outputs of different types, then that filter must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

◆ New()

template<typename TImage , typename TMaskImage = TImage>
static Pointer itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TImage , typename TMaskImage = TImage>
void itk::Statistics::ImageToListSampleFilter< TImage, 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::ProcessObject.

◆ SetInput()

template<typename TImage , typename TMaskImage = TImage>
void itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::SetInput ( const ImageType *  image)

◆ SetMaskImage()

template<typename TImage , typename TMaskImage = TImage>
void itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::SetMaskImage ( const MaskImageType *  image)

Method to set/get the mask

◆ SetMaskValue()

template<typename TImage , typename TMaskImage = TImage>
virtual void itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::SetMaskValue ( MaskPixelType  _arg)
virtual

Set the pixel value treated as on in the mask. If a mask has been specified, only pixels with this value will be added to the list sample, if no mask has been specified all pixels will be added as measurement vectors to the list sample.

Member Data Documentation

◆ m_MaskValue

template<typename TImage , typename TMaskImage = TImage>
MaskPixelType itk::Statistics::ImageToListSampleFilter< TImage, TMaskImage >::m_MaskValue {}
private

Definition at line 148 of file itkImageToListSampleFilter.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3