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
|
/*=========================================================================
*
* 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 itkSliceImageFilter_h
#define itkSliceImageFilter_h
#include "itkImageToImageFilter.h"
namespace itk
{
/** \class SliceImageFilter
* \brief Slices an image based on a starting index and a stopping
* index, and a step size.
*
* This class is designed to facilitate the implementation of extended
* sliced based indexing into images.
*
* The input and output image must be of the same dimension.
*
* The input parameters are a starting and stopping index as well as a
* stepping size. The starting index indicates the first pixels to be
* used and for each dimension the index is incremented by the step
* until the index is equal to or "beyond" the stopping index. If the
* step is negative then the image will be reversed in the dimension,
* and the stopping index is expected to be less then the starting
* index. If the stopping index is already beyond the starting index
* then an image of size zero will be returned.
*
* The output image's starting index is always zero. The origin is the
* physical location of the starting index. The output directions
* cosine matrix is that of the input but with sign changes matching
* that of the step's sign.
*
* \note In certain combinations such as with start=1, and step>1 while
* the physical location of the center of the pixel remains the same,
* the extent (edge to edge space) of the output image will be beyond the
* extent of the original image.
*
* \ingroup ITKImageGrid
*/
template< class TInputImage, class TOutputImage >
class ITK_TEMPLATE_EXPORT SliceImageFilter:
public ImageToImageFilter< TInputImage, TOutputImage >
{
public:
/** Standard class typedefs. */
typedef SliceImageFilter 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(SliceImageFilter, ImageToImageFilter);
/** Typedef to images */
typedef TOutputImage OutputImageType;
typedef TInputImage InputImageType;
typedef typename OutputImageType::Pointer OutputImagePointer;
typedef typename InputImageType::Pointer InputImagePointer;
typedef typename InputImageType::ConstPointer InputImageConstPointer;
typedef typename TOutputImage::IndexType OutputIndexType;
typedef typename TInputImage::IndexType InputIndexType;
typedef typename TOutputImage::OffsetType OutputOffsetType;
/** Typedef to describe the output image region type. */
typedef typename TOutputImage::RegionType OutputImageRegionType;
/** ImageDimension enumeration. */
itkStaticConstMacro(ImageDimension, unsigned int,
TInputImage::ImageDimension);
itkStaticConstMacro(OutputImageDimension, unsigned int,
TOutputImage::ImageDimension);
typedef typename InputImageType::IndexType IndexType;
typedef typename InputIndexType::IndexValueType IndexValueType;
typedef FixedArray< int, ImageDimension > ArrayType;
/** Set/Get the first index extracted from the input image */
itkSetMacro(Start, IndexType);
itkGetConstReferenceMacro(Start, IndexType);
void SetStart(IndexValueType start);
/** Set/Get the excluded end of the range */
itkSetMacro(Stop, IndexType);
itkGetConstReferenceMacro(Stop, IndexType);
void SetStop(IndexValueType stop);
/** Set/Get the stride of indexes extracted
*
* An exception will be generated if 0.
*/
itkSetMacro(Step, ArrayType);
itkGetConstReferenceMacro(Step, ArrayType);
void SetStep( int step);
#ifdef ITK_USE_CONCEPT_CHECKING
/** Begin concept checking */
itkConceptMacro( InputConvertibleToOutputCheck,
( Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType > ) );
itkConceptMacro( SameDimensionCheck,
( Concept::SameDimension< ImageDimension, OutputImageDimension > ) );
/** End concept checking */
#endif
protected:
SliceImageFilter();
~SliceImageFilter() ITK_OVERRIDE {}
void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
/** SliceImageFilter produces an image which is a different
* resolution and with a different pixel spacing than its input
* image.
* \sa ProcessObject::GenerateOutputInformaton() */
virtual void GenerateOutputInformation() ITK_OVERRIDE;
virtual void GenerateInputRequestedRegion() ITK_OVERRIDE;
/** SliceImageFilter can be 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() */
void ThreadedGenerateData(const OutputImageRegionType & outputRegionForThread,
ThreadIdType threadId) ITK_OVERRIDE;
void VerifyInputInformation() ITK_OVERRIDE;
private:
ITK_DISALLOW_COPY_AND_ASSIGN(SliceImageFilter);
IndexType m_Start;
IndexType m_Stop;
ArrayType m_Step;
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkSliceImageFilter.hxx"
#endif
#endif
|