ITK  6.0.0
Insight Toolkit
itkCyclicShiftImageFilter.h
Go to the documentation of this file.
1/*=========================================================================
2 *
3 * Copyright NumFOCUS
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0.txt
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 *=========================================================================*/
18#ifndef itkCyclicShiftImageFilter_h
19#define itkCyclicShiftImageFilter_h
20
22
23namespace itk
24{
45template <typename TInputImage, typename TOutputImage = TInputImage>
46class ITK_TEMPLATE_EXPORT CyclicShiftImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
47{
48public:
49 ITK_DISALLOW_COPY_AND_MOVE(CyclicShiftImageFilter);
50
56
58 using InputImageType = TInputImage;
59 using OutputImageType = TOutputImage;
63 using InputImagePixelType = typename InputImageType::PixelType;
67 using OutputImagePixelType = typename OutputImageType::PixelType;
70 using OffsetType = typename OutputImageType::OffsetType;
72
74 static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
75
77 itkNewMacro(Self);
78
80 itkOverrideGetNameOfClassMacro(CyclicShiftImageFilter);
81
83 itkSetMacro(Shift, OffsetType);
84 itkGetConstMacro(Shift, OffsetType);
87protected:
89 ~CyclicShiftImageFilter() override = default;
90 void
91 PrintSelf(std::ostream & os, Indent indent) const override;
92
95 void
97
99 void
101
102
105 OffsetType m_Shift{};
106}; // end of class
107} // end namespace itk
108
109#ifndef ITK_MANUAL_INSTANTIATION
110# include "itkCyclicShiftImageFilter.hxx"
111#endif
112
113
114#endif
Perform a cyclic spatial shift of image intensities on the image grid.
typename OutputImageType::ConstPointer OutputImageConstPointer
typename OutputImageType::PixelType OutputImagePixelType
typename OutputImageType::RegionType OutputImageRegionType
typename InputImageType::Pointer InputImagePointer
typename InputImageType::RegionType InputImageRegionType
typename OutputImageType::Pointer OutputImagePointer
void GenerateInputRequestedRegion() override
void PrintSelf(std::ostream &os, Indent indent) const override
typename InputImageType::PixelType InputImagePixelType
typename InputImageType::ConstPointer InputImageConstPointer
typename OutputImageType::OffsetValueType OffsetValueType
typename OutputImageType::IndexType IndexType
~CyclicShiftImageFilter() override=default
typename OutputImageType::OffsetType OffsetType
void DynamicThreadedGenerateData(const OutputImageRegionType &) override
typename OutputImageType::SizeType SizeType
Base class for filters that take an image as input and produce an image as output.
Control indentation during Print() invocation.
Definition: itkIndent.h:50
Light weight base class for most itk classes.
SmartPointer< const Self > ConstPointer
SmartPointer< Self > Pointer
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
long OffsetValueType
Definition: itkIntTypes.h:97