 |
ITK
5.0.0
Insight Segmentation and Registration Toolkit
|
|
ITK
5.0.0
Insight Segmentation and Registration Toolkit
|
#include <itkBinShrinkImageFilter.h>
Inheritance diagram for itk::BinShrinkImageFilter< TInputImage, TOutputImage >: Collaboration diagram for itk::BinShrinkImageFilter< TInputImage, TOutputImage >:Reduce the size of an image by an integer factor in each dimension while performing averaging of an input neighborhood.
The output image size in each dimension is given by:
outputSize[j] = max( std::floor(inputSize[j]/shrinkFactor[j]), 1 );
The algorithm implemented can be describe with the following equation for 2D:
![\[ \mathsf{I}_{out}(x_o,x_1) = \frac{\sum_{i=0}^{f_0}\sum_{j=0}^{f_1}\mathsf{I}_{in}(f_0 x_o+i,f_1 x_1+j)}{f_0 f_1} \]](form_150.png)
This filter is implemented so that the starting extent of the first pixel of the output matches that of the input.
This code was contributed in the Insight Journal paper: "BinShrink: A multi-resolution filter with cache efficient averaging" by Lowekamp B., Chen D. https://hdl.handle.net/10380/3450
Definition at line 57 of file itkBinShrinkImageFilter.h.
Public Types | |
| using | ConstPointer = SmartPointer< const Self > |
| using | InputImageConstPointer = typename InputImageType::ConstPointer |
| using | InputImagePointer = typename InputImageType::Pointer |
| using | InputImageType = TInputImage |
| using | InputIndexType = typename TInputImage::IndexType |
| using | OutputImagePointer = typename OutputImageType::Pointer |
| using | OutputImageRegionType = typename TOutputImage::RegionType |
| using | OutputImageType = TOutputImage |
| using | OutputIndexType = typename TOutputImage::IndexType |
| using | OutputOffsetType = typename TOutputImage::OffsetType |
| using | Pointer = SmartPointer< Self > |
| using | Self = BinShrinkImageFilter |
| using | ShrinkFactorsType = FixedArray< unsigned int, ImageDimension > |
| 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 |
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 flag) |
| 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 constexpr unsigned int | OutputImageDimension = TOutputImage::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 |
Private Member Functions | |
| template<class TOutputType , class TInputType > | |
| std::enable_if < std::numeric_limits < TOutputType >::is_integer, TOutputType >::type | RoundIfInteger (TInputType input) |
| template<class TOutputType , class TInputType > | |
| std::enable_if <!std::numeric_limits < TOutputType >::is_integer, TOutputType >::type | RoundIfInteger (const TInputType &input,...) |
Private Attributes | |
| ShrinkFactorsType | m_ShrinkFactors |
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) |
| Protected Attributes inherited from itk::ImageSource< TOutputImage > | |
| bool | m_DynamicMultiThreading |
| Protected Attributes inherited from itk::ProcessObject | |
| TimeStamp | m_OutputInformationMTime |
| bool | m_Updating |
| Protected Attributes inherited from itk::LightObject | |
| std::atomic< int > | m_ReferenceCount |
| using itk::BinShrinkImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self> |
Definition at line 67 of file itkBinShrinkImageFilter.h.
| using itk::BinShrinkImageFilter< TInputImage, TOutputImage >::InputImageConstPointer = typename InputImageType::ConstPointer |
Definition at line 80 of file itkBinShrinkImageFilter.h.
| using itk::BinShrinkImageFilter< TInputImage, TOutputImage >::InputImagePointer = typename InputImageType::Pointer |
Definition at line 79 of file itkBinShrinkImageFilter.h.
| using itk::BinShrinkImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage |
Definition at line 77 of file itkBinShrinkImageFilter.h.
| using itk::BinShrinkImageFilter< TInputImage, TOutputImage >::InputIndexType = typename TInputImage::IndexType |
Definition at line 84 of file itkBinShrinkImageFilter.h.
| using itk::BinShrinkImageFilter< TInputImage, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer |
Definition at line 78 of file itkBinShrinkImageFilter.h.
| using itk::BinShrinkImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename TOutputImage::RegionType |
Typedef to describe the output image region type.
Definition at line 87 of file itkBinShrinkImageFilter.h.
| using itk::BinShrinkImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage |
Typedef to images
Definition at line 76 of file itkBinShrinkImageFilter.h.
| using itk::BinShrinkImageFilter< TInputImage, TOutputImage >::OutputIndexType = typename TOutputImage::IndexType |
Definition at line 83 of file itkBinShrinkImageFilter.h.
| using itk::BinShrinkImageFilter< TInputImage, TOutputImage >::OutputOffsetType = typename TOutputImage::OffsetType |
Definition at line 82 of file itkBinShrinkImageFilter.h.
| using itk::BinShrinkImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self> |
Definition at line 66 of file itkBinShrinkImageFilter.h.
| using itk::BinShrinkImageFilter< TInputImage, TOutputImage >::Self = BinShrinkImageFilter |
Standard class type aliases.
Definition at line 64 of file itkBinShrinkImageFilter.h.
| using itk::BinShrinkImageFilter< TInputImage, TOutputImage >::ShrinkFactorsType = FixedArray< unsigned int, ImageDimension > |
Definition at line 93 of file itkBinShrinkImageFilter.h.
| using itk::BinShrinkImageFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter<TInputImage,TOutputImage> |
Definition at line 65 of file itkBinShrinkImageFilter.h.
|
protected |
Begin concept checking End concept checking
|
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.
|
overrideprotectedvirtual |
If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData() or DynamicThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call (Dynamic)ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of (Dynamic)ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a (Dynamic)ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The (Dynamic)ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. (Dynamic)ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).
DynamicThreadedGenerateData() is the newer variant without threadId, and is the preferred signature, which is called by default. This variant can split the requested region into different number of pieces depending on current multi-processing load, which allows better load balancing. The non-dynamic (also known as classic) ThreadedGenerateData() signature has threadId, and number of pieces to be split into is known in advance. It is activated by calling this->DynamicMultiThreadingOff(); in derived class constructor. It should be used when the multi-threaded algorithm needs to pre-allocate some data structure with size dependent on the number of pieces (also known as chunks, work units, and sometimes also incorrectly as threads). Only PlatformMultiThreader guarantees that each piece will be processed in its own specific thread. Pool and TBB multi-threaders maintain a pool of threads (normally equal to number of processing cores) which they use to process the pieces. This normally results in a single thread being reused to process multiple work units.
Reimplemented from itk::ImageSource< TOutputImage >.
|
overridevirtual |
BinShrinkImageFilter needs a larger input requested region than the output requested region. As such, BinShrinkImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.
Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
|
overridevirtual |
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.
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.
|
virtual |
Get the shrink factors.
|
static |
Method for creation through the object factory.
|
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::ImageToImageFilter< TInputImage, TOutputImage >.
|
inlineprivate |
Round different pixel types.
Definition at line 137 of file itkBinShrinkImageFilter.h.
|
inlineprivate |
Definition at line 146 of file itkBinShrinkImageFilter.h.
| void itk::BinShrinkImageFilter< TInputImage, TOutputImage >::SetShrinkFactor | ( | unsigned int | i, |
| unsigned int | factor | ||
| ) |
Set the shrink factors. Values are clamped to a minimum value of 1. Default is 1 for all dimensions.
|
virtual |
Set the shrink factors. Values are clamped to a minimum value of 1. Default is 1 for all dimensions.
| void itk::BinShrinkImageFilter< TInputImage, TOutputImage >::SetShrinkFactors | ( | unsigned int | factor | ) |
Set the shrink factors. Values are clamped to a minimum value of 1. Default is 1 for all dimensions.
|
static |
ImageDimension enumeration.
Definition at line 90 of file itkBinShrinkImageFilter.h.
|
private |
Definition at line 132 of file itkBinShrinkImageFilter.h.
|
static |
Definition at line 91 of file itkBinShrinkImageFilter.h.
1.8.5
