/*
 * Copyright (C) 2005-2022 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 otbRasterizeVectorDataFilter_h
#define otbRasterizeVectorDataFilter_h

#include "itkUnaryFunctorImageFilter.h"
#include "itkImageToImageFilter.h"
#include "itkCastImageFilter.h"
#include "otbMacro.h"

#include "otbVectorData.h"

#include "gdal.h"
#include "gdal_alg.h"
#include "ogr_srs_api.h"

namespace otb
{

/** \class RasterizeVectorDataFilter
 *  \brief Burn geometries from the specified VectorData into raster
 *
 *  This class handles burning several input VectorDatas into the
 *  input raster. It handles producing the output in any pixel type
 *  supported by OTB since this class inherits itk::CastImageFilter.
 *
 *  An explicit list of burn values for each layer for each band must
 *  be passed in, if not, the burn vector set by the user will be
 *  duplicated to fit this condition.
 *
 *  The user can set an OutputPixelType as a burn vector via
 *  AddBurnValue(OutputImagePixelType burnValuesPix). To have a
 *  different color for each VectorData, use this method with
 *  different burnValuesPix as many times as VectorDatas set.
 *  Again, the color will be duplicated if only one burnValuesPix
 *  is set.
 *
 *  Note : The VectorDatas and the input raster must be in the same
 *  projectionRef. Nothing is done in this class to reproject the
 *  VectorData into the image coordinate system.
 *
 * \ingroup OTBConversion
 */
template <class TVectorData, class TInputImage, class TOutputImage = TInputImage>
class ITK_EXPORT RasterizeVectorDataFilter : public itk::CastImageFilter<TInputImage, TOutputImage>
{
public:
  /** Standard class typedefs */
  typedef RasterizeVectorDataFilter Self;
  typedef itk::CastImageFilter<TInputImage, TOutputImage> Superclass;
  typedef itk::SmartPointer<Self>       Pointer;
  typedef itk::SmartPointer<const Self> ConstPointer;

  /** Run-time type information (and related methods). */
  // itkTypeMacro(RasterizeVectorDataFilter, itk::InPlaceImageFilter);
  itkTypeMacro(RasterizeVectorDataFilter, itk::CastImageFilter);

  /** Method for creation through the object factory. */
  itkNewMacro(Self);

  typedef TInputImage                           InputImageType;
  typedef typename InputImageType::ConstPointer InputImagePointer;
  typedef typename InputImageType::RegionType   InputImageRegionType;
  typedef typename InputImageType::PixelType    InputImagePixelType;
  typedef typename InputImageType::IndexType    InputIndexType;
  typedef typename InputImageType::PointType    InputPointType;

  typedef TOutputImage                                OutputImageType;
  typedef typename OutputImageType::Pointer           OutputImagePointer;
  typedef typename OutputImageType::RegionType        OutputImageRegionType;
  typedef typename OutputImageType::PixelType         OutputImagePixelType;
  typedef typename OutputImageType::InternalPixelType OutputImageInternalPixelType;

  /** VectorData typedefs*/
  typedef TVectorData                           VectorDataType;
  typedef typename VectorDataType::DataTreeType DataTreeType;
  typedef typename DataTreeType::TreeNodeType   InternalTreeNodeType;
  typedef typename DataTreeType::Pointer        DataTreePointerType;
  typedef typename DataTreeType::ConstPointer   DataTreeConstPointerType;

  typedef itk::DataObject DataObjectType;

  /** Set/Get the AllTouchedMode flag */
  itkSetMacro(AllTouchedMode, bool);
  itkGetConstReferenceMacro(AllTouchedMode, bool);
  itkBooleanMacro(AllTouchedMode);

  const InputImageType* GetInput();
  const DataObjectType* GetInput(unsigned int idx);

  /** Add VectorData Input */
  virtual void AddVectorData(const VectorDataType* vd);

  /**
   * Set the burn values using the output pixel type; all the bands
   * will be burned
   **/
  void AddColor(const OutputImagePixelType& burnValuesPix)
  {
    // checking : If used several times, the user must always set
    // colors with the same size.
    unsigned int previousBandVectorSize = m_BandsToBurn.size();
    if (previousBandVectorSize != 0)
    {
      if (burnValuesPix.Size() != previousBandVectorSize)
      {
        itkExceptionMacro(<< "The color added does not have the same number of elements than the previous "
                          << "added one."
                          << "( Previous color size : " << previousBandVectorSize << ", new one size :" << burnValuesPix.Size() << ")");
      }
    }

    // Add the value stored in the output image pixel type to
    // the burn values vector
    // Add all the bands to be burned and clear previous bands.
    m_BandsToBurn.clear();
    for (unsigned int idx = 0; idx < burnValuesPix.Size(); ++idx)
    {
      m_BandsToBurn.push_back(idx + 1); // Gdal bands count begins from 1
      m_BurnValues.push_back(static_cast<double>(burnValuesPix.GetElement(idx)));
    }
  }

protected:
  void GenerateData() override;

  RasterizeVectorDataFilter();
  ~RasterizeVectorDataFilter() override
  {
    if (m_OGRDataSourcePointer != nullptr)
    {
      GDALClose(m_OGRDataSourcePointer);
    }
  }

  void GenerateOutputInformation() override;

  void PrintSelf(std::ostream& os, itk::Indent indent) const override;

private:
  RasterizeVectorDataFilter(const Self&) = delete;
  void operator=(const Self&) = delete;

  GDALDataset* m_OGRDataSourcePointer;

  // Vector Of LayersH
  std::vector<OGRLayerH> m_SrcDataSetLayers;

  std::vector<double> m_BurnValues;
  std::vector<double> m_FullBurnValues;
  std::vector<int>    m_BandsToBurn;
  bool                m_AllTouchedMode;

}; // end of class RasterizeVectorDataFilter

} // end of namespace otb


#ifndef OTB_MANUAL_INSTANTIATION
#include "otbRasterizeVectorDataFilter.hxx"
#endif

#endif
