ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | List of all members
itk::FileListVideoIO Class Reference

#include <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 ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = ImageIOBase
 
using Superclass = LightProcessObject
 
using IndexValueType = ::itk::IndexValueType
 
using SizeValueType = ::itk::SizeValueType
 
using IOComponentEnum = itk::IOComponentEnum
 
using IOFileEnum = itk::IOFileEnum
 
using IOByteOrderEnum = itk::IOByteOrderEnum
 
using SizeType = ::itk::intmax_t
 
using BufferSizeType = ::itk::OffsetValueType
 
using ArrayOfExtensionsType = std::vector< std::string >
 
- 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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual std::vector< std::string > GetFileNames () const
 
virtual const ImageIOBaseGetImageIO () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::VideoIOBase
ReadFromEnum GetReadFrom ()
 
- Public Member Functions inherited from itk::ImageIOBase
virtual const char * GetFileName () const
 
void SetNumberOfDimensions (unsigned int)
 
virtual unsigned int GetNumberOfDimensions () const
 
virtual void SetDimensions (unsigned int i, SizeValueType dim)
 
virtual SizeValueType GetDimensions (unsigned int i) const
 
virtual void SetOrigin (unsigned int i, double origin)
 
virtual void SetSpacing (unsigned int i, double spacing)
 
virtual void SetDirection (unsigned int i, const std::vector< double > &direction)
 
virtual void SetDirection (unsigned int i, const vnl_vector< double > &direction)
 
virtual std::vector< double > GetDefaultDirection (unsigned int i) const
 
virtual void SetIORegion (ImageIORegion _arg)
 
virtual const ImageIORegionGetIORegion () const
 
virtual void SetPixelType (const ::itk::CommonEnums::IOPixel _arg)
 
virtual ::itk::CommonEnums::IOPixel GetPixelType () const
 
virtual void SetComponentType (const IOComponentEnum _arg)
 
virtual IOComponentEnum GetComponentType () const
 
virtual const std::type_info & GetComponentTypeInfo () 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 UseCompressionOff ()
 
virtual void SetCompressionLevel (int _arg)
 
virtual int GetCompressionLevel () const
 
virtual void SetCompressor (std::string _c)
 
virtual const std::string & GetCompressor () const
 
virtual void SetUseStreamedReading (bool _arg)
 
virtual bool GetUseStreamedReading () const
 
virtual void UseStreamedReadingOn ()
 
virtual void UseStreamedReadingOff ()
 
virtual void SetUseStreamedWriting (bool _arg)
 
virtual bool GetUseStreamedWriting () const
 
virtual void UseStreamedWritingOn ()
 
virtual void UseStreamedWritingOff ()
 
virtual void SetExpandRGBPalette (bool _arg)
 
virtual bool GetExpandRGBPalette () const
 
virtual void ExpandRGBPaletteOn ()
 
virtual void ExpandRGBPaletteOff ()
 
virtual void SetWritePalette (bool _arg)
 
virtual bool GetWritePalette () const
 
virtual void WritePaletteOn ()
 
virtual void WritePaletteOff ()
 
virtual bool GetIsReadAsScalarPlusPalette () const
 
virtual void SetFileType (const IOFileEnum _arg)
 
virtual IOFileEnum GetFileType () const
 
void SetFileTypeToASCII ()
 
void SetFileTypeToBinary ()
 
virtual void SetByteOrder (const IOByteOrderEnum _arg)
 
virtual IOByteOrderEnum GetByteOrder () const
 
void SetByteOrderToBigEndian ()
 
void SetByteOrderToLittleEndian ()
 
std::string GetFileTypeAsString (IOFileEnum) const
 
std::string GetByteOrderAsString (IOByteOrderEnum) const
 
virtual SizeType GetPixelStride () const
 
SizeType GetImageSizeInPixels () const
 
SizeType GetImageSizeInBytes () const
 
SizeType GetImageSizeInComponents () const
 
virtual unsigned int GetComponentSize () const
 
virtual bool CanStreamRead ()
 
virtual bool CanStreamWrite ()
 
virtual bool SupportsDimension (unsigned long dim)
 
virtual ImageIORegion GenerateStreamableReadRegionFromRequestedRegion (const ImageIORegion &requested) const
 
virtual unsigned int GetActualNumberOfSplitsForWriting (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
 
virtual ImageIORegion GetSplitRegionForWriting (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
 
const ArrayOfExtensionsTypeGetSupportedReadExtensions () const
 
const ArrayOfExtensionsTypeGetSupportedWriteExtensions () const
 
template<typename TPixel >
void SetTypeInfo (const TPixel *)
 
template<typename TPixel >
void SetPixelTypeInfo (const TPixel *)
 
template<typename TPixel >
void SetPixelTypeInfo (const RGBPixel< TPixel > *)
 
template<typename TPixel >
void SetPixelTypeInfo (const RGBAPixel< TPixel > *)
 
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const Vector< TPixel, VLength > *)
 
template<typename TPixel >
void SetPixelTypeInfo (const VariableLengthVector< TPixel > *)
 
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const CovariantVector< TPixel, VLength > *)
 
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const FixedArray< TPixel, VLength > *)
 
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const SymmetricSecondRankTensor< TPixel, VLength > *)
 
template<typename TPixel >
void SetPixelTypeInfo (const DiffusionTensor3D< TPixel > *)
 
template<typename TPixel , unsigned VLength>
void SetPixelTypeInfo (const Matrix< TPixel, VLength, VLength > *)
 
template<typename TPixel >
void SetPixelTypeInfo (const std::complex< TPixel > *)
 
template<unsigned VLength>
void SetPixelTypeInfo (const Offset< VLength > *)
 
- Public Member Functions inherited from itk::LightProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetProgress (float _arg)
 
virtual const float & GetProgress () const
 
void UpdateProgress (float amount)
 
virtual void UpdateOutputData ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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 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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- 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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
ImageIOBase::Pointer m_ImageIO
 
std::vector< std::string > m_FileNames
 
static std::vector< std::string > SplitFileNames (const std::string &fileList)
 
void SetFileName (const std::string &fileList) override
 
void SetFileName (const char *fileList) override
 
void FinishReadingOrWriting () override
 
void SetReadFromFile () override
 
void SetReadFromCamera () override
 
bool CanReadFile (const char *) override
 
bool CanReadCamera (CameraIDType cameraID) const override
 
void ReadImageInformation () override
 
void Read (void *buffer) override
 
bool SetNextFrameToRead (FrameOffsetType frameNumber) 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
 
double GetSpacing (unsigned int i) const override
 
double GetOrigin (unsigned int i) const override
 
std::vector< double > GetDirection (unsigned int i) const override
 
bool CanWriteFile (const char *) override
 
void WriteImageInformation () override
 
void Write (const void *buffer) override
 
void SetWriterParameters (TemporalRatioType framesPerSecond, const std::vector< SizeValueType > &dim, const char *fourCC, unsigned int nChannels, IOComponentEnum componentType) override
 
 FileListVideoIO ()
 
 ~FileListVideoIO () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void ResetMembers ()
 
void OpenReader ()
 
void OpenWriter ()
 
bool VerifyExtensions (const std::vector< std::string > &fileList) const
 

Additional Inherited Members

- Protected Member Functions inherited from itk::VideoIOBase
 VideoIOBase ()
 
 ~VideoIOBase () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::ImageIOBase
 ImageIOBase ()
 
 ~ImageIOBase () override
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
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
 
virtual void InternalSetCompressor (const std::string &COMPRESSOR)
 
virtual void Reset (const bool freeDynamic=true)
 
void Resize (const unsigned int numDimensions, const unsigned int *dimensions)
 
virtual unsigned int GetPixelSize () const
 
void ComputeStrides ()
 
SizeType GetComponentStride () const
 
SizeType GetRowStride () const
 
SizeType GetSliceStride () const
 
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)
 
virtual void WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentEnum ctype, SizeType numberOfBytesToWrite)
 
virtual void ReadBufferAsASCII (std::istream &os, void *buffer, IOComponentEnum ctype, SizeType numberOfBytesToBeRead)
 
bool ReadBufferAsBinary (std::istream &os, void *buffer, SizeType numberOfBytesToBeRead)
 
void AddSupportedReadExtension (const char *extension)
 
void AddSupportedWriteExtension (const char *extension)
 
void SetSupportedReadExtensions (const ArrayOfExtensionsType &)
 
void SetSupportedWriteExtensions (const ArrayOfExtensionsType &)
 
virtual unsigned int GetActualNumberOfSplitsForWritingCanStreamWrite (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion) const
 
virtual ImageIORegion GetSplitRegionForWritingCanStreamWrite (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion) const
 
- Protected Member Functions inherited from itk::LightProcessObject
 LightProcessObject ()
 
 ~LightProcessObject () override
 
virtual void GenerateData ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Protected Attributes inherited from itk::VideoIOBase
ReadFromEnum m_ReadFrom { ReadFromEnum::ReadFromFile }
 
TemporalRatioType m_FramesPerSecond { 0.0 }
 
FrameOffsetType m_FrameTotal
 
FrameOffsetType m_CurrentFrame
 
FrameOffsetType m_IFrameInterval
 
FrameOffsetType m_LastIFrame
 
TemporalRatioType m_Ratio { 0.0 }
 
TemporalOffsetType m_PositionInMSec { 0.0 }
 
bool m_WriterOpen { false }
 
bool m_ReaderOpen { false }
 
- Protected Attributes inherited from itk::ImageIOBase
IOPixelEnum m_PixelType { IOPixelEnum::SCALAR }
 
IOComponentEnum m_ComponentType { IOComponentEnum::UNKNOWNCOMPONENTTYPE }
 
IOByteOrderEnum m_ByteOrder { IOByteOrderEnum::OrderNotApplicable }
 
IOFileEnum m_FileType { IOFileEnum::TypeNotApplicable }
 
bool m_Initialized
 
std::string m_FileName
 
unsigned int m_NumberOfComponents
 
unsigned int m_NumberOfDimensions { 0 }
 
bool m_UseCompression { false }
 
int m_CompressionLevel { 30 }
 
int m_MaximumCompressionLevel { 100 }
 
std::string m_Compressor { "uninitialized" }
 
bool m_UseStreamedReading
 
bool m_UseStreamedWriting
 
bool m_ExpandRGBPalette
 
bool m_IsReadAsScalarPlusPalette
 
bool m_WritePalette
 
ImageIORegion m_IORegion
 
std::vector< SizeValueTypem_Dimensions
 
std::vector< double > m_Spacing
 
std::vector< double > m_Origin
 
std::vector< std::vector< double > > m_Direction
 
std::vector< SizeTypem_Strides
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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.

Member Typedef Documentation

◆ ConstPointer

Definition at line 49 of file itkFileListVideoIO.h.

◆ Pointer

Definition at line 48 of file itkFileListVideoIO.h.

◆ Self

Standard class type aliases.

Definition at line 46 of file itkFileListVideoIO.h.

◆ Superclass

Definition at line 47 of file itkFileListVideoIO.h.

Constructor & Destructor Documentation

◆ FileListVideoIO()

itk::FileListVideoIO::FileListVideoIO ( )
protected

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.

◆ ~FileListVideoIO()

itk::FileListVideoIO::~FileListVideoIO ( )
overrideprotected

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.

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.

◆ CreateAnother()

virtual::itk::LightObject::Pointer itk::FileListVideoIO::CreateAnother ( ) 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::LightProcessObject.

◆ FinishReadingOrWriting()

void itk::FileListVideoIO::FinishReadingOrWriting ( )
overridevirtual

Close the reader and writer and reset members.

Implements itk::VideoIOBase.

◆ GetCurrentFrame()

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

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.

Implements itk::VideoIOBase.

Definition at line 132 of file itkFileListVideoIO.h.

◆ GetDirection()

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

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.

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

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.

Implements itk::VideoIOBase.

Definition at line 127 of file itkFileListVideoIO.h.

◆ GetFrameTotal()

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

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.

Implements itk::VideoIOBase.

Definition at line 122 of file itkFileListVideoIO.h.

◆ GetIFrameInterval()

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

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.

◆ GetImageIO()

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

Get the internal ImageIOBase object.

◆ GetLastIFrame()

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

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.

Implements itk::VideoIOBase.

Definition at line 138 of file itkFileListVideoIO.h.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::VideoIOBase.

◆ GetOrigin()

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

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.

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

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.

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

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.

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

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.

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

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.

Definition at line 203 of file itkFileListVideoIO.h.

◆ m_ImageIO

ImageIOBase::Pointer itk::FileListVideoIO::m_ImageIO
private

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.

Definition at line 201 of file itkFileListVideoIO.h.


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