itkFrameAverageVideoFilter.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  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 __itkFrameAverageVideoFilter_h
#define __itkFrameAverageVideoFilter_h

#include "itkVideoToVideoFilter.h"

namespace itk
{

template<class TInputVideoStream, class TOutputVideoStream>
class ITK_EXPORT FrameAverageVideoFilter :
  public VideoToVideoFilter<TInputVideoStream, TOutputVideoStream>
{
public:

  typedef TInputVideoStream                                InputVideoStreamType;
  typedef TOutputVideoStream                               OutputVideoStreamType;
  typedef FrameAverageVideoFilter< 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(FrameAverageVideoFilter, VideoToVideoFilter);

  void SetNumberOfFrames(SizeValueType numFrames);
  SizeValueType GetNumberOfFrames();

protected:

  FrameAverageVideoFilter();
  virtual ~FrameAverageVideoFilter() {}

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

  virtual void ThreadedGenerateData(
                const OutputFrameSpatialRegionType& outputRegionForThread,
                int threadId);

private:
  FrameAverageVideoFilter(const Self &);  // purposely not implemented
  void operator=(const Self &);           // purposely not implemented


};  // end class FrameAverageVideoFilter

} // end namespace itk

#if ITK_TEMPLATE_TXX
#include "itkFrameAverageVideoFilter.hxx"
#endif

#endif