ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
itk::Functor::MaskInput< TInput, TMask, TOutput > Class Template Reference

#include <itkMaskImageFilter.h>

Detailed Description

template<typename TInput, typename TMask, typename TOutput = TInput>
class itk::Functor::MaskInput< TInput, TMask, TOutput >

Definition at line 36 of file itkMaskImageFilter.h.

Public Types

using AccumulatorType = typename NumericTraits< TInput >::AccumulateType
 

Public Member Functions

const TMask & GetMaskingValue () const
 
const TOutput & GetOutsideValue () const
 
 ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (MaskInput)
 
 MaskInput ()=default
 
TOutput operator() (const TInput &A, const TMask &B) const
 
bool operator== (const MaskInput &) const
 
void SetMaskingValue (const TMask &maskingValue)
 
void SetOutsideValue (const TOutput &outsideValue)
 
 ~MaskInput ()=default
 

Private Member Functions

template<typename TPixelType >
TPixelType DefaultOutsideValue (TPixelType *)
 
template<typename TValue >
VariableLengthVector< TValue > DefaultOutsideValue (VariableLengthVector< TValue > *)
 

Private Attributes

TMask m_MaskingValue {}
 
TOutput m_OutsideValue { DefaultOutsideValue(static_cast<TOutput *>(nullptr)) }
 

Member Typedef Documentation

◆ AccumulatorType

template<typename TInput , typename TMask , typename TOutput = TInput>
using itk::Functor::MaskInput< TInput, TMask, TOutput >::AccumulatorType = typename NumericTraits<TInput>::AccumulateType

Definition at line 39 of file itkMaskImageFilter.h.

Constructor & Destructor Documentation

◆ MaskInput()

template<typename TInput , typename TMask , typename TOutput = TInput>
itk::Functor::MaskInput< TInput, TMask, TOutput >::MaskInput ( )
default

◆ ~MaskInput()

template<typename TInput , typename TMask , typename TOutput = TInput>
itk::Functor::MaskInput< TInput, TMask, TOutput >::~MaskInput ( )
default

Member Function Documentation

◆ DefaultOutsideValue() [1/2]

template<typename TInput , typename TMask , typename TOutput = TInput>
template<typename TPixelType >
TPixelType itk::Functor::MaskInput< TInput, TMask, TOutput >::DefaultOutsideValue ( TPixelType *  )
inlineprivate

Definition at line 96 of file itkMaskImageFilter.h.

◆ DefaultOutsideValue() [2/2]

template<typename TInput , typename TMask , typename TOutput = TInput>
template<typename TValue >
VariableLengthVector< TValue > itk::Functor::MaskInput< TInput, TMask, TOutput >::DefaultOutsideValue ( VariableLengthVector< TValue > *  )
inlineprivate

Definition at line 103 of file itkMaskImageFilter.h.

◆ GetMaskingValue()

template<typename TInput , typename TMask , typename TOutput = TInput>
const TMask & itk::Functor::MaskInput< TInput, TMask, TOutput >::GetMaskingValue ( ) const
inline

Method to get the masking value

Definition at line 88 of file itkMaskImageFilter.h.

References itk::Functor::MaskInput< TInput, TMask, TOutput >::m_MaskingValue.

◆ GetOutsideValue()

template<typename TInput , typename TMask , typename TOutput = TInput>
const TOutput & itk::Functor::MaskInput< TInput, TMask, TOutput >::GetOutsideValue ( ) const
inline

Method to get the outside value of the mask

Definition at line 74 of file itkMaskImageFilter.h.

References itk::Functor::MaskInput< TInput, TMask, TOutput >::m_OutsideValue.

◆ ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION()

template<typename TInput , typename TMask , typename TOutput = TInput>
itk::Functor::MaskInput< TInput, TMask, TOutput >::ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION ( MaskInput< TInput, TMask, TOutput >  )

◆ operator()()

template<typename TInput , typename TMask , typename TOutput = TInput>
TOutput itk::Functor::MaskInput< TInput, TMask, TOutput >::operator() ( const TInput &  A,
const TMask &  B 
) const
inline

◆ operator==()

template<typename TInput , typename TMask , typename TOutput = TInput>
bool itk::Functor::MaskInput< TInput, TMask, TOutput >::operator== ( const MaskInput< TInput, TMask, TOutput > &  ) const
inline

Definition at line 45 of file itkMaskImageFilter.h.

◆ SetMaskingValue()

template<typename TInput , typename TMask , typename TOutput = TInput>
void itk::Functor::MaskInput< TInput, TMask, TOutput >::SetMaskingValue ( const TMask &  maskingValue)
inline

Method to explicitly set the masking value

Definition at line 81 of file itkMaskImageFilter.h.

References itk::Functor::MaskInput< TInput, TMask, TOutput >::m_MaskingValue.

◆ SetOutsideValue()

template<typename TInput , typename TMask , typename TOutput = TInput>
void itk::Functor::MaskInput< TInput, TMask, TOutput >::SetOutsideValue ( const TOutput &  outsideValue)
inline

Method to explicitly set the outside value of the mask

Definition at line 67 of file itkMaskImageFilter.h.

References itk::Functor::MaskInput< TInput, TMask, TOutput >::m_OutsideValue.

Member Data Documentation

◆ m_MaskingValue

template<typename TInput , typename TMask , typename TOutput = TInput>
TMask itk::Functor::MaskInput< TInput, TMask, TOutput >::m_MaskingValue {}
private

◆ m_OutsideValue

template<typename TInput , typename TMask , typename TOutput = TInput>
TOutput itk::Functor::MaskInput< TInput, TMask, TOutput >::m_OutsideValue { DefaultOutsideValue(static_cast<TOutput *>(nullptr)) }
private

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