ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::ImageToVideoFilter< TInputImage, TOutputVideoStream > Class Template Reference

#include <itkImageToVideoFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
class itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >

Converts Image to VideoStream representation with a temporal axis.

ImageToVideoFilter is a ProcessObject for converting an Image or VectorImage to a VideoStream. The user provides an input image of at least two dimensions and specifies one axis to interpret as the temporal axis. Image slices along the designated axis are grafted into video frames in the output VideoStream. The filter assumes that temporal samples are axis-aligned (time cannot be rotated) and the temporal accessor index matches its spatial index (no permutation).

Other than the specified temporal axis, axis order is preserved and orientation and spacing information is copied over to each VideoStream frame from the original Image. Image orientation is understood as having LPS (left-posterior-superior) interpretation.

ImageToVideoFilter inherits from VideoSource to indicate that its output is a VideoStream. However, many methods are overridden to properly handle Image rather than VideoStream input to ImageToVideoFilter.

Definition at line 53 of file itkImageToVideoFilter.h.

+ Inheritance diagram for itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >:
+ Collaboration diagram for itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ConstWeakPointer = WeakPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImageIndexType = typename InputImageType::IndexType
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using OutputFrameSpatialRegionType = typename Superclass::OutputFrameSpatialRegionType
 
using OutputFrameType = typename Superclass::OutputFrameType
 
using OutputTemporalRegionType = typename TOutputVideoStream::TemporalRegionType
 
using OutputVideoStreamType = TOutputVideoStream
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToVideoFilter< InputImageType, OutputVideoStreamType >
 
using Superclass = VideoSource< OutputVideoStreamType >
 
- Public Types inherited from itk::VideoSource< TOutputVideoStream >
using ConstPointer = SmartPointer< const Self >
 
using ConstWeakPointer = WeakPointer< const Self >
 
using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType
 
using OutputFrameDirectionType = typename OutputVideoStreamType::DirectionType
 
using OutputFrameIndexType = typename OutputVideoStreamType::IndexType
 
using OutputFramePixelType = typename OutputVideoStreamType::PixelType
 
using OutputFramePointType = typename OutputVideoStreamType::PointType
 
using OutputFrameSizeType = typename OutputVideoStreamType::SizeType
 
using OutputFrameSpacingType = typename OutputVideoStreamType::SpacingType
 
using OutputFrameSpatialRegionType = typename OutputVideoStreamType::SpatialRegionType
 
using OutputFrameType = typename OutputVideoStreamType::FrameType
 
using OutputVideoStreamType = TOutputVideoStream
 
using Pointer = SmartPointer< Self >
 
using Self = VideoSource
 
using Superclass = TemporalProcessObject
 
- Public Types inherited from itk::TemporalProcessObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = TemporalProcessObject
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

const InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
 itkOverrideGetNameOfClassMacro (ImageToVideoFilter)
 
virtual void SetInput (const InputImageType *image)
 
virtual void SetInput (unsigned int idx, const InputImageType *videoStream)
 
virtual IndexValueType GetFrameAxis ()
 
virtual void SetFrameAxis (IndexValueType _arg)
 
- Public Member Functions inherited from itk::VideoSource< TOutputVideoStream >
OutputVideoStreamTypeGetOutput ()
 
OutputVideoStreamTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, OutputVideoStreamType *graft)
 
virtual void GraftOutput (OutputVideoStreamType *graft)
 
 itkOverrideGetNameOfClassMacro (VideoSource)
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
- Public Member Functions inherited from itk::TemporalProcessObject
void EnlargeOutputRequestedRegion (DataObject *output) override
 
void GenerateData () override
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputRequestedRegion (DataObject *output) override
 
virtual SizeValueType GetUnitInputNumberOfFrames ()
 
virtual SizeValueType GetUnitOutputNumberOfFrames ()
 
 itkOverrideGetNameOfClassMacro (TemporalProcessObject)
 
void UpdateOutputData (DataObject *output) override
 
void UpdateOutputInformation () override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
 itkOverrideGetNameOfClassMacro (ProcessObject)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
 itkOverrideGetNameOfClassMacro (Object)
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::VideoSource< TOutputVideoStream >
static unsigned int GetOutputFrameDimension ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
- Static Public Attributes inherited from itk::VideoSource< TOutputVideoStream >
static constexpr unsigned int OutputFrameDimension = OutputFrameType::ImageDimension
 

Protected Member Functions

void GenerateData () override
 
void GenerateInputRequestedRegion () override
 
void GenerateOutputInformation () override
 
void GenerateOutputRequestedRegion (DataObject *output) override
 
InputImageTypeGetInput ()
 
InputImageTypeGetInput (unsigned int idx)
 
 ImageToVideoFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void UpdateOutputInformation () override
 
 ~ImageToVideoFilter () override=default
 
- Protected Member Functions inherited from itk::VideoSource< TOutputVideoStream >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
void GenerateOutputRequestedTemporalRegion (TemporalDataObject *output) override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual int SplitRequestedSpatialRegion (int i, int num, OutputFrameSpatialRegionType &splitRegion)
 
void TemporalStreamingGenerateData () override
 
virtual void ThreadedGenerateData (const OutputFrameSpatialRegionType &outputRegionForThread, int threadId)
 
 VideoSource ()
 
 ~VideoSource () override=default
 
- Protected Member Functions inherited from itk::TemporalProcessObject
virtual void AfterTemporalStreamingGenerateData ()
 
virtual void BeforeTemporalStreamingGenerateData ()
 
virtual void EnlargeOutputRequestedTemporalRegion (TemporalDataObject *output)
 
virtual TemporalRegion GenerateDefaultLargestPossibleTemporalRegion ()
 
virtual void GenerateInputRequestedTemporalRegion ()
 
virtual SizeValueType GetInputStencilCurrentFrameIndex ()
 
virtual void SetFrameSkipPerOutput (OffsetValueType _arg)
 
virtual void SetInputStencilCurrentFrameIndex (SizeValueType _arg)
 
virtual void SetUnitInputNumberOfFrames (SizeValueType _arg)
 
virtual void SetUnitOutputNumberOfFrames (SizeValueType _arg)
 
virtual std::vector< TemporalRegionSplitRequestedTemporalRegion ()
 
 TemporalProcessObject ()
 
 ~TemporalProcessObject () override=default
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

IndexValueType m_FrameAxis { TInputImage::ImageDimension - 1 }
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::VideoSource< TOutputVideoStream >
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::TemporalProcessObject
OffsetValueType m_FrameSkipPerOutput { 1 }
 
SizeValueType m_InputStencilCurrentFrameIndex { 0 }
 
SizeValueType m_UnitInputNumberOfFrames { 1 }
 
SizeValueType m_UnitOutputNumberOfFrames { 1 }
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
using itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::ConstPointer = SmartPointer<const Self>

Definition at line 64 of file itkImageToVideoFilter.h.

◆ ConstWeakPointer

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
using itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::ConstWeakPointer = WeakPointer<const Self>

Definition at line 65 of file itkImageToVideoFilter.h.

◆ InputImageConstPointer

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
using itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 74 of file itkImageToVideoFilter.h.

◆ InputImageIndexType

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
using itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::InputImageIndexType = typename InputImageType::IndexType

Definition at line 77 of file itkImageToVideoFilter.h.

◆ InputImagePixelType

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
using itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::InputImagePixelType = typename InputImageType::PixelType

Definition at line 76 of file itkImageToVideoFilter.h.

◆ InputImagePointer

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
using itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::InputImagePointer = typename InputImageType::Pointer

Input type alias

Definition at line 73 of file itkImageToVideoFilter.h.

◆ InputImageRegionType

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
using itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 75 of file itkImageToVideoFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
using itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::InputImageType = TInputImage

Standard class type aliases

Definition at line 59 of file itkImageToVideoFilter.h.

◆ OutputFrameSpatialRegionType

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
using itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::OutputFrameSpatialRegionType = typename Superclass::OutputFrameSpatialRegionType

Definition at line 69 of file itkImageToVideoFilter.h.

◆ OutputFrameType

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
using itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::OutputFrameType = typename Superclass::OutputFrameType

Output type alias

Definition at line 68 of file itkImageToVideoFilter.h.

◆ OutputTemporalRegionType

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
using itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::OutputTemporalRegionType = typename TOutputVideoStream::TemporalRegionType

Definition at line 70 of file itkImageToVideoFilter.h.

◆ OutputVideoStreamType

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
using itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::OutputVideoStreamType = TOutputVideoStream

Definition at line 60 of file itkImageToVideoFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
using itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::Pointer = SmartPointer<Self>

Definition at line 63 of file itkImageToVideoFilter.h.

◆ Self

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
using itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::Self = ImageToVideoFilter<InputImageType, OutputVideoStreamType>

Definition at line 61 of file itkImageToVideoFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
using itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::Superclass = VideoSource<OutputVideoStreamType>

Definition at line 62 of file itkImageToVideoFilter.h.

Constructor & Destructor Documentation

◆ ImageToVideoFilter()

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::ImageToVideoFilter ( )
protected

◆ ~ImageToVideoFilter()

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::~ImageToVideoFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ GenerateData()

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
void itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::GenerateData ( )
overrideprotectedvirtual

Graft pixel data from input image onto output video frames

Reimplemented from itk::ProcessObject.

◆ GenerateInputRequestedRegion()

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
void itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::GenerateInputRequestedRegion ( )
overrideprotectedvirtual

Override the default implementation of GenerateInputRequestedRegion from VideoSource so that we only get spatial regions from the image input.

Reimplemented from itk::ProcessObject.

◆ GenerateOutputInformation()

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
void itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::GenerateOutputInformation ( )
overrideprotectedvirtual

Set up the output VideoStream via spatial and temporal regions derived from the spatial regions of the input Image.

Reimplemented from itk::ProcessObject.

◆ GenerateOutputRequestedRegion()

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
void itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::GenerateOutputRequestedRegion ( DataObject output)
overrideprotectedvirtual

Generate the requested regions in the output VideoStream from the size of the available input Image.

Reimplemented from itk::ProcessObject.

◆ GetFrameAxis()

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
virtual IndexValueType itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::GetFrameAxis ( )
virtual

Allow the user to specify the axis in the input image that will correspond to the temporal axis in the output temporal object.

◆ GetInput() [1/4]

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
InputImageType* itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::GetInput ( )
protected

Get a non-const version of the input for internal use when setting input's requested regions. This is the only time input should be modified

◆ GetInput() [2/4]

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
const InputImageType* itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::GetInput ( ) const

Get the input Image for this process object

◆ GetInput() [3/4]

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
InputImageType* itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::GetInput ( unsigned int  idx)
protected

◆ GetInput() [4/4]

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
const InputImageType* itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::GetInput ( unsigned int  idx) const

◆ itkOverrideGetNameOfClassMacro()

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::itkOverrideGetNameOfClassMacro ( ImageToVideoFilter< TInputImage, TOutputVideoStream >  )

Run-time type information (and related methods).

◆ New()

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
static Pointer itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::New ( )
static

◆ PrintSelf()

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
void itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ProcessObject.

◆ SetFrameAxis()

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
virtual void itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::SetFrameAxis ( IndexValueType  _arg)
virtual

Allow the user to specify the axis in the input image that will correspond to the temporal axis in the output temporal object.

◆ SetInput() [1/2]

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
virtual void itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::SetInput ( const InputImageType image)
virtual

◆ SetInput() [2/2]

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
virtual void itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::SetInput ( unsigned int  idx,
const InputImageType videoStream 
)
virtual

◆ UpdateOutputInformation()

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
void itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::UpdateOutputInformation ( )
overrideprotectedvirtual

Override the Superclass::UpdateOutputInformation method so that the temporal output region is defined entirely within the GenerateOutputInformation method.

Reimplemented from itk::ProcessObject.

Member Data Documentation

◆ InputImageDimension

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
constexpr unsigned int itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::InputImageDimension = TInputImage::ImageDimension
staticconstexpr

Definition at line 78 of file itkImageToVideoFilter.h.

◆ m_FrameAxis

template<typename TInputImage , typename TOutputVideoStream = VideoStream<Image<typename TInputImage::PixelType, TInputImage::ImageDimension - 1>>>
IndexValueType itk::ImageToVideoFilter< TInputImage, TOutputVideoStream >::m_FrameAxis { TInputImage::ImageDimension - 1 }
private

Index representing the axis accessor index to use for slicing the input Image into frames for the output VideoStream. Default to slowest-moving axis in the input Image.

Definition at line 156 of file itkImageToVideoFilter.h.


The documentation for this class was generated from the following file: