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< Self >	Pointer

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 Self >	ConstPointer

typedef WeakPointer< const Self >	ConstWeakPointer

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< Self >	Pointer

typedef VideoSource	Self

typedef TemporalProcessObject	Superclass

Public Types inherited from itk::TemporalProcessObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef TemporalProcessObject	Self

typedef ProcessObject	Superclass

Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer

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< Self >	Pointer

typedef ProcessObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

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 >
OutputVideoStreamType *	GetOutput ()

OutputVideoStreamType *	GetOutput (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 ThreadIdType &	GetNumberOfThreads () 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

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () 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 ()

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

	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 ()

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 (void) const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName (void) const

DataObject *	GetOutput (DataObjectPointerArraySizeType idx)

const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () 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 &)

	VideoFileReader (const Self &)

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