otbExtractROIBase.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * 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
 *
 * 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 otbExtractROIBase_h
#define otbExtractROIBase_h
 
#include "itkImageToImageFilter.h"
#include "itkSmartPointer.h"
#include "itkExtractImageFilterRegionCopier.h"
 
namespace otb
{
 
template <class TInputImage, class TOutputImage>
class ExtractROIBase : public itk::ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  typedef ExtractROIBase Self;
  typedef itk::ImageToImageFilter<TInputImage, TOutputImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(ExtractROIBase, itk::ImageToImageFilter);
 
  typedef TInputImage  InputImageType;
  typedef TOutputImage OutputImageType;
 
  typedef typename TOutputImage::RegionType OutputImageRegionType;
  typedef typename TInputImage::RegionType  InputImageRegionType;
 
  typedef typename TOutputImage::PixelType OutputImagePixelType;
  typedef typename TInputImage::PixelType  InputImagePixelType;
 
  typedef typename TOutputImage::IndexType OutputImageIndexType;
  typedef typename TInputImage::IndexType  InputImageIndexType;
  typedef typename TOutputImage::SizeType  OutputImageSizeType;
  typedef typename TInputImage::SizeType   InputImageSizeType;
 
  itkStaticConstMacro(InputImageDimension, unsigned int, TInputImage::ImageDimension);
  itkStaticConstMacro(OutputImageDimension, unsigned int, TOutputImage::ImageDimension);
 
  typedef itk::ImageToImageFilterDetail::ExtractImageFilterRegionCopier<itkGetStaticConstMacro(InputImageDimension),
                                                                        itkGetStaticConstMacro(OutputImageDimension)>
      ExtractROIBaseRegionCopierType;
 
  itkGetMacro(ExtractionRegion, InputImageRegionType);
 
  void SetExtractionRegion(InputImageRegionType roi);
 
  itkSetMacro(StartX, unsigned long);
  itkGetConstMacro(StartX, unsigned long);
  itkSetMacro(StartY, unsigned long);
  itkGetConstMacro(StartY, unsigned long);
 
  itkSetMacro(SizeX, unsigned long);
  itkGetConstMacro(SizeX, unsigned long);
  itkSetMacro(SizeY, unsigned long);
  itkGetConstMacro(SizeY, unsigned long);
 
protected:
  ExtractROIBase();
  ~ExtractROIBase() override
  {
  }
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  void GenerateInputRequestedRegion() override;
 
  void GenerateOutputInformation() override;
 
  void CallCopyOutputRegionToInputRegion(InputImageRegionType& destRegion, const OutputImageRegionType& srcRegion) override;
 
  //  ATTENTION bizarre
 
  void ThreadedGenerateData(const OutputImageRegionType& /*outputRegionForThread*/, itk::ThreadIdType /*threadId*/) override
 
  {
  }
 
  void SetInternalExtractionRegion(InputImageRegionType extractRegion);
 
  InputImageRegionType  m_ExtractionRegion;
  OutputImageRegionType m_OutputImageRegion;
 
private:
  ExtractROIBase(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  unsigned long m_StartX;
  unsigned long m_StartY;
 
  unsigned long m_SizeX;
  unsigned long m_SizeY;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbExtractROIBase.hxx"
#endif
 
#endif