#include <itkFileListVideoIO.h>

Inheritance diagram for itk::FileListVideoIO:

Collaboration diagram for itk::FileListVideoIO:

Detailed Description

VideoIO object for reading and writing videos as a sequence of frame files.

This VideoIO treats a sequential list of file names as the frames of a video. The frames must be specified in a comma-separated list. Also, the SplitFileNames(...) static method is made public in order to allow the splitting functionality to be accessed publicly.

Definition at line 39 of file itkFileListVideoIO.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef FileListVideoIO	Self

typedef VideoIOBase	Superclass

Public Types inherited from itk::VideoIOBase
typedef SizeValueType	CameraIDType

typedef SizeValueType	FrameOffsetType

typedef SmartPointer< Self >	Pointer

enum	ReadType { ReadFromFile, ReadFromCamera }

typedef VideoIOBase	Self

typedef ::itk::SizeValueType	SizeValueType

typedef ImageIOBase	Superclass

typedef double	TemporalOffsetType

typedef double	TemporalRatioType

Public Types inherited from itk::ImageIOBase
typedef std::vector< std::string >	ArrayOfExtensionsType

typedef ::itk::OffsetValueType	BufferSizeType

enum	ByteOrder { BigEndian, LittleEndian, OrderNotApplicable }

enum	FileType { ASCII, Binary, TypeNotApplicable }

typedef ::itk::IndexValueType	IndexValueType

enum	IOComponentType { UNKNOWNCOMPONENTTYPE, UCHAR, CHAR, USHORT, SHORT, UINT, INT, ULONG, LONG, ULONGLONG, LONGLONG, FLOAT, DOUBLE }

enum	IOPixelType { UNKNOWNPIXELTYPE, SCALAR, RGB, RGBA, OFFSET, VECTOR, POINT, COVARIANTVECTOR, SYMMETRICSECONDRANKTENSOR, DIFFUSIONTENSOR3D, COMPLEX, FIXEDARRAY, MATRIX }

typedef SmartPointer< Self >	Pointer

typedef ImageIOBase	Self

typedef ::itk::intmax_t	SizeType

typedef ::itk::SizeValueType	SizeValueType

typedef LightProcessObject	Superclass

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

typedef SmartPointer< Self >	Pointer

typedef LightProcessObject	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 bool	CanReadCamera (CameraIDType cameraID) const override

virtual bool	CanReadFile (const char *) override

virtual bool	CanWriteFile (const char *) override

virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual void	FinishReadingOrWriting () override

virtual std::vector< double >	GetDirection (unsigned int i) const override

virtual std::vector< std::string >	GetFileNames () const

virtual const ImageIOBase *	GetImageIO () const

virtual const char *	GetNameOfClass () const

virtual double	GetOrigin (unsigned int i) const override

virtual double	GetSpacing (unsigned int i) const override

virtual void	Read (void *buffer) override

virtual void	ReadImageInformation () override

virtual bool	SetNextFrameToRead (FrameOffsetType frameNumber) override

virtual void	SetReadFromCamera () override

virtual void	SetReadFromFile () override

virtual void	SetWriterParameters (TemporalRatioType framesPerSecond, const std::vector< SizeValueType > &dim, const char *fourCC, unsigned int nChannels, IOComponentType componentType) override

virtual void	Write (const void *buffer) override

virtual void	WriteImageInformation () override


virtual void	SetFileName (const std::string &fileList) override

virtual void	SetFileName (const char *fileList) override


virtual TemporalOffsetType	GetPositionInMSec () const override

virtual TemporalOffsetType	GetRatio () const override

virtual FrameOffsetType	GetFrameTotal () const override

virtual TemporalRatioType	GetFramesPerSecond () const override

virtual FrameOffsetType	GetCurrentFrame () const override

virtual FrameOffsetType	GetIFrameInterval () const

virtual FrameOffsetType	GetLastIFrame () const override

Public Member Functions inherited from itk::VideoIOBase
ReadType	GetReadType ()

Public Member Functions inherited from itk::ImageIOBase
virtual bool	CanStreamRead ()

virtual bool	CanStreamWrite ()

virtual ImageIORegion	GenerateStreamableReadRegionFromRequestedRegion (const ImageIORegion &requested) const

virtual unsigned int	GetActualNumberOfSplitsForWriting (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)

std::string	GetByteOrderAsString (ByteOrder) const

virtual unsigned int	GetComponentSize () const

virtual IOComponentType	GetComponentType () const

virtual const std::type_info &	GetComponentTypeInfo () const

virtual std::vector< double >	GetDefaultDirection (unsigned int i) const

virtual SizeValueType	GetDimensions (unsigned int i) const

std::string	GetFileTypeAsString (FileType) const

SizeType	GetImageSizeInBytes () const

SizeType	GetImageSizeInComponents () const

SizeType	GetImageSizeInPixels () const

virtual bool	GetIsReadAsScalarPlusPalette () const

virtual unsigned int	GetNumberOfDimensions () const

virtual SizeType	GetPixelStride () const

virtual ImageIORegion	GetSplitRegionForWriting (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)

const ArrayOfExtensionsType &	GetSupportedReadExtensions () const

const ArrayOfExtensionsType &	GetSupportedWriteExtensions () const

void	SetByteOrderToLittleEndian ()

virtual void	SetComponentType (const IOComponentType _arg)

virtual void	SetDirection (unsigned int i, const std::vector< double > &direction)

virtual void	SetDirection (unsigned int i, const vnl_vector< double > &direction)

void	SetFileTypeToBinary ()

void	SetNumberOfDimensions (unsigned int)

virtual void	SetOrigin (unsigned int i, double origin)

template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const SymmetricSecondRankTensor< TPixel, VLength > *)

template<typename TPixel >
void	SetPixelTypeInfo (const DiffusionTensor3D< TPixel > *)

template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const Matrix< TPixel, VLength, VLength > *)

template<typename TPixel >
void	SetPixelTypeInfo (const std::complex< TPixel > *)

template<unsigned VLength>
void	SetPixelTypeInfo (const Offset< VLength > *)

virtual void	SetSpacing (unsigned int i, double spacing)

template<typename TPixel >
void	SetTypeInfo (const TPixel *)

virtual bool	SupportsDimension (unsigned long dim)

virtual const char *	GetFileName () const

virtual void	SetDimensions (unsigned int i, SizeValueType dim)

virtual void	SetIORegion (ImageIORegion _arg)

virtual const ImageIORegion &	GetIORegion () const

virtual void	SetPixelType (const IOPixelType _arg)

virtual IOPixelType	GetPixelType () const

virtual void	SetNumberOfComponents (unsigned int _arg)

virtual const unsigned int &	GetNumberOfComponents () const

virtual void	SetUseCompression (bool _arg)

virtual bool	GetUseCompression () const

virtual void	UseCompressionOn ()

virtual void	UseCompressionOff ()

virtual void	SetUseStreamedReading (bool _arg)

virtual bool	GetUseStreamedReading () const

virtual void	UseStreamedReadingOn ()

virtual void	UseStreamedReadingOff ()

virtual void	SetUseStreamedWriting (bool _arg)

virtual bool	GetUseStreamedWriting () const

virtual void	UseStreamedWritingOn ()

virtual void	UseStreamedWritingOff ()

virtual void	SetExpandRGBPalette (bool _arg)

virtual bool	GetExpandRGBPalette () const

virtual void	ExpandRGBPaletteOn ()

virtual void	ExpandRGBPaletteOff ()

virtual void	SetFileType (const FileType _arg)

virtual FileType	GetFileType () const

void	SetFileTypeToASCII ()

virtual void	SetByteOrder (const ByteOrder _arg)

virtual ByteOrder	GetByteOrder () const

void	SetByteOrderToBigEndian ()

template<typename TPixel >
void	SetPixelTypeInfo (const TPixel *)

template<typename TPixel >
void	SetPixelTypeInfo (const RGBPixel< TPixel > *)

template<typename TPixel >
void	SetPixelTypeInfo (const RGBAPixel< TPixel > *)

template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const Vector< TPixel, VLength > *)

template<typename TPixel >
void	SetPixelTypeInfo (const VariableLengthVector< TPixel > *)

template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const CovariantVector< TPixel, VLength > *)

template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const FixedArray< TPixel, VLength > *)

Public Member Functions inherited from itk::LightProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual const bool &	GetAbortGenerateData () const

virtual void	SetAbortGenerateData (bool _arg)

virtual void	UpdateOutputData ()

void	UpdateProgress (float amount)

virtual void	SetProgress (float _arg)

virtual const float &	GetProgress () 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 std::vector< std::string >	SplitFileNames (const std::string &fileList)

Static Public Member Functions inherited from itk::ImageIOBase
static std::string	GetComponentTypeAsString (IOComponentType)

static IOComponentType	GetComponentTypeFromString (const std::string &typeString)

static std::string	GetPixelTypeAsString (IOPixelType)

static IOPixelType	GetPixelTypeFromString (const std::string &pixelString)

Static Public Member Functions inherited from itk::LightProcessObject
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 flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
	FileListVideoIO ()

void	OpenReader ()

void	OpenWriter ()

virtual void	PrintSelf (std::ostream &os, Indent indent) const override

void	ResetMembers ()

bool	VerifyExtensions (const std::vector< std::string > &fileList) const

	~FileListVideoIO () override

Protected Member Functions inherited from itk::VideoIOBase
	VideoIOBase ()

virtual	~VideoIOBase () override

Protected Member Functions inherited from itk::ImageIOBase
void	AddSupportedReadExtension (const char *extension)

void	AddSupportedWriteExtension (const char *extension)

void	ComputeStrides ()

virtual unsigned int	GetActualNumberOfSplitsForWritingCanStreamWrite (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion) const

SizeType	GetComponentStride () const

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

virtual unsigned int	GetPixelSize () const

SizeType	GetRowStride () const

SizeType	GetSliceStride () const

virtual ImageIORegion	GetSplitRegionForWritingCanStreamWrite (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion) const

	ImageIOBase ()

virtual void	OpenFileForReading (std::ifstream &inputStream, const std::string &filename, bool ascii=false)

virtual void	OpenFileForWriting (std::ofstream &outputStream, const std::string &filename, bool truncate=true, bool ascii=false)

virtual void	ReadBufferAsASCII (std::istream &os, void *buffer, IOComponentType ctype, SizeType numberOfBytesToBeRead)

bool	ReadBufferAsBinary (std::istream &os, void *buffer, SizeType numberOfBytesToBeRead)

virtual void	Reset (const bool freeDynamic=true)

void	Resize (const unsigned int numDimensions, const unsigned int *dimensions)

virtual void	WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentType ctype, SizeType numberOfBytesToWrite)

	~ImageIOBase () override

Protected Member Functions inherited from itk::LightProcessObject
virtual void	GenerateData ()

	LightProcessObject ()

	~LightProcessObject () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~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
std::vector< std::string >	m_FileNames

ImageIOBase::Pointer	m_ImageIO

Additional Inherited Members
Protected Attributes inherited from itk::VideoIOBase
FrameOffsetType	m_CurrentFrame

TemporalRatioType	m_FramesPerSecond

FrameOffsetType	m_FrameTotal

FrameOffsetType	m_IFrameInterval

FrameOffsetType	m_LastIFrame

TemporalOffsetType	m_PositionInMSec

TemporalRatioType	m_Ratio

bool	m_ReaderOpen

ReadType	m_ReadType

bool	m_WriterOpen

Protected Attributes inherited from itk::ImageIOBase
ByteOrder	m_ByteOrder

IOComponentType	m_ComponentType

std::vector< SizeValueType >	m_Dimensions

std::vector< std::vector < double > >	m_Direction

bool	m_ExpandRGBPalette

std::string	m_FileName

FileType	m_FileType

bool	m_Initialized

ImageIORegion	m_IORegion

bool	m_IsReadAsScalarPlusPalette

unsigned int	m_NumberOfComponents

unsigned int	m_NumberOfDimensions

std::vector< double >	m_Origin

IOPixelType	m_PixelType

std::vector< double >	m_Spacing

std::vector< SizeType >	m_Strides

bool	m_UseCompression

bool	m_UseStreamedReading

bool	m_UseStreamedWriting

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

typedef SmartPointer< const Self > itk::FileListVideoIO::ConstPointer

Definition at line 46 of file itkFileListVideoIO.h.

typedef SmartPointer< Self > itk::FileListVideoIO::Pointer

Definition at line 45 of file itkFileListVideoIO.h.

typedef FileListVideoIO itk::FileListVideoIO::Self

Standard class typedefs.

Definition at line 43 of file itkFileListVideoIO.h.

typedef VideoIOBase itk::FileListVideoIO::Superclass

Definition at line 44 of file itkFileListVideoIO.h.

Constructor & Destructor Documentation

itk::FileListVideoIO::FileListVideoIO ( )

protected

itk::FileListVideoIO::~FileListVideoIO ( )

overrideprotected

Member Function Documentation

virtual bool itk::FileListVideoIO::CanReadCamera ( CameraIDType cameraID ) const

overridevirtual

Return whether or not the VideoIO can read from a camera.

Implements itk::VideoIOBase.

virtual bool itk::FileListVideoIO::CanReadFile ( const char * )

overridevirtual

Determine the file type. Returns true if this ImageIO can read the file specified.

Implements itk::ImageIOBase.

virtual bool itk::FileListVideoIO::CanWriteFile ( const char * )

overridevirtual

Determine the file type. Returns true if this ImageIO can write the file specified.

Implements itk::ImageIOBase.

virtual::itk::LightObject::Pointer itk::FileListVideoIO::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::LightProcessObject.

virtual void itk::FileListVideoIO::FinishReadingOrWriting ( )

overridevirtual

Close the reader and writer and reset members.

Implements itk::VideoIOBase.

virtual FrameOffsetType itk::FileListVideoIO::GetCurrentFrame ( ) const

inlineoverridevirtual

Accessor functions for video specific information.

Implements itk::VideoIOBase.

Definition at line 113 of file itkFileListVideoIO.h.

virtual std::vector< double > itk::FileListVideoIO::GetDirection ( unsigned int i ) const

overridevirtual

Reimplemented from itk::ImageIOBase.

virtual std::vector<std::string> itk::FileListVideoIO::GetFileNames ( ) const

virtual

Get the list of files to read.

virtual TemporalRatioType itk::FileListVideoIO::GetFramesPerSecond ( ) const

inlineoverridevirtual

Accessor functions for video specific information.

Implements itk::VideoIOBase.

Definition at line 109 of file itkFileListVideoIO.h.

virtual FrameOffsetType itk::FileListVideoIO::GetFrameTotal ( ) const

inlineoverridevirtual

Accessor functions for video specific information.

Implements itk::VideoIOBase.

Definition at line 105 of file itkFileListVideoIO.h.

virtual FrameOffsetType itk::FileListVideoIO::GetIFrameInterval ( ) const

virtual

Accessor functions for video specific information.

virtual const ImageIOBase* itk::FileListVideoIO::GetImageIO ( ) const

virtual

Get the internal ImageIOBase object.

virtual FrameOffsetType itk::FileListVideoIO::GetLastIFrame ( ) const

inlineoverridevirtual

Accessor functions for video specific information.

Implements itk::VideoIOBase.

Definition at line 118 of file itkFileListVideoIO.h.

virtual const char* itk::FileListVideoIO::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::VideoIOBase.

virtual double itk::FileListVideoIO::GetOrigin ( unsigned int i ) const

overridevirtual

Reimplemented from itk::ImageIOBase.

virtual TemporalOffsetType itk::FileListVideoIO::GetPositionInMSec ( ) const

inlineoverridevirtual

Accessor functions for video specific information.

Implements itk::VideoIOBase.

Definition at line 97 of file itkFileListVideoIO.h.

virtual TemporalOffsetType itk::FileListVideoIO::GetRatio ( ) const

inlineoverridevirtual

Accessor functions for video specific information.

Implements itk::VideoIOBase.

Definition at line 101 of file itkFileListVideoIO.h.

virtual double itk::FileListVideoIO::GetSpacing ( unsigned int i ) const

overridevirtual

Override accessors to pass through to internal image reader.

Reimplemented from itk::ImageIOBase.

static Pointer itk::FileListVideoIO::New ( )

static

Method for creation through the object factory.

void itk::FileListVideoIO::OpenReader ( )

protected

Open the reader if the reader and writer are not open.

void itk::FileListVideoIO::OpenWriter ( )

protected

Open the writer if the reader and reader are not open.

virtual void itk::FileListVideoIO::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::VideoIOBase.

virtual void itk::FileListVideoIO::Read ( void * buffer )

overridevirtual

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

virtual void itk::FileListVideoIO::ReadImageInformation ( )

overridevirtual

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.

void itk::FileListVideoIO::ResetMembers ( )

protected

Reset member variables to empty state closed.

virtual void itk::FileListVideoIO::SetFileName ( const std::string & fileList )

overridevirtual

Override SetFileName to do parsing.

virtual void itk::FileListVideoIO::SetFileName ( const char * fileList )

overridevirtual

Override SetFileName to do parsing.

Reimplemented from itk::ImageIOBase.

virtual bool itk::FileListVideoIO::SetNextFrameToRead ( FrameOffsetType frameNumber )

overridevirtual

Set the next frame that should be read. Return true if you operation successful.

Implements itk::VideoIOBase.

virtual void itk::FileListVideoIO::SetReadFromCamera ( )

overridevirtual

Set to reading from a camera.

Implements itk::VideoIOBase.

virtual void itk::FileListVideoIO::SetReadFromFile ( )

overridevirtual

Set to reading from file.

Implements itk::VideoIOBase.

virtual void itk::FileListVideoIO::SetWriterParameters	(	TemporalRatioType	framesPerSecond,
		const std::vector< SizeValueType > &	dim,
		const char *	fourCC,
		unsigned int	nChannels,
		IOComponentType	componentType
	)

overridevirtual

Set Writer parameters.

Implements itk::VideoIOBase.

static std::vector<std::string> itk::FileListVideoIO::SplitFileNames ( const std::string & fileList )

static

Split up the input file names using comma (',') as the separator character. This method is made public so that places where FileListVideoIO is used can access the individual file names. This is mostly an issue for testing.

bool itk::FileListVideoIO::VerifyExtensions ( const std::vector< std::string > & fileList ) const

protected

Verify that all file names in the have the same extension.

virtual void itk::FileListVideoIO::Write ( const void * buffer )

overridevirtual

Writes the data to disk from the memory buffer provided. Make sure that the IORegion has been set properly.

Implements itk::ImageIOBase.

virtual void itk::FileListVideoIO::WriteImageInformation ( )

overridevirtual

Writes the spacing and dimensions of the image. Assumes SetFileName has been called with a valid file name.

Implements itk::ImageIOBase.

Member Data Documentation

std::vector<std::string> itk::FileListVideoIO::m_FileNames

private

Definition at line 173 of file itkFileListVideoIO.h.

ImageIOBase::Pointer itk::FileListVideoIO::m_ImageIO

private

Definition at line 169 of file itkFileListVideoIO.h.

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

itkFileListVideoIO.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation