/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  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
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  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 itkPathAndImageToPathFilter_h
#define itkPathAndImageToPathFilter_h

#include "itkPathToPathFilter.h"

namespace itk
{
/**
 * \class PathAndImageToPathFilter
 * \brief Base class for filters that take both a path and an image as input and produce a path as output.
 *
 * This class is the base class for filters that take both a path and an image
 * as input and produce a path as output.  Specifically, this class defines the
 * methods SetPathInput() and SetImageInput().  (It also establishes the
 * precedent of having path inputs precede image inputs for functions producing
 * paths as outputs, according to the underlying DataObject implementation.)
 *
 * \ingroup PathFilters
 * \ingroup ITKPath
 */
template <typename TInputPath, typename TInputImage, typename TOutputPath>
class ITK_TEMPLATE_EXPORT PathAndImageToPathFilter : public PathToPathFilter<TInputPath, TOutputPath>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(PathAndImageToPathFilter);

  /** Standard class type aliases. */
  using Self = PathAndImageToPathFilter;
  using Superclass = PathToPathFilter<TInputPath, TOutputPath>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

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

  /** \see LightObject::GetNameOfClass() */
  itkOverrideGetNameOfClassMacro(PathAndImageToPathFilter);

  /** Some convenient type alias. */
  using InputPathType = TInputPath;
  using InputPathPointer = typename InputPathType::Pointer;
  using InputPathConstPointer = typename InputPathType::ConstPointer;
  using InputPathInputType = typename InputPathType::InputType;
  using InputPathOutputType = typename InputPathType::OutputType;
  using InputPathIndexType = typename InputPathType::IndexType;
  using InputPathOffsetType = typename InputPathType::OffsetType;
  using InputImageType = TInputImage;
  using InputImagePointer = typename InputImageType::ConstPointer;
  using InputImageRegionType = typename InputImageType::RegionType;
  using InputImagePixelType = typename InputImageType::PixelType;
  using OutputPathType = TOutputPath;
  using OutputPathPointer = typename OutputPathType::Pointer;
  using OutputPathInputType = typename OutputPathType::InputType;
  using OutputPathOutputType = typename OutputPathType::OutputType;
  using OutputPathIndexType = typename OutputPathType::IndexType;
  using OutputPathOffsetType = typename OutputPathType::OffsetType;

  /** ImageDimension constants */
  static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;

  /** Set/Get the path input of this process object. */
  virtual void
  SetPathInput(const TInputPath * path);

  const InputPathType *
  GetPathInput();

  /** Set/Get the image input of this process object. */
  virtual void
  SetImageInput(const TInputImage * image);

  const InputImageType *
  GetImageInput();

protected:
  PathAndImageToPathFilter();
  ~PathAndImageToPathFilter() override = default;

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

  /** What is the input requested region that is required to produce the output
   * requested region?  Up till and including now, the base assumption is that
   * the largest possible region will be requested of the input.  If this method
   * is overridden, the new method should call its superclass' implementation as
   * its first step.
   *
   * \sa ProcessObject::GenerateInputRequestedRegion() */
  void
  GenerateInputRequestedRegion() override;
};
} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkPathAndImageToPathFilter.hxx"
#endif

#endif
