itkVideoToVideoFilter.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 itkVideoToVideoFilter_h
#define itkVideoToVideoFilter_h

#include "itkVideoSource.h"
#include "itkVideoStream.h"

namespace itk
{

template< typename TInputVideoStream, typename TOutputVideoStream >
class VideoToVideoFilter : public VideoSource< TOutputVideoStream >
{
public:

  /*-TYPEDEFS----------------------------------------------------------------*/

  typedef TInputVideoStream                           InputVideoStreamType;
  typedef TOutputVideoStream                          OutputVideoStreamType;
  typedef VideoToVideoFilter< InputVideoStreamType,
                              OutputVideoStreamType > Self;
  typedef VideoSource< OutputVideoStreamType >        Superclass;
  typedef SmartPointer< Self >                        Pointer;
  typedef SmartPointer< const Self >                  ConstPointer;
  typedef WeakPointer< const Self >                   ConstWeakPointer;

  typedef typename Superclass::OutputFrameType              OutputFrameType;
  typedef typename Superclass::OutputFrameSpatialRegionType OutputFrameSpatialRegionType;

  typedef typename InputVideoStreamType::FrameType         InputFrameType;
  typedef typename InputVideoStreamType::SpatialRegionType InputFrameSpatialRegionType;
  typedef typename InputVideoStreamType::IndexType         InputFrameIndexType;
  typedef typename InputVideoStreamType::PixelType         InputFramePixelType;
  typedef typename InputVideoStreamType::PointType         InputFramePointType;
  typedef typename InputVideoStreamType::SpacingType       InputFrameSpacingType;
  typedef typename InputVideoStreamType::SizeType          InputFrameSizeType;
  typedef typename InputVideoStreamType::DirectionType     InputFrameDirectionType;

  itkNewMacro(Self);

  itkTypeMacro(VideoToVideoFilter, VideoSource);

  /*-PUBLIC METHODS----------------------------------------------------------*/

  using Superclass::SetInput;
  virtual void SetInput( const InputVideoStreamType* videoStream);

  virtual void SetInput( unsigned int idx, const InputVideoStreamType* videoStream);

  const InputVideoStreamType* GetInput() const;

  const InputVideoStreamType* GetInput(unsigned int idx) const;

  virtual void UpdateOutputInformation() ITK_OVERRIDE;

protected:

  InputVideoStreamType* GetInput();

  InputVideoStreamType* GetInput(unsigned int idx);

  virtual void GenerateOutputRequestedRegion(DataObject* output) ITK_OVERRIDE;

  virtual void GenerateInputRequestedRegion() ITK_OVERRIDE;

  virtual void BeforeTemporalStreamingGenerateData() ITK_OVERRIDE;

  VideoToVideoFilter();
  virtual ~VideoToVideoFilter();

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

private:

  VideoToVideoFilter(const Self &); //purposely not implemented
  void operator=(const Self &);     //purposely not implemented

};  // end class VideoToVideoFilter

} // end namespace itk

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

#endif