otbStreamingWarpImageFilter.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 otbStreamingWarpImageFilter_h
#define otbStreamingWarpImageFilter_h
 
#include "itkWarpImageFilter.h"
#include "otbStreamingTraits.h"
 
namespace otb
{
 
template <class TInputImage, class TOutputImage, class TDisplacementField>
class ITK_EXPORT StreamingWarpImageFilter : public itk::WarpImageFilter<TInputImage, TOutputImage, TDisplacementField>
{
public:
  typedef StreamingWarpImageFilter Self;
  typedef itk::WarpImageFilter<TInputImage, TOutputImage, TDisplacementField> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(StreamingWarpImageFilter, itk::WarpImageFilter);
 
  typedef TInputImage                                InputImageType;
  typedef typename InputImageType::Pointer           InputImagePointerType;
  typedef TOutputImage                               OutputImageType;
  typedef typename OutputImageType::PointType        PointType;
  typedef typename OutputImageType::IndexType        IndexType;
  typedef typename OutputImageType::PixelType        PixelType;
  typedef typename OutputImageType::SpacingType      SpacingType;
  typedef typename OutputImageType::Pointer          OutputImagePointerType;
  typedef typename OutputImageType::RegionType       OutputImageRegionType;
  typedef TDisplacementField                         DisplacementFieldType;
  typedef typename DisplacementFieldType::PixelType  DisplacementValueType;
  typedef typename DisplacementFieldType::Pointer    DisplacementFieldPointerType;
  typedef typename DisplacementFieldType::RegionType DisplacementFieldRegionType;
 
  itkSetMacro(MaximumDisplacement, DisplacementValueType);
  itkGetConstReferenceMacro(MaximumDisplacement, DisplacementValueType);
 
  const SpacingType& GetOutputSpacing() const override
  {
    return m_OutputSignedSpacing;
  };
 
  void SetOutputSpacing(const SpacingType OutputSpacing) override;
  void SetOutputSpacing(const double* values) override;
 
protected:
  StreamingWarpImageFilter();
 
  ~StreamingWarpImageFilter() override
  {
  }
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
  void GenerateInputRequestedRegion() override;
 
  void GenerateOutputInformation() override;
 
  void DynamicThreadedGenerateData(const OutputImageRegionType& outputRegionForThread) override;
 
private:
  StreamingWarpImageFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  // Because of itk positive spacing we need this member to be compliant with otb
  // signed spacing
  SpacingType m_OutputSignedSpacing;
 
  // Assessment of the maximum displacement for streaming
  DisplacementValueType m_MaximumDisplacement;
};
 
} // end namespace otb
 
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbStreamingWarpImageFilter.hxx"
#endif
 
#endif