itk::VideoIOFactory Class Reference

#include <itkVideoIOFactory.h>

Inheritance diagram for itk::VideoIOFactory:

Collaboration diagram for itk::VideoIOFactory:

Detailed Description

Create instances of VideoIO objects using an object factory.

This class will create a VideoIO instance that can read/write to/from the desired file or camera. In order for a specific VideoIO type to be considered, it must be registered with the ITK ObjectFactoryBase.

Definition at line 38 of file itkVideoIOFactory.h.

Public Types
using	ConstPointer = SmartPointer< const Self >
enum	IOModeType {   ReadFileMode,   ReadCameraMode,   WriteMode }
using	Pointer = SmartPointer< Self >
using	Self = VideoIOFactory
using	Superclass = Object
Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = Object
using	Superclass = LightObject
Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LightObject

Public Member Functions
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
LightObject::Pointer	CreateAnother () const override
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
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexceptoverride
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)
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 VideoIOBase::Pointer	CreateVideoIO (IOModeType mode, const char *arg)
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
	VideoIOFactory ()
	~VideoIOFactory () override
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const override
virtual void	SetTimeStamp (const TimeStamp &time)
	~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 ()

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Member Typedef Documentation

using itk::VideoIOFactory::ConstPointer = SmartPointer< const Self >

Definition at line 47 of file itkVideoIOFactory.h.

using itk::VideoIOFactory::Pointer = SmartPointer< Self >

Definition at line 46 of file itkVideoIOFactory.h.

using itk::VideoIOFactory::Self = VideoIOFactory

Standard class type aliases.

Definition at line 44 of file itkVideoIOFactory.h.

using itk::VideoIOFactory::Superclass = Object

Definition at line 45 of file itkVideoIOFactory.h.

Member Enumeration Documentation

enum itk::VideoIOFactory::IOModeType

Mode in which the VideoIO is intended to be used

Enumerator
ReadFileMode
ReadCameraMode
WriteMode

Definition at line 50 of file itkVideoIOFactory.h.

Constructor & Destructor Documentation

itk::VideoIOFactory::VideoIOFactory ( )

protected

itk::VideoIOFactory::~VideoIOFactory ( )

overrideprotected

Member Function Documentation

static VideoIOBase::Pointer itk::VideoIOFactory::CreateVideoIO ( IOModeType  mode, const char *  arg  )

static

Create the appropriate ImageIO depending on the particulars of the file. Note: arg can either be a path for reading/writing from/to a file or a a string containing an integer to use for a cameraID if reading from a camera

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

virtual

Runtime type information (and related methods).

Reimplemented from itk::Object.

---

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

• itkVideoIOFactory.h