/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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.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 itkFrameDifferenceVideoFilter_h
#define itkFrameDifferenceVideoFilter_h

#include "itkVideoToVideoFilter.h"

namespace itk
{

/** \class FrameDifferenceVideoFilter
 * \brief Compute the squared intensity difference between frame x and frame
 * x+n
 *
 * This filter computes the squared intensity difference between a frame and
 * the nth previous frame.
 *
 * \ingroup ITKVideoFiltering
 */
template<typename TInputVideoStream, typename TOutputVideoStream>
class FrameDifferenceVideoFilter :
  public VideoToVideoFilter<TInputVideoStream, TOutputVideoStream>
{
public:

  /** Standard class typedefs */
  typedef TInputVideoStream                                InputVideoStreamType;
  typedef TOutputVideoStream                               OutputVideoStreamType;
  typedef FrameDifferenceVideoFilter< InputVideoStreamType,
                                   OutputVideoStreamType > Self;
  typedef VideoToVideoFilter< InputVideoStreamType,
                              OutputVideoStreamType >      Superclass;
  typedef SmartPointer< Self >                             Pointer;
  typedef SmartPointer< const Self >                       ConstPointer;
  typedef WeakPointer< const Self >                        ConstWeakPointer;

  typedef typename TInputVideoStream::FrameType  InputFrameType;
  typedef typename InputFrameType::PixelType     InputPixelType;
  typedef typename InputFrameType::RegionType    InputFrameSpatialRegionType;
  typedef typename TOutputVideoStream::FrameType OutputFrameType;
  typedef typename OutputFrameType::PixelType    OutputPixelType;
  typedef typename OutputFrameType::RegionType   OutputFrameSpatialRegionType;

  itkNewMacro(Self);

  itkTypeMacro(FrameDifferenceVideoFilter, VideoToVideoFilter);

  /** Get/Set the offset for computing frame differences. Defaults to 1. */
  void SetFrameOffset(SizeValueType numFrames);
  SizeValueType GetFrameOffset();

protected:

  /** Constructor and Destructor */
  FrameDifferenceVideoFilter();
  virtual ~FrameDifferenceVideoFilter() {}

  /** PrintSelf */
  virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;

  /** FrameDifferenceVideoFilter is implemented as a temporal streaming and
   * spatially multithreaded filter, so we override ThreadedGenerateData */
  virtual void ThreadedGenerateData(
                const OutputFrameSpatialRegionType& outputRegionForThread,
                int threadId) ITK_OVERRIDE;

private:
  FrameDifferenceVideoFilter(const Self &) ITK_DELETE_FUNCTION;
  void operator=(const Self &) ITK_DELETE_FUNCTION;


};  // end class FrameDifferenceVideoFilter

} // end namespace itk

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

#endif
