otbStreamingResampleImageFilter.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 otbStreamingResampleImageFilter_h
#define otbStreamingResampleImageFilter_h
 
#include "itkImageToImageFilter.h"
#include "otbStreamingWarpImageFilter.h"
#include "itkTransformToDisplacementFieldSource.h"
#include "itkLinearInterpolateImageFunction.h"
#include "otbImage.h"
#include "itkVector.h"
 
#include "otbMacro.h"
 
namespace otb
{
 
template <class TInputImage, class TOutputImage, class TInterpolatorPrecisionType = double>
class ITK_EXPORT StreamingResampleImageFilter : public itk::ImageToImageFilter<TInputImage, TOutputImage>
{
public:
  typedef StreamingResampleImageFilter Self;
  typedef itk::ImageToImageFilter<TInputImage, TOutputImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(StreamingResampleImageFilter, itk::ImageToImageFilter);
 
  typedef TInputImage  InputImageType;
  typedef TOutputImage OutputImageType;
 
  typedef itk::Vector<double, TOutputImage::ImageDimension> DisplacementType;
  typedef otb::Image<DisplacementType> DisplacementFieldType;
 
  typedef StreamingWarpImageFilter<InputImageType, OutputImageType, DisplacementFieldType> WarpImageFilterType;
 
  typedef itk::TransformToDisplacementFieldSource<DisplacementFieldType, double> DisplacementFieldGeneratorType;
  typedef typename DisplacementFieldGeneratorType::TransformType TransformType;
  typedef typename DisplacementFieldGeneratorType::SizeType      SizeType;
  typedef typename DisplacementFieldGeneratorType::SpacingType   SpacingType;
  typedef typename DisplacementFieldGeneratorType::OriginType    OriginType;
  typedef typename DisplacementFieldGeneratorType::IndexType     IndexType;
  typedef typename DisplacementFieldGeneratorType::RegionType    RegionType;
 
  typedef itk::InterpolateImageFunction<InputImageType, TInterpolatorPrecisionType> InterpolatorType;
  typedef typename InterpolatorType::Pointer InterpolatorPointerType;
  typedef itk::LinearInterpolateImageFunction<InputImageType, TInterpolatorPrecisionType> DefaultInterpolatorType;
 
  typedef itk::ImageBase<OutputImageType::ImageDimension> ImageBaseType;
 
 
  void SetTransform(TransformType* transform)
  {
    m_DisplacementFilter->SetTransform(transform);
    this->Modified();
  }
  otbGetObjectMemberConstMacro(DisplacementFilter, Transform, const TransformType*);
 
  void SetDisplacementFieldSpacing(SpacingType spacing);
 
  const SpacingType& GetDisplacementFieldSpacing() const
  {
    return m_SignedOutputSpacing;
  };
 
  // Output Origin
  void SetOutputOrigin(const OriginType& origin)
  {
    m_DisplacementFilter->SetOutputOrigin(origin);
    m_WarpFilter->SetOutputOrigin(origin);
    this->Modified();
  }
  otbGetObjectMemberConstReferenceMacro(WarpFilter, OutputOrigin, OriginType);
 
  // Output Start index
  otbSetObjectMemberMacro(WarpFilter, OutputStartIndex, IndexType);
  otbGetObjectMemberConstReferenceMacro(WarpFilter, OutputStartIndex, IndexType);
 
  // Output Size
  otbSetObjectMemberMacro(WarpFilter, OutputSize, SizeType);
  otbGetObjectMemberConstReferenceMacro(WarpFilter, OutputSize, SizeType);
 
  // Output Spacing
  otbSetObjectMemberMacro(WarpFilter, OutputSpacing, SpacingType);
  otbGetObjectMemberConstReferenceMacro(WarpFilter, OutputSpacing, SpacingType);
 
  void SetInterpolator(InterpolatorType* interpolator)
  {
    m_WarpFilter->SetInterpolator(interpolator);
    this->Modified();
  }
  otbGetObjectMemberConstMacro(WarpFilter, Interpolator, const InterpolatorType*);
 
  otbSetObjectMemberMacro(WarpFilter, EdgePaddingValue, typename OutputImageType::PixelType);
  otbGetObjectMemberMacro(WarpFilter, EdgePaddingValue, typename OutputImageType::PixelType);
 
  void SetOutputParametersFromImage(const ImageBaseType* image);
 
  /* Set number of threads for Deformation field generator*/
  void SetDisplacementFilterNumberOfThreads(unsigned int nbThread)
  {
    m_DisplacementFilter->SetNumberOfWorkUnits(nbThread);
  }
 
  void PropagateRequestedRegion(itk::DataObject* output) override;
 
protected:
  StreamingResampleImageFilter();
 
  ~StreamingResampleImageFilter() override{};
 
  void GenerateData() override;
 
  void GenerateOutputInformation() override;
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
private:
  StreamingResampleImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  // We need this to respect ConstRef macro and to be compliant with itk positive
  // spacing
  SpacingType m_SignedOutputSpacing;
 
  typename DisplacementFieldGeneratorType::Pointer m_DisplacementFilter;
  typename WarpImageFilterType::Pointer            m_WarpFilter;
};
 
} // namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbStreamingResampleImageFilter.hxx"
#endif
 
#endif