ITK
4.12.0
Insight Segmentation and Registration Toolkit
|
#include <itkVideoFileReader.h>
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 |
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 |
Private Attributes | |
std::string | m_FileName |
bool | m_IFrameSafe |
bool | m_PixelConversionNeeded |
VideoIOBase::Pointer | m_VideoIO |
Additional Inherited Members | |
Static Protected Member Functions inherited from itk::VideoSource< TOutputVideoStream > | |
static ITK_THREAD_RETURN_TYPE | ThreaderCallback (void *arg) |
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 |
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 |
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 |
Standard class typedefs.
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 |
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.
|
protected |
|
protectedvirtual |
|
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 >.
|
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 |
Specify the file to read. This is forwarded to the IO instance.
TemporalRatioType itk::VideoFileReader< TOutputVideoStream >::GetFramesPerSecond | ( | ) |
Get framerate
|
virtual |
Get/Set IFrameSafe. If true, the last IFrame will be reported as the last frame for the largest possible temporal region
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::VideoSource< TOutputVideoStream >.
FrameOffsetType itk::VideoFileReader< TOutputVideoStream >::GetNumberOfFrames | ( | ) |
Get number of frames
|
protected |
Set up the VideoIO using VideoIOFactory Warning: this will overwrite any currently set VideoIO
|
static |
Method for creation through the object factory.
|
overrideprotectedvirtual |
ITK print mechanism
Reimplemented from itk::VideoSource< TOutputVideoStream >.
|
virtual |
Specify the file to read. This is forwarded to the IO instance.
|
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)
|
overrideprotectedvirtual |
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 >.
|
overridevirtual |
Set up the output information
Reimplemented from itk::TemporalProcessObject.
|
static |
Definition at line 65 of file itkVideoFileReader.h.
|
private |
The file to read
Definition at line 127 of file itkVideoFileReader.h.
|
private |
Flag to indicate whether to report the last frame as the last IFrame. On by default.
Definition at line 141 of file itkVideoFileReader.h.
|
private |
Flag to store whether or not the pixel type needs to be converted.
Definition at line 137 of file itkVideoFileReader.h.
|
private |
VideoIOBase used to retrieve images. This may be changed if more hierarchy is added to support general ImageSet sources.
Definition at line 134 of file itkVideoFileReader.h.