ITK  6.0.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::VideoFileReader< TOutputVideoStream > Class Template Reference
Group Video » Module ITKVideoIO

#include <itkVideoFileReader.h>

Detailed Description

template<typename TOutputVideoStream>
class itk::VideoFileReader< TOutputVideoStream >

Reader that creates a VideoStream.

This class is responsible for reading video information from files. It is a subclass of VideoSource, giving it functionality to connect to other TemporalProcessObject classes (specifically, VideoToVideoFilter classes). It uses the temporal streaming implementation provided by TemporalProcessObject to load a single frame at a time into the frame buffer of the output VideoSource.

Definition at line 42 of file itkVideoFileReader.h.

+ Inheritance diagram for itk::VideoFileReader< TOutputVideoStream >:
+ Collaboration diagram for itk::VideoFileReader< TOutputVideoStream >:

Public Types

using ConvertPixelTraits = DefaultConvertPixelTraits< PixelType >
 
using DirectionType = typename FrameType::DirectionType
 
using FrameOffsetType = typename VideoIOBase::FrameOffsetType
 
using FrameType = typename VideoStreamType::FrameType
 
using IndexType = typename FrameType::IndexType
 
using PixelType = typename FrameType::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename FrameType::PointType
 
using RegionType = typename FrameType::RegionType
 
using Self = VideoFileReader
 
using SizeType = typename FrameType::SizeType
 
using SpacingType = typename FrameType::SpacingType
 
using Superclass = VideoSource< TOutputVideoStream >
 
using TemporalOffsetType = typename VideoIOBase::TemporalOffsetType
 
using TemporalRatioType = typename VideoIOBase::TemporalRatioType
 
using VideoStreamPointer = typename VideoStreamType::Pointer
 
using VideoStreamType = TOutputVideoStream
 
- 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

FrameOffsetType GetCurrentPositionFrame ()
 
TemporalOffsetType GetCurrentPositionMSec ()
 
TemporalRatioType GetCurrentPositionRatio ()
 
TemporalRatioType GetFramesPerSecond ()
 
const char * GetNameOfClass () const override
 
FrameOffsetType GetNumberOfFrames ()
 
void SetVideoIO (VideoIOBase *videoIO)
 
void UpdateOutputInformation () override
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
virtual void SetIFrameSafe (bool _arg)
 
virtual bool GetIFrameSafe ()
 
virtual void IFrameSafeOn ()
 
- Public Member Functions inherited from itk::VideoSource< TOutputVideoStream >
const char * GetNameOfClass () const override
 
OutputVideoStreamType * GetOutput ()
 
OutputVideoStreamType * GetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, OutputVideoStreamType *graft)
 
virtual void GraftOutput (OutputVideoStreamType *graft)
 
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
 
const char * GetNameOfClass () const override
 
virtual SizeValueType GetUnitInputNumberOfFrames ()
 
virtual SizeValueType GetUnitOutputNumberOfFrames ()
 
virtual void TemporalStreamingGenerateData ()
 
void UpdateOutputData (DataObject *output) override
 
void UpdateOutputInformation () override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderType * GetMultiThreader () const
 
const char * GetNameOfClass () const override
 
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)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
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 ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
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 ThreadIdType & GetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) 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
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStamp & GetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
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 Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

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 FrameDimension = FrameType::ImageDimension
 
- Static Public Attributes inherited from itk::VideoSource< TOutputVideoStream >
static constexpr unsigned int OutputFrameDimension = OutputFrameType::ImageDimension
 

Protected Member Functions

void DoConvertBuffer (const void *inputData, FrameOffsetType frameNumber)
 
void InitializeVideoIO ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void TemporalStreamingGenerateData () override
 
 VideoFileReader ()
 
 ~VideoFileReader () 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 void GenerateOutputRequestedTemporalRegion (TemporalDataObject *output)
 
virtual SizeValueType GetInputStencilCurrentFrameIndex ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetFrameSkipPerOutput (OffsetValueType _arg)
 
virtual void SetInputStencilCurrentFrameIndex (SizeValueType _arg)
 
virtual void SetUnitInputNumberOfFrames (SizeValueType _arg)
 
virtual void SetUnitOutputNumberOfFrames (SizeValueType _arg)
 
virtual std::vector< TemporalRegion > SplitRequestedTemporalRegion ()
 
 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 ()
 
virtual void GenerateData ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredOutputs () 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 ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 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 () const
 
virtual void VerifyPreconditions () const
 
 ~ProcessObject () override
 
DataObject * GetInput (DataObjectPointerArraySizeType idx)
 
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
 
DataObject * GetPrimaryInput ()
 
const DataObject * GetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObject * GetOutput (const DataObjectIdentifierType &key)
 
const DataObject * GetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObject * GetOutput (DataObjectPointerArraySizeType i)
 
const DataObject * GetOutput (DataObjectPointerArraySizeType i) const
 
DataObject * GetPrimaryOutput ()
 
const DataObject * GetPrimaryOutput () 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
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
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 PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

std::string m_FileName {}
 
bool m_IFrameSafe {}
 
bool m_PixelConversionNeeded {}
 
VideoIOBase::Pointer m_VideoIO {}
 

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
template<typename TSourceObject >
static void MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
 
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

◆ ConvertPixelTraits

template<typename TOutputVideoStream >
using itk::VideoFileReader< TOutputVideoStream >::ConvertPixelTraits = DefaultConvertPixelTraits<PixelType>

Pixel conversion type alias

Definition at line 70 of file itkVideoFileReader.h.

◆ DirectionType

template<typename TOutputVideoStream >
using itk::VideoFileReader< TOutputVideoStream >::DirectionType = typename FrameType::DirectionType

Definition at line 61 of file itkVideoFileReader.h.

◆ FrameOffsetType

template<typename TOutputVideoStream >
using itk::VideoFileReader< TOutputVideoStream >::FrameOffsetType = typename VideoIOBase::FrameOffsetType

Definition at line 64 of file itkVideoFileReader.h.

◆ FrameType

template<typename TOutputVideoStream >
using itk::VideoFileReader< TOutputVideoStream >::FrameType = typename VideoStreamType::FrameType

Definition at line 54 of file itkVideoFileReader.h.

◆ IndexType

template<typename TOutputVideoStream >
using itk::VideoFileReader< TOutputVideoStream >::IndexType = typename FrameType::IndexType

Definition at line 58 of file itkVideoFileReader.h.

◆ PixelType

template<typename TOutputVideoStream >
using itk::VideoFileReader< TOutputVideoStream >::PixelType = typename FrameType::PixelType

Definition at line 55 of file itkVideoFileReader.h.

◆ Pointer

template<typename TOutputVideoStream >
using itk::VideoFileReader< TOutputVideoStream >::Pointer = SmartPointer<Self>

Definition at line 50 of file itkVideoFileReader.h.

◆ PointType

template<typename TOutputVideoStream >
using itk::VideoFileReader< TOutputVideoStream >::PointType = typename FrameType::PointType

Definition at line 59 of file itkVideoFileReader.h.

◆ RegionType

template<typename TOutputVideoStream >
using itk::VideoFileReader< TOutputVideoStream >::RegionType = typename FrameType::RegionType

Definition at line 56 of file itkVideoFileReader.h.

◆ Self

template<typename TOutputVideoStream >
using itk::VideoFileReader< TOutputVideoStream >::Self = VideoFileReader

Standard class type aliases.

Definition at line 48 of file itkVideoFileReader.h.

◆ SizeType

template<typename TOutputVideoStream >
using itk::VideoFileReader< TOutputVideoStream >::SizeType = typename FrameType::SizeType

Definition at line 57 of file itkVideoFileReader.h.

◆ SpacingType

template<typename TOutputVideoStream >
using itk::VideoFileReader< TOutputVideoStream >::SpacingType = typename FrameType::SpacingType

Definition at line 60 of file itkVideoFileReader.h.

◆ Superclass

template<typename TOutputVideoStream >
using itk::VideoFileReader< TOutputVideoStream >::Superclass = VideoSource<TOutputVideoStream>

Definition at line 49 of file itkVideoFileReader.h.

◆ TemporalOffsetType

template<typename TOutputVideoStream >
using itk::VideoFileReader< TOutputVideoStream >::TemporalOffsetType = typename VideoIOBase::TemporalOffsetType

Definition at line 63 of file itkVideoFileReader.h.

◆ TemporalRatioType

template<typename TOutputVideoStream >
using itk::VideoFileReader< TOutputVideoStream >::TemporalRatioType = typename VideoIOBase::TemporalRatioType

Definition at line 65 of file itkVideoFileReader.h.

◆ VideoStreamPointer

template<typename TOutputVideoStream >
using itk::VideoFileReader< TOutputVideoStream >::VideoStreamPointer = typename VideoStreamType::Pointer

Definition at line 52 of file itkVideoFileReader.h.

◆ VideoStreamType

template<typename TOutputVideoStream >
using itk::VideoFileReader< TOutputVideoStream >::VideoStreamType = TOutputVideoStream

Definition at line 51 of file itkVideoFileReader.h.

Constructor & Destructor Documentation

◆ VideoFileReader()

template<typename TOutputVideoStream >
itk::VideoFileReader< TOutputVideoStream >::VideoFileReader ( )
protected

◆ ~VideoFileReader()

template<typename TOutputVideoStream >
itk::VideoFileReader< TOutputVideoStream >::~VideoFileReader ( )
overrideprotecteddefault

Member Function Documentation

◆ DoConvertBuffer()

template<typename TOutputVideoStream >
void itk::VideoFileReader< TOutputVideoStream >::DoConvertBuffer ( const void *  inputData,
FrameOffsetType  frameNumber 
)
protected

Convert buffer for output

◆ GetCurrentPositionFrame()

template<typename TOutputVideoStream >
FrameOffsetType itk::VideoFileReader< TOutputVideoStream >::GetCurrentPositionFrame ( )

Get the current position as frame, ratio, or MSec

◆ GetCurrentPositionMSec()

template<typename TOutputVideoStream >
TemporalOffsetType itk::VideoFileReader< TOutputVideoStream >::GetCurrentPositionMSec ( )

◆ GetCurrentPositionRatio()

template<typename TOutputVideoStream >
TemporalRatioType itk::VideoFileReader< TOutputVideoStream >::GetCurrentPositionRatio ( )

◆ GetFileName()

template<typename TOutputVideoStream >
virtual const char * itk::VideoFileReader< TOutputVideoStream >::GetFileName ( ) const
virtual

Specify the file to read. This is forwarded to the IO instance.

◆ GetFramesPerSecond()

template<typename TOutputVideoStream >
TemporalRatioType itk::VideoFileReader< TOutputVideoStream >::GetFramesPerSecond ( )

Get framerate

◆ GetIFrameSafe()

template<typename TOutputVideoStream >
virtual bool itk::VideoFileReader< TOutputVideoStream >::GetIFrameSafe ( )
virtual

Get/Set IFrameSafe. If true, the last IFrame will be reported as the last frame for the largest possible temporal region

◆ GetNameOfClass()

template<typename TOutputVideoStream >
const char * itk::VideoFileReader< TOutputVideoStream >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::VideoSource< TOutputVideoStream >.

◆ GetNumberOfFrames()

template<typename TOutputVideoStream >
FrameOffsetType itk::VideoFileReader< TOutputVideoStream >::GetNumberOfFrames ( )

Get number of frames

◆ IFrameSafeOn()

template<typename TOutputVideoStream >
virtual void itk::VideoFileReader< TOutputVideoStream >::IFrameSafeOn ( )
virtual

Get/Set IFrameSafe. If true, the last IFrame will be reported as the last frame for the largest possible temporal region

◆ InitializeVideoIO()

template<typename TOutputVideoStream >
void itk::VideoFileReader< TOutputVideoStream >::InitializeVideoIO ( )
protected

Set up the VideoIO using VideoIOFactory Warning: this will overwrite any currently set VideoIO

◆ New()

template<typename TOutputVideoStream >
static Pointer itk::VideoFileReader< TOutputVideoStream >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TOutputVideoStream >
void itk::VideoFileReader< TOutputVideoStream >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

ITK print mechanism

Reimplemented from itk::VideoSource< TOutputVideoStream >.

◆ SetFileName()

template<typename TOutputVideoStream >
virtual void itk::VideoFileReader< TOutputVideoStream >::SetFileName ( const char *  _arg)
virtual

Specify the file to read. This is forwarded to the IO instance.

◆ SetIFrameSafe()

template<typename TOutputVideoStream >
virtual void itk::VideoFileReader< TOutputVideoStream >::SetIFrameSafe ( bool  _arg)
virtual

Get/Set IFrameSafe. If true, the last IFrame will be reported as the last frame for the largest possible temporal region

◆ SetVideoIO()

template<typename TOutputVideoStream >
void itk::VideoFileReader< TOutputVideoStream >::SetVideoIO ( VideoIOBase *  videoIO)

Set the internal VideoIOBase pointer. This will generally be called by the object that creates the RingBuffer (e.g. itk::VideoFileReader)

◆ TemporalStreamingGenerateData()

template<typename TOutputVideoStream >
void itk::VideoFileReader< TOutputVideoStream >::TemporalStreamingGenerateData ( )
overrideprotectedvirtual

Override TemporalStreamingGenerateData to generate output a single frame. We don't override ThreadedGenerateData because we read whole frames one at a time. As such, we have to handle the allocation of the frames here.

Reimplemented from itk::VideoSource< TOutputVideoStream >.

◆ UpdateOutputInformation()

template<typename TOutputVideoStream >
void itk::VideoFileReader< TOutputVideoStream >::UpdateOutputInformation ( )
overridevirtual

Set up the output information

Reimplemented from itk::TemporalProcessObject.

Member Data Documentation

◆ FrameDimension

template<typename TOutputVideoStream >
constexpr unsigned int itk::VideoFileReader< TOutputVideoStream >::FrameDimension = FrameType::ImageDimension
staticconstexpr

Definition at line 67 of file itkVideoFileReader.h.

◆ m_FileName

template<typename TOutputVideoStream >
std::string itk::VideoFileReader< TOutputVideoStream >::m_FileName {}
private

The file to read

Definition at line 141 of file itkVideoFileReader.h.

◆ m_IFrameSafe

template<typename TOutputVideoStream >
bool itk::VideoFileReader< TOutputVideoStream >::m_IFrameSafe {}
private

Flag to indicate whether to report the last frame as the last IFrame. On by default.

Definition at line 152 of file itkVideoFileReader.h.

◆ m_PixelConversionNeeded

template<typename TOutputVideoStream >
bool itk::VideoFileReader< TOutputVideoStream >::m_PixelConversionNeeded {}
private

Flag to store whether or not the pixel type needs to be converted.

Definition at line 148 of file itkVideoFileReader.h.

◆ m_VideoIO

template<typename TOutputVideoStream >
VideoIOBase::Pointer itk::VideoFileReader< TOutputVideoStream >::m_VideoIO {}
private

VideoIOBase used to retrieve images. This may be changed if more hierarchy is added to support general ImageSet sources.

Definition at line 145 of file itkVideoFileReader.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3