ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::FileListVideoIO Class Reference

#include <itkFileListVideoIO.h>

+ Inheritance diagram for itk::FileListVideoIO:
+ Collaboration diagram for itk::FileListVideoIO:

List of all members.

Public Types

typedef SmartPointer< SelfPointer
typedef FileListVideoIO Self
typedef VideoIOBase Superclass

Public Member Functions

virtual bool CanReadCamera (CameraIDType cameraID) const
virtual bool CanReadFile (const char *)
virtual bool CanWriteFile (const char *)
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual void FinishReadingOrWriting ()
virtual std::vector< double > GetDirection (unsigned int i) const
virtual const char * GetNameOfClass () const
virtual double GetOrigin (unsigned int i) const
virtual double GetSpacing (unsigned int i) const
virtual void Read (void *buffer)
virtual void ReadImageInformation ()
virtual bool SetNextFrameToRead (FrameOffsetType frameNumber)
virtual void SetReadFromCamera ()
virtual void SetReadFromFile ()
virtual void SetWriterParameters (TemporalRatioType framesPerSecond, const std::vector< SizeValueType > &dim, const char *fourCC, unsigned int nChannels, IOComponentType componentType)
virtual void Write (const void *buffer)
virtual void WriteImageInformation ()
virtual TemporalOffsetType GetPositionInMSec () const
virtual TemporalRatioType GetRatio () const
virtual FrameOffsetType GetFrameTotal () const
virtual TemporalRatioType GetFramesPerSecond () const
virtual FrameOffsetType GetCurrentFrame () const
virtual FrameOffsetType GetIFrameInterval () const
virtual FrameOffsetType GetLastIFrame () const
virtual void SetFileName (const std::string &fileList)
virtual void SetFileName (const char *fileList)

Static Public Member Functions

static Pointer New ()
static std::vector< std::string > SplitFileNames (const std::string &fileList)

Protected Member Functions

 FileListVideoIO ()
void OpenReader ()
void OpenWriter ()
void PrintSelf (std::ostream &os, Indent indent) const
void ResetMembers ()
bool VerifyExtensions (const std::vector< std::string > &fileList) const
 ~FileListVideoIO ()

Private Member Functions

 FileListVideoIO (const Self &)
void operator= (const Self &)

Private Attributes

std::vector< std::string > m_FileNames
ImageIOBase::Pointer m_ImageIO

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 publically.

Definition at line 38 of file itkFileListVideoIO.h.


Member Typedef Documentation

Reimplemented from itk::VideoIOBase.

Definition at line 44 of file itkFileListVideoIO.h.

Standard class typedefs.

Reimplemented from itk::VideoIOBase.

Definition at line 42 of file itkFileListVideoIO.h.

Reimplemented from itk::VideoIOBase.

Definition at line 43 of file itkFileListVideoIO.h.


Constructor & Destructor Documentation


Member Function Documentation

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

Return whether or not the VideoIO can read from a camera

Implements itk::VideoIOBase.

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

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

Implements itk::ImageIOBase.

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

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

Implements itk::ImageIOBase.

virtual::itk::LightObject::Pointer itk::FileListVideoIO::CreateAnother ( void  ) 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.

Close the reader and writer and reset members

Implements itk::VideoIOBase.

Accessor functions for video specific information

Implements itk::VideoIOBase.

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

Reimplemented from itk::ImageIOBase.

Accessor functions for video specific information

Implements itk::VideoIOBase.

Accessor functions for video specific information

Implements itk::VideoIOBase.

Accessor functions for video specific information

Accessor functions for video specific information

Implements itk::VideoIOBase.

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 [virtual]

Reimplemented from itk::ImageIOBase.

Accessor functions for video specific information

Implements itk::VideoIOBase.

Accessor functions for video specific information

Implements itk::VideoIOBase.

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

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.

Reimplemented from itk::LightProcessObject.

void itk::FileListVideoIO::OpenReader ( ) [protected]

Open the reader iff the writer is not open

void itk::FileListVideoIO::OpenWriter ( ) [protected]

Open the writer iff the reader is not open

void itk::FileListVideoIO::operator= ( const Self ) [private]

This method causes the filter to generate its output.

Reimplemented from itk::VideoIOBase.

void itk::FileListVideoIO::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

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) [virtual]

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

virtual void itk::FileListVideoIO::ReadImageInformation ( ) [virtual]

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) [virtual]

Override SetFileName to do parsing

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

Override SetFileName to do parsing

Reimplemented from itk::ImageIOBase.

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

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

Implements itk::VideoIOBase.

virtual void itk::FileListVideoIO::SetReadFromCamera ( ) [virtual]

Set to reading from a camera

Implements itk::VideoIOBase.

virtual void itk::FileListVideoIO::SetReadFromFile ( ) [virtual]

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 
) [virtual]

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 -- This is 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) [virtual]

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 ( ) [virtual]

Writes the spacing and dimentions 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]

List of files to read

Definition at line 154 of file itkFileListVideoIO.h.

Member Variables

Definition at line 151 of file itkFileListVideoIO.h.


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