1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
|
/*=========================================================================
*
* Copyright Insight Software Consortium
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef __itkPadImageFilter_h
#define __itkPadImageFilter_h
#include "itkImageToImageFilter.h"
#include "itkImageBoundaryCondition.h"
namespace itk
{
/** \class PadImageFilter
* \brief Increase the image size by padding. Superclass for filters that fill
* in extra pixels.
*
*
* \image html PadImageFilter.png "Visual explanation of padding regions."
*
* PadImageFilter changes the image boundary of an image by padding each
* dimension with subclass defined algorithms. The number of pixels to pad
* for the upper and lower bounds of each dimension must be specified.
*
* This filter is implemented as a multithreaded filter. It provides a
* ThreadedGenerateData() method for its implementation.
*
* \ingroup GeometricTransform
* \sa WrapPadImageFilter, MirrorPadImageFilter, ConstantPadImageFilter
*
* \ingroup ITKImageGrid
*/
template< typename TInputImage, typename TOutputImage >
class PadImageFilter:
public ImageToImageFilter< TInputImage, TOutputImage >
{
public:
/** Standard class typedefs. */
typedef PadImageFilter Self;
typedef ImageToImageFilter< TInputImage, TOutputImage > Superclass;
typedef SmartPointer< Self > Pointer;
typedef SmartPointer< const Self > ConstPointer;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Typedef to describe the output and input image region types. */
typedef typename TOutputImage::RegionType OutputImageRegionType;
typedef typename TInputImage::RegionType InputImageRegionType;
/** Typedef to describe the type of pixel. */
typedef typename TOutputImage::PixelType OutputImagePixelType;
typedef typename TInputImage::PixelType InputImagePixelType;
/** Typedef to describe the output and input image index and size types. */
typedef typename TOutputImage::IndexType OutputImageIndexType;
typedef typename TInputImage::IndexType InputImageIndexType;
typedef typename TOutputImage::SizeType OutputImageSizeType;
typedef typename TInputImage::SizeType InputImageSizeType;
typedef typename TInputImage::SizeType SizeType;
typedef typename TInputImage::SizeValueType SizeValueType;
/** Typedef to describe the boundary condition. */
typedef ImageBoundaryCondition< TInputImage, TOutputImage > BoundaryConditionType;
typedef BoundaryConditionType * BoundaryConditionPointerType;
/** Run-time type information (and related methods). */
itkTypeMacro(PadImageFilter, ImageToImageFilter);
/** ImageDimension enumeration. */
itkStaticConstMacro(ImageDimension, unsigned int,
TInputImage::ImageDimension);
/** Set/Get the output image padding. Default is no padding
* (same as input). */
itkSetMacro(PadLowerBound, SizeType);
itkSetMacro(PadUpperBound, SizeType);
itkGetConstReferenceMacro(PadLowerBound, SizeType);
itkGetConstReferenceMacro(PadUpperBound, SizeType);
itkSetVectorMacro(PadLowerBound, const SizeValueType, ImageDimension);
itkSetVectorMacro(PadUpperBound, const SizeValueType, ImageDimension);
void SetPadBound(const InputImageSizeType & bound)
{
this->SetPadLowerBound(bound);
this->SetPadUpperBound(bound);
}
/** Set/get the boundary condition. */
itkSetMacro(BoundaryCondition, BoundaryConditionPointerType);
itkGetConstMacro(BoundaryCondition, BoundaryConditionPointerType);
protected:
PadImageFilter();
~PadImageFilter() {}
void PrintSelf(std::ostream & os, Indent indent) const;
/** PadImageFilter produces an image which is a different resolution
* than its input image. As such, PadImageFilter needs to
* provide an implementation for GenerateOutputInformation() in order
* to inform the pipeline execution model. The original
* documentation of this method is below.
* \sa ProcessObject::GenerateOutputInformaton() */
virtual void GenerateOutputInformation();
/** PadImageFilter needs a smaller input requested region than
* output requested region. As such, PadImageFilter needs to
* provide an implementation for GenerateInputRequestedRegion() in
* order to inform the pipeline execution model.
* \sa ProcessObject::GenerateInputRequestedRegion() */
virtual void GenerateInputRequestedRegion();
/** This class can be multithreaded. */
void ThreadedGenerateData(const OutputImageRegionType & outputRegionForThread,
ThreadIdType threadId);
/** Method for subclasses to set the boundary condition. */
void InternalSetBoundaryCondition( const BoundaryConditionPointerType boundaryCondition );
private:
PadImageFilter(const Self &); //purposely not implemented
void operator=(const Self &); //purposely not implemented
SizeType m_PadLowerBound;
SizeType m_PadUpperBound;
BoundaryConditionPointerType m_BoundaryCondition;
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkPadImageFilter.hxx"
#endif
#endif
|