ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkImageFileSeriesReader Class Reference

adds support for optionally reading image stacks. More...

#include <vtkImageFileSeriesReader.h>

Inheritance diagram for vtkImageFileSeriesReader:
Inheritance graph
[legend]
Collaboration diagram for vtkImageFileSeriesReader:
Collaboration graph
[legend]

Public Types

typedef vtkFileSeriesReader Superclass
 
- Public Types inherited from vtkFileSeriesReader
typedef vtkMetaReader Superclass
 
- Public Types inherited from vtkMetaReader
typedef vtkDataObjectAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetReadAsImageStack (bool)
 
virtual bool GetReadAsImageStack ()
 
virtual void ReadAsImageStackOn ()
 
virtual void ReadAsImageStackOff ()
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 Overridden to directly call the internal reader after passing it the correct filenames when ReadAsImageStack is true. More...
 
- Public Member Functions inherited from vtkFileSeriesReader
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int CanReadFile (const char *filename)
 CanReadFile is forwarded to the internal reader if it supports it. More...
 
virtual void AddFileName (const char *fname)
 Adds names of files to be read. More...
 
virtual void RemoveAllFileNames ()
 Remove all file names. More...
 
virtual unsigned int GetNumberOfFileNames ()
 Returns the number of file names added by AddFileName. More...
 
virtual const char * GetFileName (unsigned int idx)
 Returns the name of a file with index idx. More...
 
const char * GetCurrentFileName ()
 
virtual int GetUseMetaFile ()
 If true, then use the meta file. More...
 
virtual void SetUseMetaFile (int)
 If true, then use the meta file. More...
 
virtual void UseMetaFileOn ()
 If true, then use the meta file. More...
 
virtual void UseMetaFileOff ()
 If true, then use the meta file. More...
 
virtual int GetIgnoreReaderTime ()
 If true, then treat file series like it does not contain any time step values. More...
 
virtual void SetIgnoreReaderTime (int)
 If true, then treat file series like it does not contain any time step values. More...
 
virtual void IgnoreReaderTimeOn ()
 If true, then treat file series like it does not contain any time step values. More...
 
virtual void IgnoreReaderTimeOff ()
 If true, then treat file series like it does not contain any time step values. More...
 
- Public Member Functions inherited from vtkMetaReader
 vtkMetaReader ()
 
 ~vtkMetaReader ()
 
virtual vtkMTimeType GetMTime ()
 Return the MTime when also considering the internal reader. More...
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetReader (vtkAlgorithm *)
 Set/get the internal reader. More...
 
virtual vtkAlgorithm * GetReader ()
 Set/get the internal reader. More...
 
void SetMetaFileName (const char *name)
 Get/set the filename for the meta-file. More...
 
char * GetMetaFileName ()
 Get/set the filename for the meta-file. More...
 
virtual vtkIdType * GetFileIndexRange ()
 Returns the available range of file indexes. More...
 
virtual void GetFileIndexRange (vtkIdType &, vtkIdType &)
 Returns the available range of file indexes. More...
 
virtual void GetFileIndexRange (vtkIdType [2])
 Returns the available range of file indexes. More...
 
vtkIdType GetFileIndex ()
 Get/set the index of the file to read. More...
 
void SetFileIndex (vtkIdType i)
 Get/set the index of the file to read. More...
 
virtual void SetFileNameMethod (const char *)
 Name of the method used to set the file name of the internal reader. More...
 
virtual char * GetFileNameMethod ()
 Name of the method used to set the file name of the internal reader. More...
 

Static Public Member Functions

static vtkImageFileSeriesReaderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkImageFileSeriesReaderSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkFileSeriesReader
static vtkFileSeriesReaderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkFileSeriesReaderSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMetaReader
static vtkMetaReaderNew ()
 
static int IsTypeOf (const char *type)
 
static vtkMetaReaderSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkImageFileSeriesReader ()
 
 ~vtkImageFileSeriesReader ()
 
void UpdateFileNames ()
 
- Protected Member Functions inherited from vtkFileSeriesReader
 vtkFileSeriesReader ()
 
 ~vtkFileSeriesReader ()
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestUpdateTimeDependentInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int RequestInformationForInput (int index, vtkInformation *request=NULL, vtkInformationVector *outputVector=NULL)
 Make sure the reader's output is set to the given index and, if it changed, run RequestInformation on the reader. More...
 
virtual int ReadMetaDataFile (const char *metafilename, vtkStringArray *filesToRead, int maxFilesToRead=VTK_INT_MAX)
 Reads a metadata file and returns a list of filenames (in filesToRead). More...
 
virtual void UpdateMetaData ()
 Re-reads information from the metadata file, if necessary. More...
 
void ResetTimeRanges ()
 Resets information about TimeRanges. More...
 
void RemoveAllFileNamesInternal ()
 
void AddFileNameInternal (const char *)
 
int ChooseInput (vtkInformation *)
 
- Protected Member Functions inherited from vtkMetaReader
virtual void Set_MetaFileName (const char *)
 
virtual char * Get_MetaFileName ()
 
virtual void Set_FileIndex (vtkIdType)
 
virtual vtkIdType Get_FileIndex ()
 
void ReaderSetFileName (const char *filename)
 
int ReaderCanReadFile (const char *filename)
 
std::string FromRelativeToMetaFile (const char *metaFileName, const char *fileName)
 'metaFileName' to either a file path that is relative to the current working directory (CWD) or to an absolute file path. More...
 

Protected Attributes

bool ReadAsImageStack
 
- Protected Attributes inherited from vtkFileSeriesReader
int UseMetaFile
 True if use a meta-file, false otherwise. More...
 
int IgnoreReaderTime
 
- Protected Attributes inherited from vtkMetaReader
vtkAlgorithm * Reader
 
vtkMTimeType FileNameMTime
 
vtkMTimeType BeforeFileNameMTime
 
char * FileNameMethod
 
vtkIdType _FileIndex
 
vtkMTimeType FileIndexMTime
 
vtkIdType FileIndexRange [2]
 
char * _MetaFileName
 
vtkMTimeType MetaFileNameMTime
 
vtkTimeStamp MetaFileReadTime
 Records the time when the meta-file was read. More...
 

Detailed Description

adds support for optionally reading image stacks.

vtkImageFileSeriesReader is designed for vtkImageReader2 and subclasses. This adds API to optionally treat the file series as an image stack rather than an temporal dataset. When ReadAsImageStack is true, we simply by-pass the superclass and instead pass all filenames to the internal reader and then let it handle the pipeline requests.

Definition at line 33 of file vtkImageFileSeriesReader.h.

Member Typedef Documentation

◆ Superclass

Definition at line 37 of file vtkImageFileSeriesReader.h.

Constructor & Destructor Documentation

◆ vtkImageFileSeriesReader()

vtkImageFileSeriesReader::vtkImageFileSeriesReader ( )
protected

◆ ~vtkImageFileSeriesReader()

vtkImageFileSeriesReader::~vtkImageFileSeriesReader ( )
protected

Member Function Documentation

◆ New()

static vtkImageFileSeriesReader* vtkImageFileSeriesReader::New ( )
static

◆ GetClassName()

virtual const char* vtkImageFileSeriesReader::GetClassName ( )
virtual

Reimplemented from vtkFileSeriesReader.

◆ IsTypeOf()

static int vtkImageFileSeriesReader::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkImageFileSeriesReader::IsA ( const char *  type)
virtual

Reimplemented from vtkFileSeriesReader.

◆ SafeDownCast()

static vtkImageFileSeriesReader* vtkImageFileSeriesReader::SafeDownCast ( vtkObject *  o)
static

◆ PrintSelf()

void vtkImageFileSeriesReader::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

◆ SetReadAsImageStack()

virtual void vtkImageFileSeriesReader::SetReadAsImageStack ( bool  )
virtual

◆ GetReadAsImageStack()

virtual bool vtkImageFileSeriesReader::GetReadAsImageStack ( )
virtual

◆ ReadAsImageStackOn()

virtual void vtkImageFileSeriesReader::ReadAsImageStackOn ( )
virtual

◆ ReadAsImageStackOff()

virtual void vtkImageFileSeriesReader::ReadAsImageStackOff ( )
virtual

◆ ProcessRequest()

virtual int vtkImageFileSeriesReader::ProcessRequest ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
virtual

Overridden to directly call the internal reader after passing it the correct filenames when ReadAsImageStack is true.

Reimplemented from vtkFileSeriesReader.

◆ UpdateFileNames()

void vtkImageFileSeriesReader::UpdateFileNames ( )
protected

Member Data Documentation

◆ ReadAsImageStack

bool vtkImageFileSeriesReader::ReadAsImageStack
protected

Definition at line 56 of file vtkImageFileSeriesReader.h.


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