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 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
|
/*=========================================================================
*
* 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 itkExpandImageFilter_h
#define itkExpandImageFilter_h
#include "itkImageToImageFilter.h"
#include "itkLinearInterpolateImageFunction.h"
namespace itk
{
/** \class ExpandImageFilter
* \brief Expand the size of an image by an integer factor in each
* dimension.
*
* ExpandImageFilter increases the size of an image by an integer
* factor in each dimension using a interpolation method.
* The output image size in each dimension is given by:
*
* OutputSize[j] = InputSize[j] * ExpandFactors[j]
*
* The output values are obtained by interpolating the input image.
* The default interpolation type used is the LinearInterpolateImageFunction.
* The user can specify a particular interpolation function via
* SetInterpolator(). Note that the input interpolator must derive
* from base class InterpolateImageFunction.
*
* This filter will produce an output with different pixel spacing
* that its input image such that:
*
* OutputSpacing[j] = InputSpacing[j] / ExpandFactors[j]
*
* The filter is templated over the input image type and the output
* image type.
*
* This filter is implemented as a multithreaded filter and supports
* streaming.
*
* \warning This filter only works for image with scalar pixel types.
* For vector images use VectorExpandImageFilter.
*
* This filter assumes that the input and output image has the same
* number of dimensions.
*
* \sa InterpolateImageFunction
* \sa LinearInterpolationImageFunction
* \sa VectorExpandImageFilter
*
* \ingroup GeometricTransform
* \ingroup ITKImageGrid
*/
template< typename TInputImage, typename TOutputImage >
class ITK_TEMPLATE_EXPORT ExpandImageFilter:
public ImageToImageFilter< TInputImage, TOutputImage >
{
public:
/** Standard class typedefs. */
typedef ExpandImageFilter Self;
typedef ImageToImageFilter< TInputImage, TOutputImage > Superclass;
typedef SmartPointer< Self > Pointer;
typedef SmartPointer< const Self > ConstPointer;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Run-time type information (and related methods). */
itkTypeMacro(ExpandImageFilter, ImageToImageFilter);
/** Typedef to describe the output image region type. */
typedef typename TOutputImage::RegionType OutputImageRegionType;
/** ImageDimension enumeration. */
itkStaticConstMacro(ImageDimension, unsigned int,
TInputImage::ImageDimension);
/** Inherit some types from superclass. */
typedef typename Superclass::InputImageType InputImageType;
typedef typename Superclass::OutputImageType OutputImageType;
typedef typename OutputImageType::PixelType OutputPixelType;
typedef typename InputImageType::Pointer InputImagePointer;
typedef typename OutputImageType::Pointer OutputImagePointer;
/** Typedef support for the interpolation function. */
typedef double CoordRepType;
typedef InterpolateImageFunction< InputImageType, CoordRepType > InterpolatorType;
typedef typename InterpolatorType::Pointer InterpolatorPointer;
typedef LinearInterpolateImageFunction< InputImageType, CoordRepType >
DefaultInterpolatorType;
/** Get/Set the interpolator function. */
itkSetObjectMacro(Interpolator, InterpolatorType);
itkGetModifiableObjectMacro(Interpolator, InterpolatorType);
/** The type of the expand factors representation */
typedef FixedArray< unsigned int, ImageDimension > ExpandFactorsType;
/** Set the expand factors. Values are clamped to
* a minimum value of 1. Default is 1 for all dimensions. */
itkSetMacro(ExpandFactors, ExpandFactorsType);
virtual void SetExpandFactors(const unsigned int factor);
/** Get the expand factors. */
itkGetConstReferenceMacro(ExpandFactors, ExpandFactorsType);
/** ExpandImageFilter produces an image which is a different resolution and
* with a different pixel spacing than its input image. As such,
* ExpandImageFilter needs to provide an implementation for
* UpdateOutputInformation() in order to inform the pipeline execution model.
* The original documentation of this method is below.
* \sa ProcessObject::GenerateOutputInformaton() */
virtual void GenerateOutputInformation() ITK_OVERRIDE;
/** ExpandImageFilter needs a smaller input requested region than the output
* requested region. As such, ShrinkImageFilter needs to provide an
* implementation for GenerateInputRequestedRegion() in order to inform
* the pipeline execution model.
* \sa ProcessObject::GenerateInputRequestedRegion() */
virtual void GenerateInputRequestedRegion() ITK_OVERRIDE;
#ifdef ITK_USE_CONCEPT_CHECKING
// Begin concept checking
itkConceptMacro( InputHasNumericTraitsCheck,
( Concept::HasNumericTraits< typename TInputImage::PixelType > ) );
itkConceptMacro( OutputHasNumericTraitsCheck,
( Concept::HasNumericTraits< OutputPixelType > ) );
// End concept checking
#endif
protected:
ExpandImageFilter();
~ExpandImageFilter() ITK_OVERRIDE {}
void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
/** ExpandImageFilter is implemented as a multithreaded filter. Therefore,
* this implementation provides a ThreadedGenerateData() routine which
* is called for each processing thread. The output image data is allocated
* automatically by the superclass prior to calling ThreadedGenerateData().
* ThreadedGenerateData can only write to the portion of the output image
* specified by the parameter "outputRegionForThread"
*
* \sa ImageToImageFilter::ThreadedGenerateData(),
* ImageToImageFilter::GenerateData() */
virtual
void ThreadedGenerateData(const OutputImageRegionType & outputRegionForThread,
ThreadIdType threadId) ITK_OVERRIDE;
/** This method is used to set the state of the filter before
* multi-threading. */
virtual void BeforeThreadedGenerateData() ITK_OVERRIDE;
private:
ITK_DISALLOW_COPY_AND_ASSIGN(ExpandImageFilter);
ExpandFactorsType m_ExpandFactors;
InterpolatorPointer m_Interpolator;
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkExpandImageFilter.hxx"
#endif
#endif
|