ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType > Class Template Reference

#include <itkMaskNeighborhoodOperatorImageFilter.h>

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ImageBoundaryConditionPointerType = ImageBoundaryCondition< OutputImageType > *
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageType = TInputImage
 
using InputInternalPixelType = typename TInputImage::InternalPixelType
 
using InputPixelType = typename TInputImage::PixelType
 
using MaskImagePointer = typename MaskImageType::Pointer
 
using MaskImageType = TMaskImage
 
using MaskInternalPixelType = typename TMaskImage::InternalPixelType
 
using MaskPixelType = typename TMaskImage::PixelType
 
using OperatorValueType = typename Superclass::OperatorValueType
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using OutputImageType = TOutputImage
 
using OutputInternalPixelType = typename TOutputImage::InternalPixelType
 
using OutputNeighborhoodType = typename Superclass::OutputNeighborhoodType
 
using OutputPixelType = typename TOutputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using Self = MaskNeighborhoodOperatorImageFilter
 
using Superclass = NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >
 
- Public Types inherited from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >
using ComputingPixelType = typename NumericTraits< OutputPixelType >::RealType
 
using ConstPointer = SmartPointer< const Self >
 
using DefaultBoundaryCondition = ZeroFluxNeumannBoundaryCondition< InputImageType >
 
using ImageBoundaryConditionPointerType = ImageBoundaryCondition< InputImageType > *
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageType = TInputImage
 
using InputInternalPixelType = typename TInputImage::InternalPixelType
 
using InputPixelType = typename TInputImage::PixelType
 
using InputPixelValueType = typename NumericTraits< InputPixelType >::ValueType
 
using OperatorValueType = TOperatorValueType
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using OutputImageType = TOutputImage
 
using OutputInternalPixelType = typename TOutputImage::InternalPixelType
 
using OutputNeighborhoodType = Neighborhood< OperatorValueType, Self::ImageDimension >
 
using OutputPixelType = typename TOutputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using Self = NeighborhoodOperatorImageFilter
 
using Superclass = ImageToImageFilter< TInputImage, TOutputImage >
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using OutputImagePixelType = typename Superclass::OutputImagePixelType
 
using OutputImageRegionType = typename Superclass::OutputImageRegionType
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< TOutputImage >
 
- Public Types inherited from itk::ImageSource< TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual OutputPixelType GetDefaultValue () const
 
const TMaskImage * GetMaskImage () const
 
virtual const char * GetNameOfClass () const
 
virtual const bool & GetUseDefaultValue () const
 
virtual void SetDefaultValue (OutputPixelType _arg)
 
void SetMaskImage (const TMaskImage *mask)
 
virtual void SetUseDefaultValue (bool _arg)
 
virtual void UseDefaultValueOff ()
 
virtual void UseDefaultValueOn ()
 
- Public Member Functions inherited from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
void SetOperator (const OutputNeighborhoodType &p)
 
const OutputNeighborhoodTypeGetOperator () const
 
void OverrideBoundaryCondition (const ImageBoundaryConditionPointerType i)
 
ImageBoundaryConditionPointerType GetBoundaryCondition ()
 
void GenerateInputRequestedRegion () override
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
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 ()
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
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 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)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const 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
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::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static void SetGlobalDefaultDirectionTolerance (double)
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static double GetGlobalDefaultCoordinateTolerance ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension
 
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int MaskImageDimension = TMaskImage::ImageDimension
 
- Static Public Attributes inherited from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >
static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension
 
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 

Protected Member Functions

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

Private Attributes

OutputPixelType m_DefaultValue
 
bool m_UseDefaultValue { true }
 

Additional Inherited Members

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

Detailed Description

template<typename TInputImage, typename TMaskImage, typename TOutputImage, typename TOperatorValueType = typename TOutputImage::PixelType>
class itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >

Applies a single NeighborhoodOperator to an image, processing only those pixels that are under a mask.

This filter calculates successive inner products between a single NeighborhoodOperator and a NeighborhoodIterator, which is swept across every pixel that is set in the input mask. If no mask is given, this filter is equivalent to its superclass. Output pixels that are outside of the mask will be set to DefaultValue if UseDefaultValue is true (default). Otherwise, they will be set to the value of the input pixel.

See also
Image
Neighborhood
NeighborhoodOperator
NeighborhoodOperatorImageFilter
NeighborhoodIterator
ITK Sphinx Examples:
Examples
SphinxExamples/src/Filtering/ImageFilterBase/ApplyKernelToEveryPixelInNonZeroImage/Code.cxx.

Definition at line 54 of file itkMaskNeighborhoodOperatorImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 65 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ ImageBoundaryConditionPointerType

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
using itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::ImageBoundaryConditionPointerType = ImageBoundaryCondition<OutputImageType> *

Typedef for generic boundary condition pointer.

Definition at line 96 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ InputImagePointer

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
using itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputImagePointer = typename InputImageType::Pointer

Definition at line 92 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
using itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputImageType = TInputImage

Image type alias support

Definition at line 89 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ InputInternalPixelType

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
using itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputInternalPixelType = typename TInputImage::InternalPixelType

Definition at line 78 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ InputPixelType

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
using itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputPixelType = typename TInputImage::PixelType

Definition at line 77 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ MaskImagePointer

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
using itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskImagePointer = typename MaskImageType::Pointer

Definition at line 93 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ MaskImageType

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
using itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskImageType = TMaskImage

Definition at line 90 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ MaskInternalPixelType

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
using itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskInternalPixelType = typename TMaskImage::InternalPixelType

Definition at line 80 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ MaskPixelType

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
using itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskPixelType = typename TMaskImage::PixelType

Definition at line 79 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ OperatorValueType

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
using itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OperatorValueType = typename Superclass::OperatorValueType

Definition at line 100 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
using itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputImageRegionType = typename Superclass::OutputImageRegionType

Superclass type alias.

Definition at line 99 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
using itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputImageType = TOutputImage

Definition at line 91 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ OutputInternalPixelType

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
using itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputInternalPixelType = typename TOutputImage::InternalPixelType

Definition at line 76 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ OutputNeighborhoodType

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
using itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputNeighborhoodType = typename Superclass::OutputNeighborhoodType

Neighborhood types

Definition at line 103 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ OutputPixelType

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
using itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::OutputPixelType = typename TOutputImage::PixelType

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Definition at line 75 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
using itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::Pointer = SmartPointer<Self>

Definition at line 64 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ Self

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
using itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::Self = MaskNeighborhoodOperatorImageFilter

Standard "Self" & Superclass type alias.

Definition at line 61 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
using itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::Superclass = NeighborhoodOperatorImageFilter<TInputImage, TOutputImage, TOperatorValueType>

Definition at line 62 of file itkMaskNeighborhoodOperatorImageFilter.h.

Constructor & Destructor Documentation

◆ MaskNeighborhoodOperatorImageFilter()

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskNeighborhoodOperatorImageFilter ( )
inlineprotected

Definition at line 149 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ ~MaskNeighborhoodOperatorImageFilter()

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::~MaskNeighborhoodOperatorImageFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
virtual::itk::LightObject::Pointer itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
void itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::DynamicThreadedGenerateData ( const OutputImageRegionType outputRegionForThread)
overrideprotectedvirtual

MaskNeighborhoodOperatorImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a DynamicThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling DynamicThreadedGenerateData(). DynamicThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See also
ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

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

MaskNeighborhoodOperatorImageFilter needs to request enough of an input image to account for template size. The input requested region is expanded by the radius of the template. If the request extends past the LargestPossibleRegion for the input, the request is cropped by the LargestPossibleRegion.

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

◆ GetDefaultValue()

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
virtual OutputPixelType itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::GetDefaultValue ( ) const
virtual

Get the output value for the pixels that are not under the mask.

◆ GetMaskImage()

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
const TMaskImage* itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::GetMaskImage ( ) const

Get the mask image. Using a mask is optional. When a mask is specified, the normalized correlation is only calculated for those pixels under the mask.

◆ GetNameOfClass()

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
virtual const char* itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::NeighborhoodOperatorImageFilter< TInputImage, TOutputImage, TOperatorValueType >.

◆ GetUseDefaultValue()

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
virtual const bool& itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::GetUseDefaultValue ( ) const
virtual

Get the UseDefaultValue flag.

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
void itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Typedef for the region copier function object that converts an input region to an output region.

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

◆ SetDefaultValue()

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
virtual void itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::SetDefaultValue ( OutputPixelType  _arg)
virtual

Set the output value for the pixels that are not under the mask. Defaults to zero.

◆ SetMaskImage()

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
void itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::SetMaskImage ( const TMaskImage *  mask)

Set the mask image. Using a mask is optional. When a mask is specified, the normalized correlation is only calculated for those pixels under the mask.

◆ SetUseDefaultValue()

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
virtual void itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::SetUseDefaultValue ( bool  _arg)
virtual

Set the UseDefaultValue flag. If true, the pixels outside the mask will e set to m_DefaultValue. Otherwise, they will be set to the input pixel.

◆ UseDefaultValueOff()

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
virtual void itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::UseDefaultValueOff ( )
virtual

◆ UseDefaultValueOn()

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
virtual void itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::UseDefaultValueOn ( )
virtual

Turn on and off the UseDefaultValue flag.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
constexpr unsigned int itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::ImageDimension = TOutputImage::ImageDimension
staticconstexpr

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Definition at line 84 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ InputImageDimension

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
constexpr unsigned int itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::InputImageDimension = TInputImage::ImageDimension
staticconstexpr

Definition at line 85 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ m_DefaultValue

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
OutputPixelType itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::m_DefaultValue
private

Definition at line 180 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ m_UseDefaultValue

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
bool itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::m_UseDefaultValue { true }
private

Definition at line 181 of file itkMaskNeighborhoodOperatorImageFilter.h.

◆ MaskImageDimension

template<typename TInputImage , typename TMaskImage , typename TOutputImage , typename TOperatorValueType = typename TOutputImage::PixelType>
constexpr unsigned int itk::MaskNeighborhoodOperatorImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::MaskImageDimension = TMaskImage::ImageDimension
staticconstexpr

Definition at line 86 of file itkMaskNeighborhoodOperatorImageFilter.h.


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