ITK
4.1.0
Insight Segmentation and Registration Toolkit
|
#include <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 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 &) |
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.
typedef DefaultConvertPixelTraits<PixelType> itk::VideoFileReader< TOutputVideoStream >::ConvertPixelTraits |
Pixel conversion typedefs
Definition at line 68 of file itkVideoFileReader.h.
typedef FrameType::DirectionType itk::VideoFileReader< TOutputVideoStream >::DirectionType |
Definition at line 59 of file itkVideoFileReader.h.
typedef VideoIOBase::FrameOffsetType itk::VideoFileReader< TOutputVideoStream >::FrameOffsetType |
Definition at line 62 of file itkVideoFileReader.h.
typedef VideoStreamType::FrameType itk::VideoFileReader< TOutputVideoStream >::FrameType |
Definition at line 52 of file itkVideoFileReader.h.
typedef FrameType::IndexType itk::VideoFileReader< TOutputVideoStream >::IndexType |
Definition at line 56 of file itkVideoFileReader.h.
typedef FrameType::PixelType itk::VideoFileReader< TOutputVideoStream >::PixelType |
Definition at line 53 of file itkVideoFileReader.h.
typedef SmartPointer<Self> itk::VideoFileReader< TOutputVideoStream >::Pointer |
Reimplemented from itk::VideoSource< TOutputVideoStream >.
Definition at line 48 of file itkVideoFileReader.h.
typedef FrameType::PointType itk::VideoFileReader< TOutputVideoStream >::PointType |
Definition at line 57 of file itkVideoFileReader.h.
typedef FrameType::RegionType itk::VideoFileReader< TOutputVideoStream >::RegionType |
Definition at line 54 of file itkVideoFileReader.h.
typedef VideoFileReader itk::VideoFileReader< TOutputVideoStream >::Self |
-TYPEDEFS---------------------------------------------------------------
Reimplemented from itk::VideoSource< TOutputVideoStream >.
Definition at line 46 of file itkVideoFileReader.h.
typedef FrameType::SizeType itk::VideoFileReader< TOutputVideoStream >::SizeType |
Definition at line 55 of file itkVideoFileReader.h.
typedef FrameType::SpacingType itk::VideoFileReader< TOutputVideoStream >::SpacingType |
Definition at line 58 of file itkVideoFileReader.h.
typedef VideoSource< TOutputVideoStream > itk::VideoFileReader< TOutputVideoStream >::Superclass |
Reimplemented from itk::VideoSource< TOutputVideoStream >.
Definition at line 47 of file itkVideoFileReader.h.
typedef VideoIOBase::TemporalOffsetType itk::VideoFileReader< TOutputVideoStream >::TemporalOffsetType |
Definition at line 61 of file itkVideoFileReader.h.
typedef VideoIOBase::TemporalRatioType itk::VideoFileReader< TOutputVideoStream >::TemporalRatioType |
Definition at line 63 of file itkVideoFileReader.h.
typedef VideoStreamType::Pointer itk::VideoFileReader< TOutputVideoStream >::VideoStreamPointer |
Definition at line 50 of file itkVideoFileReader.h.
typedef TOutputVideoStream itk::VideoFileReader< TOutputVideoStream >::VideoStreamType |
Definition at line 49 of file itkVideoFileReader.h.
itk::VideoFileReader< TOutputVideoStream >::VideoFileReader | ( | ) | [protected] |
-PROTECTED METHODS------------------------------------------------------
virtual itk::VideoFileReader< TOutputVideoStream >::~VideoFileReader | ( | ) | [protected, virtual] |
-PROTECTED METHODS------------------------------------------------------
itk::VideoFileReader< TOutputVideoStream >::VideoFileReader | ( | const Self & | ) | [private] |
Flag to indicate whether to report the last frame as the last IFrame. On by default
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 >.
void itk::VideoFileReader< TOutputVideoStream >::DoConvertBuffer | ( | void * | inputData, |
FrameOffsetType | frameNumber | ||
) | [protected] |
Convert buffer for output
FrameOffsetType itk::VideoFileReader< TOutputVideoStream >::GetCurrentPositionFrame | ( | ) |
Get the current position as frame, ratio, or MSec
TemporalOffsetType itk::VideoFileReader< TOutputVideoStream >::GetCurrentPositionMSec | ( | ) |
TemporalRatioType itk::VideoFileReader< TOutputVideoStream >::GetCurrentPositionRatio | ( | ) |
virtual const char* itk::VideoFileReader< TOutputVideoStream >::GetFileName | ( | ) | const [virtual] |
-PUBLIC METHODS--------------------------------------------------------- Specify the file to read. This is forwarded to the IO instance.
TemporalRatioType itk::VideoFileReader< TOutputVideoStream >::GetFramesPerSecond | ( | ) |
Get framerate
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
virtual const char* itk::VideoFileReader< TOutputVideoStream >::GetNameOfClass | ( | ) | const [virtual] |
Run-time type information (and related methods).
Reimplemented from itk::VideoSource< TOutputVideoStream >.
FrameOffsetType itk::VideoFileReader< TOutputVideoStream >::GetNumberOfFrames | ( | ) |
Get number of frames
void itk::VideoFileReader< TOutputVideoStream >::InitializeVideoIO | ( | ) | [protected] |
Set up the VideoIO using VideoIOFactory Warning: this will overwrite any currently set VideoIO
static Pointer itk::VideoFileReader< TOutputVideoStream >::New | ( | ) | [static] |
Method for creation through the object factory.
Reimplemented from itk::VideoSource< 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 >.
void itk::VideoFileReader< TOutputVideoStream >::PrintSelf | ( | std::ostream & | os, |
Indent | indent | ||
) | const [protected, virtual] |
-PROTECTED METHODS------------------------------------------------------
Reimplemented from itk::VideoSource< 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.
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
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)
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 >.
virtual void itk::VideoFileReader< TOutputVideoStream >::UpdateOutputInformation | ( | ) | [virtual] |
Set up the output information
Reimplemented from itk::TemporalProcessObject.
const unsigned int itk::VideoFileReader< TOutputVideoStream >::FrameDimension = FrameType::ImageDimension [static] |
Definition at line 65 of file itkVideoFileReader.h.
std::string itk::VideoFileReader< TOutputVideoStream >::m_FileName [protected] |
-PROTECTED MEMBERS------------------------------------------------------ The file to read
Definition at line 132 of file itkVideoFileReader.h.
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.
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.
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.