ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::FileListVideoIO Class Reference
Group Video » Module ITKVideoIO

#include <itkFileListVideoIO.h>

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

Definition at line 40 of file itkFileListVideoIO.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = FileListVideoIO
 
using Superclass = VideoIOBase
 
- Public Types inherited from itk::VideoIOBase
using CameraIDType = SizeValueType
 
using FrameOffsetType = SizeValueType
 
using Pointer = SmartPointer< Self >
 
using ReadFromEnum = VideoIOBaseEnums::ReadFrom
 
using Self = VideoIOBase
 
using SizeValueType = itk::SizeValueType
 
using Superclass = ImageIOBase
 
using TemporalOffsetType = double
 
using TemporalRatioType = double
 
- Public Types inherited from itk::ImageIOBase
using ArrayOfExtensionsType = std::vector< std::string >
 
using BufferSizeType = itk::OffsetValueType
 
using ConstPointer = SmartPointer< const Self >
 
using IndexValueType = itk::IndexValueType
 
using IOByteOrderEnum = itk::IOByteOrderEnum
 
using IOComponentEnum = itk::IOComponentEnum
 
using IOFileEnum = itk::IOFileEnum
 
using Pointer = SmartPointer< Self >
 
using Self = ImageIOBase
 
using SizeType = itk::intmax_t
 
using SizeValueType = itk::SizeValueType
 
using Superclass = LightProcessObject
 
- Public Types inherited from itk::LightProcessObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightProcessObject
 
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

bool CanReadCamera (CameraIDType cameraID) const override
 
bool CanReadFile (const char *) override
 
bool CanWriteFile (const char *) override
 
void FinishReadingOrWriting () override
 
std::vector< double > GetDirection (unsigned int i) const override
 
virtual std::vector< std::string > GetFileNames () const
 
virtual const ImageIOBase * GetImageIO () const
 
const char * GetNameOfClass () const override
 
double GetOrigin (unsigned int i) const override
 
double GetSpacing (unsigned int i) const override
 
void Read (void *buffer) override
 
void ReadImageInformation () override
 
bool SetNextFrameToRead (FrameOffsetType frameNumber) override
 
void SetReadFromCamera () override
 
void SetReadFromFile () override
 
void SetWriterParameters (TemporalRatioType framesPerSecond, const std::vector< SizeValueType > &dim, const char *fourCC, unsigned int nChannels, IOComponentEnum componentType) override
 
void Write (const void *buffer) override
 
void WriteImageInformation () override
 
void SetFileName (const std::string &fileList) override
 
void SetFileName (const char *fileList) override
 
TemporalOffsetType GetPositionInMSec () const override
 
TemporalOffsetType GetRatio () const override
 
FrameOffsetType GetFrameTotal () const override
 
TemporalRatioType GetFramesPerSecond () const override
 
FrameOffsetType GetCurrentFrame () const override
 
virtual FrameOffsetType GetIFrameInterval () const
 
FrameOffsetType GetLastIFrame () const override
 
- Public Member Functions inherited from itk::VideoIOBase
virtual bool CanReadCamera (CameraIDType cameraID) const =0
 
virtual void FinishReadingOrWriting ()=0
 
const char * GetNameOfClass () const override
 
ReadFromEnum GetReadFrom ()
 
virtual bool SetNextFrameToRead (FrameOffsetType frameNumber)=0
 
virtual void SetReadFromCamera ()=0
 
virtual void SetReadFromFile ()=0
 
virtual void SetWriterParameters (TemporalRatioType framesPerSecond, const std::vector< SizeValueType > &dim, const char *fourCC, unsigned int nChannels, IOComponentEnum componentType)=0
 
- Public Member Functions inherited from itk::ImageIOBase
virtual bool CanReadFile (const char *)=0
 
virtual bool CanStreamRead ()
 
virtual bool CanStreamWrite ()
 
virtual bool CanWriteFile (const char *)=0
 
virtual ImageIORegion GenerateStreamableReadRegionFromRequestedRegion (const ImageIORegion &requested) const
 
virtual unsigned int GetActualNumberOfSplitsForWriting (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
 
std::string GetByteOrderAsString (IOByteOrderEnum) const
 
virtual unsigned int GetComponentSize () const
 
virtual IOComponentEnum GetComponentType () const
 
virtual const std::type_info & GetComponentTypeInfo () const
 
virtual int GetCompressionLevel () const
 
virtual const std::string & GetCompressor () const
 
virtual std::vector< double > GetDefaultDirection (unsigned int k) const
 
virtual SizeValueType GetDimensions (unsigned int i) const
 
virtual std::vector< double > GetDirection (unsigned int i) const
 
std::string GetFileTypeAsString (IOFileEnum) const
 
SizeType GetImageSizeInBytes () const
 
SizeType GetImageSizeInComponents () const
 
SizeType GetImageSizeInPixels () const
 
virtual bool GetIsReadAsScalarPlusPalette () const
 
const char * GetNameOfClass () const override
 
virtual unsigned int GetNumberOfDimensions () const
 
virtual double GetOrigin (unsigned int i) const
 
virtual SizeType GetPixelStride () const
 
virtual double GetSpacing (unsigned int i) const
 
virtual ImageIORegion GetSplitRegionForWriting (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
 
const ArrayOfExtensionsType & GetSupportedReadExtensions () const
 
const ArrayOfExtensionsType & GetSupportedWriteExtensions () const
 
virtual void Read (void *buffer)=0
 
virtual void ReadImageInformation ()=0
 
void SetByteOrderToLittleEndian ()
 
virtual void SetComponentType (const IOComponentEnum _arg)
 
virtual void SetCompressionLevel (int _arg)
 
virtual void SetCompressor (std::string _c)
 
virtual void SetDirection (unsigned int i, const std::vector< double > &direction)
 
virtual void SetDirection (unsigned int i, const vnl_vector< double > &direction)
 
void SetFileTypeToBinary ()
 
void SetNumberOfDimensions (unsigned int)
 
virtual void SetOrigin (unsigned int i, double origin)
 
virtual void SetSpacing (unsigned int i, double spacing)
 
template<typename TPixel >
void SetTypeInfo (const TPixel *)
 
virtual bool SupportsDimension (unsigned long dim)
 
virtual void Write (const void *buffer)=0
 
virtual void WriteImageInformation ()=0
 
virtual const char * GetFileName () const
 
virtual void SetDimensions (unsigned int i, SizeValueType dim)
 
virtual void SetIORegion (ImageIORegion _arg)
 
virtual const ImageIORegion & GetIORegion () const
 
virtual void SetPixelType (const itk::CommonEnums::IOPixel _arg)
 
virtual itk::CommonEnums::IOPixel GetPixelType () const
 
virtual void SetNumberOfComponents (unsigned int _arg)
 
virtual const unsigned int & GetNumberOfComponents () const
 
virtual void SetUseCompression (bool _arg)
 
virtual bool GetUseCompression () const
 
virtual void UseCompressionOn ()
 
virtual void SetUseStreamedReading (bool _arg)
 
virtual bool GetUseStreamedReading () const
 
virtual void UseStreamedReadingOn ()
 
virtual void SetUseStreamedWriting (bool _arg)
 
virtual bool GetUseStreamedWriting () const
 
virtual void UseStreamedWritingOn ()
 
virtual void SetExpandRGBPalette (bool _arg)
 
virtual bool GetExpandRGBPalette () const
 
virtual void ExpandRGBPaletteOn ()
 
virtual void SetWritePalette (bool _arg)
 
virtual bool GetWritePalette () const
 
virtual void WritePaletteOn ()
 
virtual void SetFileType (const IOFileEnum _arg)
 
virtual IOFileEnum GetFileType () const
 
void SetFileTypeToASCII ()
 
virtual void SetByteOrder (const IOByteOrderEnum _arg)
 
virtual IOByteOrderEnum GetByteOrder () const
 
void SetByteOrderToBigEndian ()
 
template<typename TPixel >
void SetPixelTypeInfo (const TPixel *)
 
template<typename TPixel >
void SetPixelTypeInfo (const RGBPixel< TPixel > *)
 
template<typename TPixel >
void SetPixelTypeInfo (const RGBAPixel< TPixel > *)
 
template<unsigned int VLength>
void SetPixelTypeInfo (const Offset< VLength > *)
 
template<typename TPixel , unsigned int VLength>
void SetPixelTypeInfo (const Vector< TPixel, VLength > *)
 
template<typename TCoordRep , unsigned int VPointDimension>
void SetPixelTypeInfo (const Point< TCoordRep, VPointDimension > *)
 
template<typename TPixel , unsigned int VLength>
void SetPixelTypeInfo (const CovariantVector< TPixel, VLength > *)
 
template<typename TPixel , unsigned int VLength>
void SetPixelTypeInfo (const SymmetricSecondRankTensor< TPixel, VLength > *)
 
template<typename TPixel >
void SetPixelTypeInfo (const DiffusionTensor3D< TPixel > *)
 
template<typename TPixel >
void SetPixelTypeInfo (const std::complex< TPixel > *)
 
template<typename TPixel , unsigned int VLength>
void SetPixelTypeInfo (const FixedArray< TPixel, VLength > *)
 
template<typename TPixel >
void SetPixelTypeInfo (const VariableLengthVector< TPixel > *)
 
template<typename TValue >
void SetPixelTypeInfo (const Array< TValue > *)
 
template<typename TPixel , unsigned int VLength>
void SetPixelTypeInfo (const Matrix< TPixel, VLength, VLength > *)
 
template<typename TValue >
void SetPixelTypeInfo (const VariableSizeMatrix< TValue > *)
 
- Public Member Functions inherited from itk::LightProcessObject
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
const char * GetNameOfClass () const override
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void UpdateOutputData ()
 
void UpdateProgress (float amount)
 
virtual void SetProgress (float _arg)
 
virtual const float & GetProgress () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) 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
 
const char * GetNameOfClass () const override
 
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) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
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
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Member Functions

static Pointer New ()
 
static std::vector< std::string > SplitFileNames (const std::string &fileList)
 
- Static Public Member Functions inherited from itk::ImageIOBase
static std::string GetComponentTypeAsString (IOComponentEnum)
 
static IOComponentEnum GetComponentTypeFromString (const std::string &typeString)
 
static std::string GetPixelTypeAsString (IOPixelEnum)
 
static IOPixelEnum GetPixelTypeFromString (const std::string &pixelString)
 
- Static Public Member Functions inherited from itk::LightProcessObject
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 FileListVideoIO ()
 
void OpenReader ()
 
void OpenWriter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void ResetMembers ()
 
bool VerifyExtensions (const std::vector< std::string > &fileList) const
 
 ~FileListVideoIO () override
 
- Protected Member Functions inherited from itk::VideoIOBase
void PrintSelf (std::ostream &os, Indent indent) const override
 
 VideoIOBase ()
 
 ~VideoIOBase () override
 
- Protected Member Functions inherited from itk::ImageIOBase
void AddSupportedReadExtension (const char *extension)
 
void AddSupportedWriteExtension (const char *extension)
 
void ComputeStrides ()
 
virtual unsigned int GetActualNumberOfSplitsForWritingCanStreamWrite (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion) const
 
SizeType GetComponentStride () const
 
virtual const ImageRegionSplitterBase * GetImageRegionSplitter () const
 
virtual unsigned int GetPixelSize () const
 
SizeType GetRowStride () const
 
SizeType GetSliceStride () const
 
virtual ImageIORegion GetSplitRegionForWritingCanStreamWrite (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion) const
 
 ImageIOBase ()
 
virtual void InternalSetCompressor (const std::string &_compressor)
 
virtual void OpenFileForReading (std::ifstream &inputStream, const std::string &filename, bool ascii=false)
 
virtual void OpenFileForWriting (std::ofstream &outputStream, const std::string &filename, bool truncate=true, bool ascii=false)
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void ReadBufferAsASCII (std::istream &is, void *buffer, IOComponentEnum ctype, SizeType numComp)
 
bool ReadBufferAsBinary (std::istream &is, void *buffer, SizeType num)
 
virtual void Reset (const bool freeDynamic=true)
 
void Resize (const unsigned int numDimensions, const unsigned int *dimensions)
 
void SetSupportedReadExtensions (const ArrayOfExtensionsType &)
 
void SetSupportedWriteExtensions (const ArrayOfExtensionsType &)
 
virtual void WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentEnum ctype, SizeType numComp)
 
 ~ImageIOBase () override
 
virtual bool HasSupportedReadExtension (const char *fileName, bool ignoreCase=true)
 
virtual bool HasSupportedWriteExtension (const char *fileName, bool ignoreCase=true)
 
virtual void SetMaximumCompressionLevel (int)
 
virtual int GetMaximumCompressionLevel () const
 
- Protected Member Functions inherited from itk::LightProcessObject
virtual void GenerateData ()
 
 LightProcessObject ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~LightProcessObject () 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 &timeStamp)
 
 ~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 PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

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

Additional Inherited Members

- Protected Attributes inherited from itk::VideoIOBase
FrameOffsetType m_CurrentFrame {}
 
TemporalRatioType m_FramesPerSecond { 0.0 }
 
FrameOffsetType m_FrameTotal {}
 
FrameOffsetType m_IFrameInterval {}
 
FrameOffsetType m_LastIFrame {}
 
TemporalOffsetType m_PositionInMSec { 0.0 }
 
TemporalRatioType m_Ratio { 0.0 }
 
bool m_ReaderOpen { false }
 
ReadFromEnum m_ReadFrom { ReadFromEnum::ReadFromFile }
 
bool m_WriterOpen { false }
 
- Protected Attributes inherited from itk::ImageIOBase
IOByteOrderEnum m_ByteOrder { IOByteOrderEnum::OrderNotApplicable }
 
IOComponentEnum m_ComponentType { IOComponentEnum::UNKNOWNCOMPONENTTYPE }
 
int m_CompressionLevel { 30 }
 
std::string m_Compressor { "uninitialized" }
 
std::vector< SizeValueType > m_Dimensions {}
 
std::vector< std::vector< double > > m_Direction {}
 
bool m_ExpandRGBPalette {}
 
std::string m_FileName {}
 
IOFileEnum m_FileType { IOFileEnum::TypeNotApplicable }
 
bool m_Initialized {}
 
ImageIORegion m_IORegion {}
 
bool m_IsReadAsScalarPlusPalette {}
 
int m_MaximumCompressionLevel { 100 }
 
unsigned int m_NumberOfComponents {}
 
unsigned int m_NumberOfDimensions { 0 }
 
std::vector< double > m_Origin {}
 
IOPixelEnum m_PixelType { IOPixelEnum::SCALAR }
 
std::vector< double > m_Spacing {}
 
std::vector< SizeType > m_Strides {}
 
bool m_UseCompression { false }
 
bool m_UseStreamedReading {}
 
bool m_UseStreamedWriting {}
 
bool m_WritePalette {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 49 of file itkFileListVideoIO.h.

◆ Pointer

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

Definition at line 48 of file itkFileListVideoIO.h.

◆ Self

using itk::FileListVideoIO::Self = FileListVideoIO

Standard class type aliases.

Definition at line 46 of file itkFileListVideoIO.h.

◆ Superclass

using itk::FileListVideoIO::Superclass = VideoIOBase

Definition at line 47 of file itkFileListVideoIO.h.

Constructor & Destructor Documentation

◆ FileListVideoIO()

itk::FileListVideoIO::FileListVideoIO ( )
protected

◆ ~FileListVideoIO()

itk::FileListVideoIO::~FileListVideoIO ( )
overrideprotected

Member Function Documentation

◆ CanReadCamera()

bool itk::FileListVideoIO::CanReadCamera ( CameraIDType  cameraID) const
overridevirtual

Return whether or not the VideoIO can read from a camera.

Implements itk::VideoIOBase.

◆ CanReadFile()

bool itk::FileListVideoIO::CanReadFile ( const char *  )
overridevirtual

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

Implements itk::ImageIOBase.

◆ CanWriteFile()

bool itk::FileListVideoIO::CanWriteFile ( const char *  )
overridevirtual

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

Implements itk::ImageIOBase.

◆ FinishReadingOrWriting()

void itk::FileListVideoIO::FinishReadingOrWriting ( )
overridevirtual

Close the reader and writer and reset members.

Implements itk::VideoIOBase.

◆ GetCurrentFrame()

FrameOffsetType itk::FileListVideoIO::GetCurrentFrame ( ) const
inlineoverridevirtual

Accessor functions for video specific information.

Implements itk::VideoIOBase.

Definition at line 132 of file itkFileListVideoIO.h.

◆ GetDirection()

std::vector< double > itk::FileListVideoIO::GetDirection ( unsigned int  i) const
overridevirtual

Reimplemented from itk::ImageIOBase.

◆ GetFileNames()

virtual std::vector< std::string > itk::FileListVideoIO::GetFileNames ( ) const
virtual

Get the list of files to read.

◆ GetFramesPerSecond()

TemporalRatioType itk::FileListVideoIO::GetFramesPerSecond ( ) const
inlineoverridevirtual

Accessor functions for video specific information.

Implements itk::VideoIOBase.

Definition at line 127 of file itkFileListVideoIO.h.

◆ GetFrameTotal()

FrameOffsetType itk::FileListVideoIO::GetFrameTotal ( ) const
inlineoverridevirtual

Accessor functions for video specific information.

Implements itk::VideoIOBase.

Definition at line 122 of file itkFileListVideoIO.h.

◆ GetIFrameInterval()

virtual FrameOffsetType itk::FileListVideoIO::GetIFrameInterval ( ) const
virtual

Accessor functions for video specific information.

◆ GetImageIO()

virtual const ImageIOBase * itk::FileListVideoIO::GetImageIO ( ) const
virtual

Get the internal ImageIOBase object.

◆ GetLastIFrame()

FrameOffsetType itk::FileListVideoIO::GetLastIFrame ( ) const
inlineoverridevirtual

Accessor functions for video specific information.

Implements itk::VideoIOBase.

Definition at line 138 of file itkFileListVideoIO.h.

◆ GetNameOfClass()

const char * itk::FileListVideoIO::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::ImageIOBase.

◆ GetOrigin()

double itk::FileListVideoIO::GetOrigin ( unsigned int  i) const
overridevirtual

Reimplemented from itk::ImageIOBase.

◆ GetPositionInMSec()

TemporalOffsetType itk::FileListVideoIO::GetPositionInMSec ( ) const
inlineoverridevirtual

Accessor functions for video specific information.

Implements itk::VideoIOBase.

Definition at line 112 of file itkFileListVideoIO.h.

◆ GetRatio()

TemporalOffsetType itk::FileListVideoIO::GetRatio ( ) const
inlineoverridevirtual

Accessor functions for video specific information.

Implements itk::VideoIOBase.

Definition at line 117 of file itkFileListVideoIO.h.

◆ GetSpacing()

double itk::FileListVideoIO::GetSpacing ( unsigned int  i) const
overridevirtual

Override accessors to pass through to internal image reader.

Reimplemented from itk::ImageIOBase.

◆ New()

static Pointer itk::FileListVideoIO::New ( )
static

Method for creation through the object factory.

◆ OpenReader()

void itk::FileListVideoIO::OpenReader ( )
protected

Open the reader if the reader and writer are not open.

◆ OpenWriter()

void itk::FileListVideoIO::OpenWriter ( )
protected

Open the writer if the reader and reader are not open.

◆ PrintSelf()

void itk::FileListVideoIO::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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::ImageIOBase.

◆ Read()

void itk::FileListVideoIO::Read ( void *  buffer)
overridevirtual

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

◆ ReadImageInformation()

void itk::FileListVideoIO::ReadImageInformation ( )
overridevirtual

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.

◆ ResetMembers()

void itk::FileListVideoIO::ResetMembers ( )
protected

Reset member variables to empty state closed.

◆ SetFileName() [1/2]

void itk::FileListVideoIO::SetFileName ( const char *  fileList)
overridevirtual

Override SetFileName to do parsing.

Reimplemented from itk::ImageIOBase.

◆ SetFileName() [2/2]

void itk::FileListVideoIO::SetFileName ( const std::string &  fileList)
override

Override SetFileName to do parsing.

◆ SetNextFrameToRead()

bool itk::FileListVideoIO::SetNextFrameToRead ( FrameOffsetType  frameNumber)
overridevirtual

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

Implements itk::VideoIOBase.

◆ SetReadFromCamera()

void itk::FileListVideoIO::SetReadFromCamera ( )
overridevirtual

Set to reading from a camera.

Implements itk::VideoIOBase.

◆ SetReadFromFile()

void itk::FileListVideoIO::SetReadFromFile ( )
overridevirtual

Set to reading from file.

Implements itk::VideoIOBase.

◆ SetWriterParameters()

void itk::FileListVideoIO::SetWriterParameters ( TemporalRatioType  framesPerSecond,
const std::vector< SizeValueType > &  dim,
const char *  fourCC,
unsigned int  nChannels,
IOComponentEnum  componentType 
)
overridevirtual

Set Writer parameters.

Implements itk::VideoIOBase.

◆ SplitFileNames()

static std::vector< std::string > itk::FileListVideoIO::SplitFileNames ( const std::string &  fileList)
static

Split up the input file names using comma (',') as the separator character. This method is made public so that places where FileListVideoIO is used can access the individual file names. This is mostly an issue for testing.

◆ VerifyExtensions()

bool itk::FileListVideoIO::VerifyExtensions ( const std::vector< std::string > &  fileList) const
protected

Verify that all file names in the have the same extension.

◆ Write()

void itk::FileListVideoIO::Write ( const void *  buffer)
overridevirtual

Writes the data to disk from the memory buffer provided. Make sure that the IORegion has been set properly.

Implements itk::ImageIOBase.

◆ WriteImageInformation()

void itk::FileListVideoIO::WriteImageInformation ( )
overridevirtual

Writes the spacing and dimensions of the image. Assumes SetFileName has been called with a valid file name.

Implements itk::ImageIOBase.

Member Data Documentation

◆ m_FileNames

std::vector<std::string> itk::FileListVideoIO::m_FileNames {}
private

Definition at line 203 of file itkFileListVideoIO.h.

◆ m_ImageIO

ImageIOBase::Pointer itk::FileListVideoIO::m_ImageIO {}
private

Definition at line 201 of file itkFileListVideoIO.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3