itkVideoSource.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  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 itkVideoSource_h
#define itkVideoSource_h
 
#include "itkTemporalProcessObject.h"
#include "itkVideoStream.h"
 
namespace itk
{

template <typename TOutputVideoStream>
class ITK_TEMPLATE_EXPORT VideoSource : public TemporalProcessObject
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(VideoSource);
 
  /*-TYPEDEFS----------------------------------------------------------------*/

  using Self = VideoSource;
  using Superclass = TemporalProcessObject;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
  using ConstWeakPointer = WeakPointer<const Self>;
  using OutputVideoStreamType = TOutputVideoStream;
 
  using OutputFrameType = typename OutputVideoStreamType::FrameType;
  using OutputFrameSpatialRegionType = typename OutputVideoStreamType::SpatialRegionType;
  using OutputFrameIndexType = typename OutputVideoStreamType::IndexType;
  using OutputFramePixelType = typename OutputVideoStreamType::PixelType;
  using OutputFramePointType = typename OutputVideoStreamType::PointType;
  using OutputFrameSpacingType = typename OutputVideoStreamType::SpacingType;
  using OutputFrameSizeType = typename OutputVideoStreamType::SizeType;
  using OutputFrameDirectionType = typename OutputVideoStreamType::DirectionType;
 
  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(VideoSource);
 
  /*-PUBLIC METHODS----------------------------------------------------------*/

  static constexpr unsigned int OutputFrameDimension = OutputFrameType::ImageDimension;
  static unsigned int
  GetOutputFrameDimension()
  {
    return OutputFrameType::ImageDimension;
  }

  OutputVideoStreamType *
  GetOutput();
 
  OutputVideoStreamType *
  GetOutput(unsigned int idx);

  virtual void
  GraftNthOutput(unsigned int idx, OutputVideoStreamType * graft);

  virtual void
  GraftOutput(OutputVideoStreamType * graft);

  using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType;
  using Superclass::MakeOutput;
  DataObjectPointer
  MakeOutput(DataObjectPointerArraySizeType idx) override;
 
protected:
  void
  GenerateOutputRequestedTemporalRegion(TemporalDataObject * output) override;

  void
  TemporalStreamingGenerateData() override;

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

  virtual void
  AllocateOutputs();

  virtual void
  BeforeThreadedGenerateData()
  {}

  virtual void
  AfterThreadedGenerateData()
  {}

  virtual int
  SplitRequestedSpatialRegion(int i, int num, OutputFrameSpatialRegionType & splitRegion);

  static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION
  ThreaderCallback(void * arg);

  struct ThreadStruct
  {
    Pointer Filter;
  };
 
  VideoSource();
  ~VideoSource() override = default;
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
}; // end class VideoSource
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkVideoSource.hxx"
#endif
 
#endif