itkSliceImageFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  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
{
template< class TInputImage, class TOutputImage >
class ITK_TEMPLATE_EXPORT SliceImageFilter:
  public ImageToImageFilter< TInputImage, TOutputImage >
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(SliceImageFilter);

  using Self = SliceImageFilter;
  using Superclass = ImageToImageFilter< TInputImage, TOutputImage >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkNewMacro(Self);

  itkTypeMacro(SliceImageFilter, ImageToImageFilter);

  using OutputImageType = TOutputImage;
  using InputImageType = TInputImage;
  using OutputImagePointer = typename OutputImageType::Pointer;
  using InputImagePointer = typename InputImageType::Pointer;
  using InputImageConstPointer = typename InputImageType::ConstPointer;

  using OutputIndexType = typename TOutputImage::IndexType;
  using InputIndexType = typename TInputImage::IndexType;
  using OutputOffsetType = typename TOutputImage::OffsetType;

  using OutputImageRegionType = typename TOutputImage::RegionType;

  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;


  using IndexType = typename InputImageType::IndexType;
  using IndexValueType = typename InputIndexType::IndexValueType;
  using ArrayType = FixedArray< int, ImageDimension >;

  itkSetMacro(Start, IndexType);
  itkGetConstReferenceMacro(Start, IndexType);
  void SetStart(IndexValueType start);

  itkSetMacro(Stop, IndexType);
  itkGetConstReferenceMacro(Stop, IndexType);
  void SetStop(IndexValueType stop);

  itkSetMacro(Step, ArrayType);
  itkGetConstReferenceMacro(Step, ArrayType);
  void SetStep( int step);


#ifdef ITK_USE_CONCEPT_CHECKING

  itkConceptMacro( InputConvertibleToOutputCheck,
                   ( Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType > ) );
  itkConceptMacro( SameDimensionCheck,
                   ( Concept::SameDimension< ImageDimension, OutputImageDimension > ) );

#endif

protected:
  SliceImageFilter();
  ~SliceImageFilter() override = default;
  void PrintSelf(std::ostream & os, Indent indent) const override;

  void GenerateOutputInformation() override;

  void GenerateInputRequestedRegion() override;

  void DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;


  void VerifyInputInformation() ITKv5_CONST override;

private:
  IndexType m_Start;
  IndexType m_Stop;
  ArrayType m_Step;
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkSliceImageFilter.hxx"
#endif

#endif