ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
itk::VideoFileReader< TOutputVideoStream > Class Template Reference

#include <itkVideoFileReader.h>

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

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 41 of file itkVideoFileReader.h.

Public Types

typedef
DefaultConvertPixelTraits
< PixelType
ConvertPixelTraits
 
typedef FrameType::DirectionType DirectionType
 
typedef
VideoIOBase::FrameOffsetType 
FrameOffsetType
 
typedef VideoStreamType::FrameType FrameType
 
typedef FrameType::IndexType IndexType
 
typedef FrameType::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef FrameType::PointType PointType
 
typedef FrameType::RegionType RegionType
 
typedef VideoFileReader Self
 
typedef FrameType::SizeType SizeType
 
typedef FrameType::SpacingType SpacingType
 
typedef VideoSource
< TOutputVideoStream > 
Superclass
 
typedef
VideoIOBase::TemporalOffsetType 
TemporalOffsetType
 
typedef
VideoIOBase::TemporalRatioType 
TemporalRatioType
 
typedef VideoStreamType::Pointer VideoStreamPointer
 
typedef TOutputVideoStream VideoStreamType
 
- Public Types inherited from itk::VideoSource< TOutputVideoStream >
typedef SmartPointer< const SelfConstPointer
 
typedef WeakPointer< const SelfConstWeakPointer
 
typedef
ProcessObject::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef
OutputVideoStreamType::DirectionType 
OutputFrameDirectionType
 
typedef
OutputVideoStreamType::IndexType 
OutputFrameIndexType
 
typedef
OutputVideoStreamType::PixelType 
OutputFramePixelType
 
typedef
OutputVideoStreamType::PointType 
OutputFramePointType
 
typedef
OutputVideoStreamType::SizeType 
OutputFrameSizeType
 
typedef
OutputVideoStreamType::SpacingType 
OutputFrameSpacingType
 
typedef
OutputVideoStreamType::SpatialRegionType 
OutputFrameSpatialRegionType
 
typedef
OutputVideoStreamType::FrameType 
OutputFrameType
 
typedef TOutputVideoStream OutputVideoStreamType
 
typedef SmartPointer< SelfPointer
 
typedef VideoSource Self
 
typedef TemporalProcessObject Superclass
 
- Public Types inherited from itk::TemporalProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef TemporalProcessObject Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
FrameOffsetType GetCurrentPositionFrame ()
 
TemporalOffsetType GetCurrentPositionMSec ()
 
TemporalRatioType GetCurrentPositionRatio ()
 
TemporalRatioType GetFramesPerSecond ()
 
virtual const char * GetNameOfClass () const
 
FrameOffsetType GetNumberOfFrames ()
 
void SetVideoIO (VideoIOBase *videoIO)
 
virtual void UpdateOutputInformation () override
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
virtual void SetIFrameSafe (bool _arg)
 
virtual bool GetIFrameSafe ()
 
- Public Member Functions inherited from itk::VideoSource< TOutputVideoStream >
OutputVideoStreamTypeGetOutput ()
 
OutputVideoStreamTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, OutputVideoStreamType *output)
 
virtual void GraftOutput (OutputVideoStreamType *output)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
- Public Member Functions inherited from itk::TemporalProcessObject
virtual void EnlargeOutputRequestedRegion (DataObject *output) override
 
virtual void GenerateData () override
 
virtual void GenerateInputRequestedRegion () override
 
virtual void GenerateOutputRequestedRegion (DataObject *output) override
 
virtual SizeValueType GetUnitInputNumberOfFrames ()
 
virtual SizeValueType GetUnitOutputNumberOfFrames ()
 
virtual void UpdateOutputData (DataObject *output) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
void UpdateProgress (float progress)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
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
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
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 Pointer New ()
 
static unsigned int GetOutputFrameDimension ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static const unsigned int FrameDimension = FrameType::ImageDimension
 
- Static Public Attributes inherited from itk::VideoSource< TOutputVideoStream >
static const unsigned int OutputFrameDimension = OutputFrameType::ImageDimension
 

Protected Member Functions

void DoConvertBuffer (void *inputData, FrameOffsetType frameNumber)
 
void InitializeVideoIO ()
 
virtual void TemporalStreamingGenerateData () override
 
 VideoFileReader ()
 
virtual ~VideoFileReader ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::VideoSource< TOutputVideoStream >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void GenerateOutputRequestedTemporalRegion (TemporalDataObject *output) override
 
virtual int SplitRequestedSpatialRegion (int i, int num, OutputFrameSpatialRegionType &splitRegion)
 
virtual void ThreadedGenerateData (const OutputFrameSpatialRegionType &outputRegionForThread, int threadId)
 
 VideoSource ()
 
virtual ~VideoSource ()
 
- 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
< TemporalRegion
SplitRequestedTemporalRegion ()
 
 TemporalProcessObject ()
 
virtual ~TemporalProcessObject ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputInformation ()
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (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
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
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 num, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- 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 ()
 

Protected Attributes

std::string m_FileName
 
bool m_IFrameSafe
 
bool m_PixelConversionNeeded
 
VideoIOBase::Pointer m_VideoIO
 
- Protected Attributes inherited from itk::TemporalProcessObject
OffsetValueType m_FrameSkipPerOutput
 
SizeValueType m_InputStencilCurrentFrameIndex
 
SizeValueType m_UnitInputNumberOfFrames
 
SizeValueType m_UnitOutputNumberOfFrames
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Private Member Functions

void operator= (const Self &) ITK_DELETE_FUNCTION
 
 VideoFileReader (const Self &) ITK_DELETE_FUNCTION
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::VideoSource< TOutputVideoStream >
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 

Member Typedef Documentation

template<typename TOutputVideoStream >
typedef DefaultConvertPixelTraits<PixelType> itk::VideoFileReader< TOutputVideoStream >::ConvertPixelTraits

Pixel conversion typedefs

Definition at line 68 of file itkVideoFileReader.h.

template<typename TOutputVideoStream >
typedef FrameType::DirectionType itk::VideoFileReader< TOutputVideoStream >::DirectionType

Definition at line 59 of file itkVideoFileReader.h.

template<typename TOutputVideoStream >
typedef VideoIOBase::FrameOffsetType itk::VideoFileReader< TOutputVideoStream >::FrameOffsetType

Definition at line 62 of file itkVideoFileReader.h.

template<typename TOutputVideoStream >
typedef VideoStreamType::FrameType itk::VideoFileReader< TOutputVideoStream >::FrameType

Definition at line 52 of file itkVideoFileReader.h.

template<typename TOutputVideoStream >
typedef FrameType::IndexType itk::VideoFileReader< TOutputVideoStream >::IndexType

Definition at line 56 of file itkVideoFileReader.h.

template<typename TOutputVideoStream >
typedef FrameType::PixelType itk::VideoFileReader< TOutputVideoStream >::PixelType

Definition at line 53 of file itkVideoFileReader.h.

template<typename TOutputVideoStream >
typedef SmartPointer<Self> itk::VideoFileReader< TOutputVideoStream >::Pointer

Definition at line 48 of file itkVideoFileReader.h.

template<typename TOutputVideoStream >
typedef FrameType::PointType itk::VideoFileReader< TOutputVideoStream >::PointType

Definition at line 57 of file itkVideoFileReader.h.

template<typename TOutputVideoStream >
typedef FrameType::RegionType itk::VideoFileReader< TOutputVideoStream >::RegionType

Definition at line 54 of file itkVideoFileReader.h.

template<typename TOutputVideoStream >
typedef VideoFileReader itk::VideoFileReader< TOutputVideoStream >::Self

-TYPEDEFS------------------------------------------------------------—

Definition at line 46 of file itkVideoFileReader.h.

template<typename TOutputVideoStream >
typedef FrameType::SizeType itk::VideoFileReader< TOutputVideoStream >::SizeType

Definition at line 55 of file itkVideoFileReader.h.

template<typename TOutputVideoStream >
typedef FrameType::SpacingType itk::VideoFileReader< TOutputVideoStream >::SpacingType

Definition at line 58 of file itkVideoFileReader.h.

template<typename TOutputVideoStream >
typedef VideoSource< TOutputVideoStream > itk::VideoFileReader< TOutputVideoStream >::Superclass

Definition at line 47 of file itkVideoFileReader.h.

template<typename TOutputVideoStream >
typedef VideoIOBase::TemporalOffsetType itk::VideoFileReader< TOutputVideoStream >::TemporalOffsetType

Definition at line 61 of file itkVideoFileReader.h.

template<typename TOutputVideoStream >
typedef VideoIOBase::TemporalRatioType itk::VideoFileReader< TOutputVideoStream >::TemporalRatioType

Definition at line 63 of file itkVideoFileReader.h.

template<typename TOutputVideoStream >
typedef VideoStreamType::Pointer itk::VideoFileReader< TOutputVideoStream >::VideoStreamPointer

Definition at line 50 of file itkVideoFileReader.h.

template<typename TOutputVideoStream >
typedef TOutputVideoStream itk::VideoFileReader< TOutputVideoStream >::VideoStreamType

Definition at line 49 of file itkVideoFileReader.h.

Constructor & Destructor Documentation

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

-PROTECTED METHODS---------------------------------------------------—

template<typename TOutputVideoStream >
virtual itk::VideoFileReader< TOutputVideoStream >::~VideoFileReader ( )
protectedvirtual

-PROTECTED METHODS---------------------------------------------------—

template<typename TOutputVideoStream >
itk::VideoFileReader< TOutputVideoStream >::VideoFileReader ( const Self )
private

Member Function Documentation

template<typename TOutputVideoStream >
virtual::itk::LightObject::Pointer itk::VideoFileReader< TOutputVideoStream >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::VideoSource< TOutputVideoStream >.

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

Convert buffer for output

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

Get the current position as frame, ratio, or MSec

template<typename TOutputVideoStream >
TemporalOffsetType itk::VideoFileReader< TOutputVideoStream >::GetCurrentPositionMSec ( )
template<typename TOutputVideoStream >
TemporalRatioType itk::VideoFileReader< TOutputVideoStream >::GetCurrentPositionRatio ( )
template<typename TOutputVideoStream >
virtual const char* itk::VideoFileReader< TOutputVideoStream >::GetFileName ( ) const
virtual

-PUBLIC METHODS---------------------------------------------------—— Specify the file to read. This is forwarded to the IO instance.

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

Get framerate

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

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

Run-time type information (and related methods).

Reimplemented from itk::VideoSource< TOutputVideoStream >.

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

Get number of frames

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

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

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

Method for creation through the object factory.

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

-PROTECTED METHODS---------------------------------------------------—

Reimplemented from itk::VideoSource< TOutputVideoStream >.

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

-PUBLIC METHODS---------------------------------------------------—— Specify the file to read. This is forwarded to the IO instance.

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

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)

template<typename TOutputVideoStream >
virtual 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 >.

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

Set up the output information

Reimplemented from itk::TemporalProcessObject.

Member Data Documentation

template<typename TOutputVideoStream >
const unsigned int itk::VideoFileReader< TOutputVideoStream >::FrameDimension = FrameType::ImageDimension
static

Definition at line 65 of file itkVideoFileReader.h.

template<typename TOutputVideoStream >
std::string itk::VideoFileReader< TOutputVideoStream >::m_FileName
protected

-PROTECTED MEMBERS------------------------------------------------—— The file to read

Definition at line 132 of file itkVideoFileReader.h.

template<typename TOutputVideoStream >
bool itk::VideoFileReader< TOutputVideoStream >::m_IFrameSafe
protected

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

Definition at line 143 of file itkVideoFileReader.h.

template<typename TOutputVideoStream >
bool itk::VideoFileReader< TOutputVideoStream >::m_PixelConversionNeeded
protected

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

Definition at line 139 of file itkVideoFileReader.h.

template<typename TOutputVideoStream >
VideoIOBase::Pointer itk::VideoFileReader< TOutputVideoStream >::m_VideoIO
protected

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

Definition at line 136 of file itkVideoFileReader.h.


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