otbImageToProfileFilter.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 otbImageToProfileFilter_h
#define otbImageToProfileFilter_h
 
#include "otbImageToImageListFilter.h"
 
namespace otb
{
template <class TInputImage, class TOutputImage, class TFilter, class TParameter = unsigned int>
class ITK_EXPORT ImageToProfileFilter : public ImageToImageListFilter<TInputImage, TOutputImage>
{
public:
  typedef ImageToProfileFilter Self;
  typedef ImageToImageListFilter<TInputImage, TOutputImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;
 
  itkNewMacro(Self);
 
  itkTypeMacro(ImageToProfileFilter, ImageToImageListFilter);
 
  typedef TInputImage                                     InputImageType;
  typedef TOutputImage                                    OutputImageType;
  typedef TParameter                                      ParameterType;
  typedef TFilter                                         FilterType;
  typedef typename FilterType::Pointer                    FilterPointerType;
  typedef typename Superclass::OutputImageListType        OutputImageListType;
  typedef typename Superclass::OutputImageListPointerType OutputImageListPointerType;
  typedef typename Superclass::InputImagePointer          InputImagePointerType;
 
  itkSetMacro(InitialValue, ParameterType);
  itkGetMacro(InitialValue, ParameterType);
 
  itkSetMacro(ProfileSize, unsigned int);
  itkGetMacro(ProfileSize, unsigned int);
 
  itkSetMacro(Step, ParameterType);
  itkGetMacro(Step, ParameterType);
 
  itkSetMacro(OutputIndex, unsigned int);
  itkGetMacro(OutputIndex, unsigned int);
 
protected:
  virtual void SetProfileParameter(ParameterType /*param*/)
  {
  }
 
  itkGetObjectMacro(Filter, FilterType);
 
  void GenerateData(void) override;
 
  void GenerateOutputInformation(void) override;
 
  void GenerateInputRequestedRegion(void) override;
 
  ImageToProfileFilter();
 
  ~ImageToProfileFilter() override = default;
 
  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
 
private:
  ImageToProfileFilter(const Self&) = delete;
  void operator=(const Self&) = delete;
 
  FilterPointerType m_Filter;
 
  unsigned int m_ProfileSize;
 
  ParameterType m_InitialValue;
 
  ParameterType m_Step;
 
  unsigned int m_OutputIndex;
};
} // End namespace otb
#ifndef OTB_MANUAL_INSTANTIATION
#include "otbImageToProfileFilter.hxx"
#endif
 
#endif