ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes
itk::VideoFileReader< TOutputVideoStream > Class Template Reference
Module ITKVideoIO

Reader that creates a VideoStream. More...

#include <itkVideoFileReader.h>

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

List of all members.

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 Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
FrameOffsetType GetCurrentPositionFrame ()
TemporalOffsetType GetCurrentPositionMSec ()
TemporalRatioType GetCurrentPositionRatio ()
TemporalRatioType GetFramesPerSecond ()
virtual const char * GetNameOfClass () const
FrameOffsetType GetNumberOfFrames ()
void SetVideoIO (VideoIOBase *videoIO)
virtual void UpdateOutputInformation ()
virtual void SetFileName (const char *_arg)
virtual const char * GetFileName () const
virtual void SetIFrameSafe (bool _arg)
virtual bool GetIFrameSafe ()

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int FrameDimension = FrameType::ImageDimension

Protected Member Functions

void DoConvertBuffer (void *inputData, FrameOffsetType frameNumber)
void InitializeVideoIO ()
virtual void TemporalStreamingGenerateData ()
 VideoFileReader ()
virtual ~VideoFileReader ()
void PrintSelf (std::ostream &os, Indent indent) const

Protected Attributes

std::string m_FileName
bool m_PixelConversionNeeded
VideoIOBase::Pointer m_VideoIO
bool m_IFrameSafe
 VideoFileReader (const Self &)
void operator= (const Self &)

Detailed Description

template<class 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.

Member Typedef Documentation

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

Pixel conversion typedefs

Definition at line 68 of file itkVideoFileReader.h.

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

Definition at line 59 of file itkVideoFileReader.h.

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

Definition at line 62 of file itkVideoFileReader.h.

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

Definition at line 52 of file itkVideoFileReader.h.

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

Definition at line 56 of file itkVideoFileReader.h.

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

Definition at line 53 of file itkVideoFileReader.h.

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

Reimplemented from itk::VideoSource< TOutputVideoStream >.

Definition at line 48 of file itkVideoFileReader.h.

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

Definition at line 57 of file itkVideoFileReader.h.

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

Definition at line 54 of file itkVideoFileReader.h.

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

-TYPEDEFS---------------------------------------------------------------

Reimplemented from itk::VideoSource< TOutputVideoStream >.

Definition at line 46 of file itkVideoFileReader.h.

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

Definition at line 55 of file itkVideoFileReader.h.

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

Definition at line 58 of file itkVideoFileReader.h.

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

Reimplemented from itk::VideoSource< TOutputVideoStream >.

Definition at line 47 of file itkVideoFileReader.h.

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

Definition at line 61 of file itkVideoFileReader.h.

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

Definition at line 63 of file itkVideoFileReader.h.

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

Definition at line 50 of file itkVideoFileReader.h.

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

Definition at line 49 of file itkVideoFileReader.h.

Constructor & Destructor Documentation

template<class TOutputVideoStream >
itk::VideoFileReader< TOutputVideoStream >::VideoFileReader ( ) [protected]

-PROTECTED METHODS------------------------------------------------------

template<class TOutputVideoStream >
virtual itk::VideoFileReader< TOutputVideoStream >::~VideoFileReader ( ) [protected, virtual]

-PROTECTED METHODS------------------------------------------------------

template<class TOutputVideoStream >
itk::VideoFileReader< TOutputVideoStream >::VideoFileReader ( const Self &  ) [private]

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

Member Function Documentation

template<class TOutputVideoStream >
virtual::itk::LightObject::Pointer itk::VideoFileReader< TOutputVideoStream >::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::VideoSource< TOutputVideoStream >.

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

Convert buffer for output

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

Get the current position as frame, ratio, or MSec

template<class TOutputVideoStream >
TemporalOffsetType itk::VideoFileReader< TOutputVideoStream >::GetCurrentPositionMSec ( )
template<class TOutputVideoStream >
TemporalRatioType itk::VideoFileReader< TOutputVideoStream >::GetCurrentPositionRatio ( )
template<class 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<class TOutputVideoStream >
TemporalRatioType itk::VideoFileReader< TOutputVideoStream >::GetFramesPerSecond ( )

Get framerate

template<class 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<class TOutputVideoStream >
virtual const char* itk::VideoFileReader< TOutputVideoStream >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::VideoSource< TOutputVideoStream >.

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

Get number of frames

template<class TOutputVideoStream >
void itk::VideoFileReader< TOutputVideoStream >::InitializeVideoIO ( ) [protected]

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

template<class TOutputVideoStream >
static Pointer itk::VideoFileReader< TOutputVideoStream >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::VideoSource< TOutputVideoStream >.

template<class TOutputVideoStream >
void itk::VideoFileReader< TOutputVideoStream >::operator= ( const Self &  ) [private]

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

Reimplemented from itk::VideoSource< TOutputVideoStream >.

template<class TOutputVideoStream >
void itk::VideoFileReader< TOutputVideoStream >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

-PROTECTED METHODS------------------------------------------------------

Reimplemented from itk::VideoSource< TOutputVideoStream >.

template<class 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<class 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<class 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<class TOutputVideoStream >
virtual void itk::VideoFileReader< TOutputVideoStream >::TemporalStreamingGenerateData ( ) [protected, virtual]

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<class TOutputVideoStream >
virtual void itk::VideoFileReader< TOutputVideoStream >::UpdateOutputInformation ( ) [virtual]

Set up the output information

Reimplemented from itk::TemporalProcessObject.

Member Data Documentation

template<class TOutputVideoStream >
const unsigned int itk::VideoFileReader< TOutputVideoStream >::FrameDimension = FrameType::ImageDimension [static]

Definition at line 65 of file itkVideoFileReader.h.

template<class TOutputVideoStream >
std::string itk::VideoFileReader< TOutputVideoStream >::m_FileName [protected]

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

Definition at line 132 of file itkVideoFileReader.h.

template<class 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<class 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<class 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:
Generated on Mon Dec 19 2011 01:40:19 for ITK by doxygen 1.7.4