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::BoxImageFilter< TInputImage, TOutputImage > Class Template Reference
Group Filtering » Module ITKImageFilterBase

#include <itkBoxImageFilter.h>

+ Inheritance diagram for itk::BoxImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::BoxImageFilter< TInputImage, TOutputImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using IndexType = typename TInputImage::IndexType
 
using InputImageType = TInputImage
 
using InputPixelType = typename TInputImage::PixelType
 
using OffsetType = typename TInputImage::OffsetType
 
using OutputImageType = TOutputImage
 
using OutputPixelType = typename TOutputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename TInputImage::SizeType
 
using RadiusValueType = typename TInputImage::SizeValueType
 
using RegionType = typename TInputImage::RegionType
 
using Self = BoxImageFilter
 
using SizeType = typename TInputImage::SizeType
 
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 const char * GetNameOfClass () const
 
virtual const RadiusType & GetRadius () const
 
virtual void SetRadius (const RadiusType &radius)
 
virtual void SetRadius (const RadiusValueType &radius)
 
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType * GetInput () const
 
const InputImageType * GetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *input)
 
virtual void PushFrontInput (const InputImageType *input)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *input)
 
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 >
OutputImageType * GetOutput ()
 
const OutputImageType * GetOutput () const
 
OutputImageType * GetOutput (unsigned int idx)
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
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 val)
 
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 ThreadIdType & GetNumberOfWorkUnits () const
 
MultiThreaderType * GetMultiThreader () 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
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
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)
 
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 void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

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

Static Public Attributes

static constexpr unsigned int ImageDimension = 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

 BoxImageFilter ()
 
void GenerateInputRequestedRegion () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~BoxImageFilter () override=default
 
- 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 &region, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void AfterThreadedGenerateData ()
 
virtual const ImageRegionSplitterBase * GetImageRegionSplitter () 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
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (const DataObjectIdentifierType &key) const
 
DataObject * GetInput (DataObjectPointerArraySizeType idx)
 
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObject * GetPrimaryInput ()
 
const DataObject * GetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *object)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredInputs () 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)
 
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
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObject * GetPrimaryOutput ()
 
const DataObject * GetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *object)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredOutputs () 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 &timeStamp)
 
- 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

RadiusType m_Radius
 

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 ImageRegionSplitterBase * GetGlobalDefaultSplitter ()
 
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 TOutputImage>
class itk::BoxImageFilter< TInputImage, TOutputImage >

A base class for all the filters working on a box neighborhood.

This filter provides the code to store the radius information about the neighborhood used in the subclasses. It also conveniently reimplement the GenerateInputRequestedRegion() so that region is well defined for the provided radius.

Author
Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

Definition at line 40 of file itkBoxImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >
using itk::BoxImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 49 of file itkBoxImageFilter.h.

◆ IndexType

template<typename TInputImage , typename TOutputImage >
using itk::BoxImageFilter< TInputImage, TOutputImage >::IndexType = typename TInputImage::IndexType

Definition at line 61 of file itkBoxImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage >
using itk::BoxImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Image related type alias.

Definition at line 58 of file itkBoxImageFilter.h.

◆ InputPixelType

template<typename TInputImage , typename TOutputImage >
using itk::BoxImageFilter< TInputImage, TOutputImage >::InputPixelType = typename TInputImage::PixelType

Definition at line 64 of file itkBoxImageFilter.h.

◆ OffsetType

template<typename TInputImage , typename TOutputImage >
using itk::BoxImageFilter< TInputImage, TOutputImage >::OffsetType = typename TInputImage::OffsetType

Definition at line 62 of file itkBoxImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage >
using itk::BoxImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 66 of file itkBoxImageFilter.h.

◆ OutputPixelType

template<typename TInputImage , typename TOutputImage >
using itk::BoxImageFilter< TInputImage, TOutputImage >::OutputPixelType = typename TOutputImage::PixelType

Definition at line 67 of file itkBoxImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >
using itk::BoxImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 48 of file itkBoxImageFilter.h.

◆ RadiusType

template<typename TInputImage , typename TOutputImage >
using itk::BoxImageFilter< TInputImage, TOutputImage >::RadiusType = typename TInputImage::SizeType

n-dimensional Kernel radius.

Definition at line 73 of file itkBoxImageFilter.h.

◆ RadiusValueType

template<typename TInputImage , typename TOutputImage >
using itk::BoxImageFilter< TInputImage, TOutputImage >::RadiusValueType = typename TInputImage::SizeValueType

Definition at line 74 of file itkBoxImageFilter.h.

◆ RegionType

template<typename TInputImage , typename TOutputImage >
using itk::BoxImageFilter< TInputImage, TOutputImage >::RegionType = typename TInputImage::RegionType

Definition at line 59 of file itkBoxImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >
using itk::BoxImageFilter< TInputImage, TOutputImage >::Self = BoxImageFilter

Standard class type aliases.

Definition at line 46 of file itkBoxImageFilter.h.

◆ SizeType

template<typename TInputImage , typename TOutputImage >
using itk::BoxImageFilter< TInputImage, TOutputImage >::SizeType = typename TInputImage::SizeType

Definition at line 60 of file itkBoxImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >
using itk::BoxImageFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage, TOutputImage>

Definition at line 47 of file itkBoxImageFilter.h.

Constructor & Destructor Documentation

◆ BoxImageFilter()

template<typename TInputImage , typename TOutputImage >
itk::BoxImageFilter< TInputImage, TOutputImage >::BoxImageFilter ( )
protected

◆ ~BoxImageFilter()

template<typename TInputImage , typename TOutputImage >
itk::BoxImageFilter< TInputImage, TOutputImage >::~BoxImageFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TInputImage , typename TOutputImage >
virtual::itk::LightObject::Pointer itk::BoxImageFilter< TInputImage, TOutputImage >::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.

Reimplemented in itk::MovingHistogramMorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >, itk::MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >, itk::MovingHistogramImageFilterBase< TImageType, TImageType, TKernel >, itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >, itk::MovingHistogramImageFilter< TImageType, TImageType, TKernel, Function::AdaptiveEqualizationHistogram< TImageType::PixelType, TImageType::PixelType > >, itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, Function::MorphologyHistogram< TInputImage::PixelType, std::less< TInputImage::PixelType > > >, itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, Function::RankHistogram< TInputImage::PixelType > >, itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, Function::MorphologyHistogram< TInputImage::PixelType, std::greater< TInputImage::PixelType > > >, itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, Function::MorphologicalGradientHistogram< TInputImage::PixelType > >, itk::AdaptiveHistogramEqualizationImageFilter< TImageType, TKernel >, itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::MaskedRankImageFilter< TInputImage, TMaskImage, TOutputImage, TKernel >, itk::RankImageFilter< TInputImage, TOutputImage, TKernel >, itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >, itk::WhiteTopHatImageFilter< TInputImage, TOutputImage, TKernel >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, TCompare1, TCompare2 >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, std::greater< TImage::PixelType >, std::less< TImage::PixelType > >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, std::less< TImage::PixelType >, std::greater< TImage::PixelType > >, itk::FastIncrementalBinaryDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::MedianImageFilter< TInputImage, TOutputImage >, itk::SimpleContourExtractorImageFilter< TInputImage, TOutputImage >, itk::MeanImageFilter< TInputImage, TOutputImage >, itk::NoiseImageFilter< TInputImage, TOutputImage >, itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, TFunction1 >, itk::BinaryMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, MinFunctor< TImage::PixelType > >, itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, MaxFunctor< TImage::PixelType > >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, TFunction1 >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, std::greater< TImage::PixelType > >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, std::less< TImage::PixelType > >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::MovingHistogramDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::MovingHistogramErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::FastApproximateRankImageFilter< TInputImage, TOutputImage >, itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleFunctionDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleFunctionErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::MorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryClosingByReconstructionImageFilter< TInputImage, TKernel >, itk::BinaryOpeningByReconstructionImageFilter< TInputImage, TKernel >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, RankImageFilter< TInputImage, TInputImage, FlatStructuringElement< TInputImage::ImageDimension > > >, itk::BasicDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::VanHerkGilWermanErodeImageFilter< TImage, TKernel >, itk::GPUMeanImageFilter< TInputImage, TOutputImage >, itk::BasicErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::VanHerkGilWermanDilateImageFilter< TImage, TKernel >, itk::MovingHistogramMorphologyImageFilter< TInputImage, TOutputImage, TKernel, THistogram >, itk::MovingHistogramMorphologyImageFilter< TInputImage, TOutputImage, TKernel, Function::MorphologyHistogram< TInputImage::PixelType, std::less< TInputImage::PixelType > > >, itk::MovingHistogramMorphologyImageFilter< TInputImage, TOutputImage, TKernel, Function::MorphologyHistogram< TInputImage::PixelType, std::greater< TInputImage::PixelType > > >, itk::MaskedMovingHistogramImageFilter< TInputImage, TMaskImage, TOutputImage, TKernel, THistogram >, itk::MaskedMovingHistogramImageFilter< TInputImage, TMaskImage, TOutputImage, TKernel, Function::RankHistogram< TInputImage::PixelType > >, itk::GPUBoxImageFilter< TInputImage, TOutputImage, MeanImageFilter< TInputImage, TOutputImage > >, itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >, itk::BoxMeanImageFilter< TInputImage, TOutputImage >, itk::KernelImageFilter< TInputImage, TInputImage, TKernel >, itk::KernelImageFilter< TImageType, TImageType, TKernel >, itk::KernelImageFilter< TImage, TImage, TKernel >, itk::BoxSigmaImageFilter< TInputImage, TOutputImage >, itk::GPUImageToImageFilter< TInputImage, TOutputImage, MeanImageFilter< TInputImage, TOutputImage > >, itk::AnchorCloseImageFilter< TImage, TKernel >, itk::AnchorDilateImageFilter< TImage, TKernel >, itk::AnchorOpenImageFilter< TImage, TKernel >, and itk::AnchorErodeImageFilter< TImage, TKernel >.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputImage >
void itk::BoxImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )
overrideprotectedvirtual

What is the input requested region that is required to produce the output requested region? The base assumption for image processing filters is that the input requested region can be set to match the output requested region. If a filter requires more input (for instance a filter that uses neighborhoods needs more input than output to avoid introducing artificial boundary conditions) or less input (for instance a magnify filter) will have to override this method. In doing so, it should call its superclass' implementation as its first step. Note that imaging filters operate differently than the classes to this point in the class hierarchy. Up till now, the base assumption has been that the largest possible region will be requested of the input.

This implementation of GenerateInputRequestedRegion() only processes the inputs that are a subclass of the ImageBase<InputImageDimension>. If an input is another type of DataObject (including an Image of a different dimension), they are skipped by this method. The subclasses of ImageToImageFilter are responsible for providing an implementation of GenerateInputRequestedRegion() when there are multiple inputs of different types.

See also
ProcessObject::GenerateInputRequestedRegion(), ImageSource::GenerateInputRequestedRegion()

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

Reimplemented in itk::BinaryOpeningByReconstructionImageFilter< TInputImage, TKernel >, and itk::BinaryClosingByReconstructionImageFilter< TInputImage, TKernel >.

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage >
virtual const char* itk::BoxImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Runtime information support.

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

Reimplemented in itk::MovingHistogramMorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >, itk::MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >, itk::MovingHistogramImageFilterBase< TImageType, TImageType, TKernel >, itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, THistogram >, itk::MovingHistogramImageFilter< TImageType, TImageType, TKernel, Function::AdaptiveEqualizationHistogram< TImageType::PixelType, TImageType::PixelType > >, itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, Function::MorphologyHistogram< TInputImage::PixelType, std::less< TInputImage::PixelType > > >, itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, Function::RankHistogram< TInputImage::PixelType > >, itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, Function::MorphologyHistogram< TInputImage::PixelType, std::greater< TInputImage::PixelType > > >, itk::MovingHistogramImageFilter< TInputImage, TOutputImage, TKernel, Function::MorphologicalGradientHistogram< TInputImage::PixelType > >, itk::AdaptiveHistogramEqualizationImageFilter< TImageType, TKernel >, itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::MaskedRankImageFilter< TInputImage, TMaskImage, TOutputImage, TKernel >, itk::RankImageFilter< TInputImage, TOutputImage, TKernel >, itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >, itk::WhiteTopHatImageFilter< TInputImage, TOutputImage, TKernel >, itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, TCompare1, TCompare2 >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, std::greater< TImage::PixelType >, std::less< TImage::PixelType > >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, std::less< TImage::PixelType >, std::greater< TImage::PixelType > >, itk::FastIncrementalBinaryDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::MedianImageFilter< TInputImage, TOutputImage >, itk::SimpleContourExtractorImageFilter< TInputImage, TOutputImage >, itk::MeanImageFilter< TInputImage, TOutputImage >, itk::NoiseImageFilter< TInputImage, TOutputImage >, itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, TFunction1 >, itk::BinaryMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, MinFunctor< TImage::PixelType > >, itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, MaxFunctor< TImage::PixelType > >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, TFunction1 >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, std::greater< TImage::PixelType > >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, std::less< TImage::PixelType > >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::MovingHistogramDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::MovingHistogramErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::FastApproximateRankImageFilter< TInputImage, TOutputImage >, itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleFunctionDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleFunctionErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::MorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryClosingByReconstructionImageFilter< TInputImage, TKernel >, itk::BinaryOpeningByReconstructionImageFilter< TInputImage, TKernel >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, RankImageFilter< TInputImage, TInputImage, FlatStructuringElement< TInputImage::ImageDimension > > >, itk::BasicDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GPUMeanImageFilter< TInputImage, TOutputImage >, itk::BasicErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::MovingHistogramMorphologyImageFilter< TInputImage, TOutputImage, TKernel, THistogram >, itk::MovingHistogramMorphologyImageFilter< TInputImage, TOutputImage, TKernel, Function::MorphologyHistogram< TInputImage::PixelType, std::less< TInputImage::PixelType > > >, itk::MovingHistogramMorphologyImageFilter< TInputImage, TOutputImage, TKernel, Function::MorphologyHistogram< TInputImage::PixelType, std::greater< TInputImage::PixelType > > >, itk::MaskedMovingHistogramImageFilter< TInputImage, TMaskImage, TOutputImage, TKernel, THistogram >, itk::MaskedMovingHistogramImageFilter< TInputImage, TMaskImage, TOutputImage, TKernel, Function::RankHistogram< TInputImage::PixelType > >, itk::GPUBoxImageFilter< TInputImage, TOutputImage, MeanImageFilter< TInputImage, TOutputImage > >, itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >, itk::BoxMeanImageFilter< TInputImage, TOutputImage >, itk::KernelImageFilter< TInputImage, TInputImage, TKernel >, itk::KernelImageFilter< TImageType, TImageType, TKernel >, itk::KernelImageFilter< TImage, TImage, TKernel >, itk::BoxSigmaImageFilter< TInputImage, TOutputImage >, itk::GPUImageToImageFilter< TInputImage, TOutputImage, MeanImageFilter< TInputImage, TOutputImage > >, itk::VanHerkGilWermanErodeImageFilter< TImage, TKernel >, itk::VanHerkGilWermanDilateImageFilter< TImage, TKernel >, itk::AnchorDilateImageFilter< TImage, TKernel >, and itk::AnchorErodeImageFilter< TImage, TKernel >.

◆ GetRadius()

template<typename TInputImage , typename TOutputImage >
virtual const RadiusType& itk::BoxImageFilter< TInputImage, TOutputImage >::GetRadius ( ) const
virtual

◆ New()

template<typename TInputImage , typename TOutputImage >
static Pointer itk::BoxImageFilter< TInputImage, TOutputImage >::New ( )
static

Standard New method.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage >
void itk::BoxImageFilter< TInputImage, TOutputImage >::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 >.

Reimplemented in itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >, itk::AdaptiveHistogramEqualizationImageFilter< TImageType, TKernel >, itk::MaskedMovingHistogramImageFilter< TInputImage, TMaskImage, TOutputImage, TKernel, THistogram >, itk::MaskedMovingHistogramImageFilter< TInputImage, TMaskImage, TOutputImage, TKernel, Function::RankHistogram< TInputImage::PixelType > >, itk::MovingHistogramImageFilterBase< TInputImage, TOutputImage, TKernel >, itk::MovingHistogramImageFilterBase< TImageType, TImageType, TKernel >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::MorphologyImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, itk::MaskedRankImageFilter< TInputImage, TMaskImage, TOutputImage, TKernel >, itk::RankImageFilter< TInputImage, TOutputImage, TKernel >, itk::SimpleContourExtractorImageFilter< TInputImage, TOutputImage >, itk::MorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, itk::BlackTopHatImageFilter< TInputImage, TOutputImage, TKernel >, itk::FastApproximateRankImageFilter< TInputImage, TOutputImage >, itk::WhiteTopHatImageFilter< TInputImage, TOutputImage, TKernel >, itk::MovingHistogramMorphologyImageFilter< TInputImage, TOutputImage, TKernel, THistogram >, itk::BinaryMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::BinaryOpeningByReconstructionImageFilter< TInputImage, TKernel >, itk::MovingHistogramMorphologyImageFilter< TInputImage, TOutputImage, TKernel, Function::MorphologyHistogram< TInputImage::PixelType, std::less< TInputImage::PixelType > > >, itk::MovingHistogramMorphologyImageFilter< TInputImage, TOutputImage, TKernel, Function::MorphologyHistogram< TInputImage::PixelType, std::greater< TInputImage::PixelType > > >, itk::BinaryMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >, itk::KernelImageFilter< TInputImage, TInputImage, TKernel >, itk::KernelImageFilter< TImageType, TImageType, TKernel >, itk::KernelImageFilter< TImage, TImage, TKernel >, itk::BinaryClosingByReconstructionImageFilter< TInputImage, TKernel >, itk::GPUImageToImageFilter< TInputImage, TOutputImage, MeanImageFilter< TInputImage, TOutputImage > >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, TCompare1, TCompare2 >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, std::greater< TImage::PixelType >, std::less< TImage::PixelType > >, itk::AnchorOpenCloseImageFilter< TImage, TKernel, std::less< TImage::PixelType >, std::greater< TImage::PixelType > >, itk::GPUMeanImageFilter< TInputImage, TOutputImage >, itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, TFunction1 >, itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, MinFunctor< TImage::PixelType > >, itk::VanHerkGilWermanErodeDilateImageFilter< TImage, TKernel, MaxFunctor< TImage::PixelType > >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, TFunction1 >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, std::greater< TImage::PixelType > >, itk::AnchorErodeDilateImageFilter< TImage, TKernel, std::less< TImage::PixelType > >, and itk::GPUBoxImageFilter< TInputImage, TOutputImage, MeanImageFilter< TInputImage, TOutputImage > >.

Referenced by itk::FastApproximateRankImageFilter< TInputImage, TOutputImage >::PrintSelf().

◆ SetRadius() [1/2]

template<typename TInputImage , typename TOutputImage >
virtual void itk::BoxImageFilter< TInputImage, TOutputImage >::SetRadius ( const RadiusType &  radius)
virtual

Reimplemented in itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >, itk::KernelImageFilter< TInputImage, TInputImage, TKernel >, itk::KernelImageFilter< TImageType, TImageType, TKernel >, itk::KernelImageFilter< TImage, TImage, TKernel >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >, and itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, RankImageFilter< TInputImage, TInputImage, FlatStructuringElement< TInputImage::ImageDimension > > >.

◆ SetRadius() [2/2]

template<typename TInputImage , typename TOutputImage >
virtual void itk::BoxImageFilter< TInputImage, TOutputImage >::SetRadius ( const RadiusValueType &  radius)
virtual

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage >
constexpr unsigned int itk::BoxImageFilter< TInputImage, TOutputImage >::ImageDimension = TInputImage::ImageDimension
staticconstexpr

Image related type alias.

Definition at line 70 of file itkBoxImageFilter.h.

◆ m_Radius

template<typename TInputImage , typename TOutputImage >
RadiusType itk::BoxImageFilter< TInputImage, TOutputImage >::m_Radius
private

Definition at line 95 of file itkBoxImageFilter.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.
Generated on Thu Apr 1 2021 02:13:51 for ITK by   doxygen 1.8.16