itkImageToVideoFilter.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 itkImageToVideoFilter_h
#define itkImageToVideoFilter_h
 
#include "itkImage.h"
#include "itkVideoSource.h"
#include "itkVideoStream.h"
#include "itkTemporalRegion.h"
#include "itkMacro.h"
 
namespace itk
{

template <typename TInputImage,
          typename TOutputVideoStream =
            VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
class ITK_TEMPLATE_EXPORT ImageToVideoFilter : public VideoSource<TOutputVideoStream>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ImageToVideoFilter);

  using InputImageType = TInputImage;
  using OutputVideoStreamType = TOutputVideoStream;
  using Self = ImageToVideoFilter<InputImageType, OutputVideoStreamType>;
  using Superclass = VideoSource<OutputVideoStreamType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
  using ConstWeakPointer = WeakPointer<const Self>;

  using OutputFrameType = typename Superclass::OutputFrameType;
  using OutputFrameSpatialRegionType = typename Superclass::OutputFrameSpatialRegionType;
  using OutputTemporalRegionType = typename TOutputVideoStream::TemporalRegionType;

  using InputImagePointer = typename InputImageType::Pointer;
  using InputImageConstPointer = typename InputImageType::ConstPointer;
  using InputImageRegionType = typename InputImageType::RegionType;
  using InputImagePixelType = typename InputImageType::PixelType;
  using InputImageIndexType = typename InputImageType::IndexType;
  static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension;
 
  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(ImageToVideoFilter);

  using Superclass::SetInput;
  virtual void
  SetInput(const InputImageType * image);
 
  virtual void
  SetInput(unsigned int idx, const InputImageType * image);

  const InputImageType *
  GetInput() const;
 
  const InputImageType *
  GetInput(unsigned int idx) const;

  itkGetMacro(FrameAxis, IndexValueType);
  itkSetMacro(FrameAxis, IndexValueType);
 
protected:
  ImageToVideoFilter();
  ~ImageToVideoFilter() override = default;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  InputImageType *
  GetInput();
 
  InputImageType *
  GetInput(unsigned int idx);

  void
  GenerateOutputInformation() override;

  void
  UpdateOutputInformation() override;

  void
  GenerateOutputRequestedRegion(DataObject * output) override;

  void
  GenerateInputRequestedRegion() override;

  void
  GenerateData() override;
 
private:
  IndexValueType m_FrameAxis{ TInputImage::ImageDimension - 1 };
 
}; // end class ImageToVideoFilter
 
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkImageToVideoFilter.hxx"
#endif
 
#endif // itkImageToVideoFilter_h