Superclass of binary file readers. More...

#include <vtkImageReader2.h>

Inheritance diagram for vtkImageReader2:

[legend]

Collaboration diagram for vtkImageReader2:

[legend]

Public Types
typedef vtkImageAlgorithm	Superclass

Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)

vtkImageReader2 *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetFileName (const char *)

virtual char *	GetFileName ()

virtual void	SetFileNames (vtkStringArray *)

virtual vtkStringArray *	GetFileNames ()

virtual void	SetFilePrefix (const char *)

virtual char *	GetFilePrefix ()

virtual void	SetFilePattern (const char *)

virtual char *	GetFilePattern ()

virtual void	SetMemoryBuffer (void *)

virtual void *	GetMemoryBuffer ()

virtual void	SetMemoryBufferLength (vtkIdType buflen)

vtkIdType	GetMemoryBufferLength ()

virtual void	SetDataScalarType (int type)

virtual void	SetDataScalarTypeToFloat ()

virtual void	SetDataScalarTypeToDouble ()

virtual void	SetDataScalarTypeToInt ()

virtual void	SetDataScalarTypeToUnsignedInt ()

virtual void	SetDataScalarTypeToShort ()

virtual void	SetDataScalarTypeToUnsignedShort ()

virtual void	SetDataScalarTypeToChar ()

virtual void	SetDataScalarTypeToSignedChar ()

virtual void	SetDataScalarTypeToUnsignedChar ()

virtual int	GetDataScalarType ()

virtual void	SetNumberOfScalarComponents (int)

virtual int	GetNumberOfScalarComponents ()

virtual void	SetDataExtent (int, int, int, int, int, int)

virtual void	SetDataExtent (int[6])

virtual int *	GetDataExtent ()

virtual void	GetDataExtent (int &, int &, int &, int &, int &, int &)

virtual void	GetDataExtent (int[6])

virtual void	SetFileDimensionality (int)

int	GetFileDimensionality ()

virtual void	SetDataSpacing (double, double, double)

virtual void	SetDataSpacing (double[3])

virtual double *	GetDataSpacing ()

virtual void	GetDataSpacing (double &, double &, double &)

virtual void	GetDataSpacing (double[3])

virtual void	SetDataOrigin (double, double, double)

virtual void	SetDataOrigin (double[3])

virtual double *	GetDataOrigin ()

virtual void	GetDataOrigin (double &, double &, double &)

virtual void	GetDataOrigin (double[3])

unsigned long	GetHeaderSize ()

unsigned long	GetHeaderSize (unsigned long slice)

virtual void	SetHeaderSize (unsigned long size)

virtual void	SetDataByteOrderToBigEndian ()

virtual void	SetDataByteOrderToLittleEndian ()

virtual int	GetDataByteOrder ()

virtual void	SetDataByteOrder (int)

virtual const char *	GetDataByteOrderAsString ()

virtual void	SetFileNameSliceOffset (int)

virtual int	GetFileNameSliceOffset ()

virtual void	SetFileNameSliceSpacing (int)

virtual int	GetFileNameSliceSpacing ()

virtual void	SetSwapBytes (int)

virtual int	GetSwapBytes ()

virtual void	SwapBytesOn ()

virtual void	SwapBytesOff ()

ifstream *	GetFile ()

virtual unsigned long *	GetDataIncrements ()

virtual void	GetDataIncrements (unsigned long data[4])

virtual int	OpenFile ()

virtual void	SeekFile (int i, int j, int k)

virtual void	FileLowerLeftOn ()

virtual void	FileLowerLeftOff ()

virtual int	GetFileLowerLeft ()

virtual void	SetFileLowerLeft (int)

virtual void	ComputeInternalFileName (int slice)

virtual char *	GetInternalFileName ()

virtual int	CanReadFile (const char *vtkNotUsed(fname))

virtual const char *	GetFileExtensions ()

virtual const char *	GetDescriptiveName ()

Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithm *	NewInstance () const

vtkImageData *	GetOutput ()

vtkImageData *	GetOutput (int)

virtual void	SetOutput (vtkDataObject *d)

int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector ) VTK_OVERRIDE

void	SetInputData (vtkDataObject *)

void	SetInputData (int, vtkDataObject *)

vtkDataObject *	GetInput (int port)

vtkDataObject *	GetInput ()

vtkImageData *	GetImageDataInput (int port)

virtual void	AddInputData (vtkDataObject *)

virtual void	AddInputData (int, vtkDataObject *)

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	Register (vtkObjectBase *o) VTK_OVERRIDE

void	UnRegister (vtkObjectBase *o) VTK_OVERRIDE

virtual void	SetAbortExecute (int)

virtual int	GetAbortExecute ()

virtual void	AbortExecuteOn ()

virtual void	AbortExecuteOff ()

virtual void	SetProgress (double)

virtual double	GetProgress ()

void	UpdateProgress (double amount)

void	SetProgressText (const char *ptext)

virtual char *	GetProgressText ()

virtual unsigned long	GetErrorCode ()

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

vtkDataObject *	GetInputDataObject (int port, int connection)

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive (int port, int index)

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetInputInformation ()

vtkInformation *	GetOutputInformation (int port)

virtual void	Update (int port)

virtual void	Update ()

virtual int	Update (int port, vtkInformationVector *requests)

virtual int	Update (vtkInformation *requests)

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)

virtual int	UpdateExtent (const int extents[6])

virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int port, int extent[6])

void	SetUpdateExtent (int extent[6])

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	InitializeObjectBase ()

void	Print (ostream &os)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkImageReader2 *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkImageReader2 *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkImageAlgorithm
static vtkTypeBool	IsTypeOf (const char *type)

static vtkImageAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual void	ExecuteInformation ()

virtual void	ExecuteDataWithInformation (vtkDataObject data, vtkInformation outInfo)

virtual void	ComputeDataIncrements ()

Protected Member Functions inherited from vtkImageAlgorithm
virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual void	CopyInputArrayAttributesToOutput (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual void	ExecuteData (vtkDataObject *output)

virtual void	Execute ()

virtual void	AllocateOutputData (vtkImageData out, vtkInformation outInfo, int *uExtent)

virtual vtkImageData *	AllocateOutputData (vtkDataObject out, vtkInformation outInfo)

virtual void	CopyAttributeData (vtkImageData in, vtkImageData out, vtkInformationVector **inputVector)

int	FillOutputPortInformation (int port, vtkInformation *info) VTK_OVERRIDE

int	FillInputPortInformation (int port, vtkInformation *info) VTK_OVERRIDE

Protected Member Functions inherited from vtkAlgorithm
virtual void	SetNumberOfInputPorts (int n)

virtual void	SetNumberOfOutputPorts (int n)

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual vtkExecutive *	CreateDefaultExecutive ()

virtual void	SetErrorCode (unsigned long)

void	ReportReferences (vtkGarbageCollector *) VTK_OVERRIDE

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

virtual void	SetNumberOfInputConnections (int port, int n)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

Protected Member Functions inherited from vtkObject
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkStringArray *	FileNames

char *	InternalFileName

char *	FileName

char *	FilePrefix

char *	FilePattern

int	NumberOfScalarComponents

int	FileLowerLeft

void *	MemoryBuffer

vtkIdType	MemoryBufferLength

ifstream *	File

unsigned long	DataIncrements [4]

int	DataExtent [6]

int	SwapBytes

int	FileDimensionality

unsigned long	HeaderSize

int	DataScalarType

unsigned long	ManualHeaderSize

double	DataSpacing [3]

double	DataOrigin [3]

int	FileNameSliceOffset

int	FileNameSliceSpacing

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

unsigned long	ErrorCode

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Superclass of binary file readers.

vtkImageReader2 is a parent class for many VTK image readers. It was written to simplify the interface of vtkImageReader. It can also be used directly to read data without headers (raw). It is a good super class for streaming readers that do not require a mask or transform on the data. An example of reading a raw file is shown below:

 vtkSmartPointer<vtkImageReader2> reader =
  vtkSmartPointer<vtkImageReader2>::New();
reader->SetFilePrefix(argv[1]);
reader->SetDataExtent(0, 63, 0, 63, 1, 93);
reader->SetDataSpacing(3.2, 3.2, 1.5);
reader->SetDataOrigin(0.0, 0.0, 0.0);
reader->SetDataScalarTypeToUnsignedShort();
reader->SetDataByteOrderToLittleEndian();
reader->UpdateWholeExtent();

See also: vtkJPEGReader vtkPNGReader vtkImageReader vtkGESignaReader

Member Function Documentation

◆ CanReadFile()

virtual int vtkImageReader2::CanReadFile ( const char * vtkNotUsedfname )

inlinevirtual

Return non zero if the reader can read the given file name. Should be implemented by all sub-classes of vtkImageReader2. For non zero return values the following values are to be used 1 - I think I can read the file but I cannot prove it 2 - I definitely can read the file 3 - I can read the file and I have validated that I am the correct reader for this file

◆ ComputeInternalFileName()

virtual void vtkImageReader2::ComputeInternalFileName ( int slice )

virtual

Set/Get the internal file name

◆ ExecuteDataWithInformation()

virtual void vtkImageReader2::ExecuteDataWithInformation	(	vtkDataObject *	output,
		vtkInformation *	outInfo
	)

protectedvirtual

This is a convenience method that is implemented in many subclasses instead of RequestData. It is called by RequestData.

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkImageReader.

◆ FileLowerLeftOn()

virtual void vtkImageReader2::FileLowerLeftOn ( )

virtual

Set/Get whether the data comes from the file starting in the lower left corner or upper left corner.

◆ GetDataScalarType()

virtual int vtkImageReader2::GetDataScalarType ( )

virtual

Get the file format. Pixels are this type in the file.

◆ GetDescriptiveName()

virtual const char* vtkImageReader2::GetDescriptiveName ( )

inlinevirtual

Return a descriptive name for the file format that might be useful in a GUI.

Reimplemented in vtkScancoCTReader, vtkNIFTIReader, and vtkDICOMReader.

◆ GetFileExtensions()

virtual const char* vtkImageReader2::GetFileExtensions ( )

inlinevirtual

Get the file extensions for this format. Returns a string with a space separated list of extensions in the format .extension

Reimplemented in vtkScancoCTReader, vtkNIFTIReader, and vtkDICOMReader.

◆ GetHeaderSize()

unsigned long vtkImageReader2::GetHeaderSize ( )

Get the size of the header computed by this object.

◆ IsA()

virtual vtkTypeBool vtkImageReader2::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkScancoCTReader, vtkNIFTIReader, vtkImageReader, and vtkDICOMReader.

◆ PrintSelf()

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

virtual

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

Reimplemented in vtkScancoCTReader, and vtkNIFTIReader.

◆ RequestInformation()

virtual int vtkImageReader2::RequestInformation	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)

protectedvirtual

Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkScancoCTReader, vtkNIFTIReader, vtkDICOMReader, and vtkImageReader.

◆ SetDataByteOrderToBigEndian()

virtual void vtkImageReader2::SetDataByteOrderToBigEndian ( )

virtual

These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian.

◆ SetDataExtent()

virtual void vtkImageReader2::SetDataExtent	(	int	,
		int	,
		int	,
		int	,
		int	,
		int
	)

virtual

Get/Set the extent of the data on disk.

◆ SetDataOrigin()

virtual void vtkImageReader2::SetDataOrigin	(	double	,
		double	,
		double
	)

virtual

Set/Get the origin of the data (location of first pixel in the file).

◆ SetDataScalarType()

virtual void vtkImageReader2::SetDataScalarType ( int type )

virtual

Set the data type of pixels in the file. If you want the output scalar type to have a different value, set it after this method is called.

◆ SetDataSpacing()

virtual void vtkImageReader2::SetDataSpacing	(	double	,
		double	,
		double
	)

virtual

Set/Get the spacing of the data in the file.

◆ SetFileDimensionality()

virtual void vtkImageReader2::SetFileDimensionality ( int )

virtual

The number of dimensions stored in a file. This defaults to two.

◆ SetFileName()

virtual void vtkImageReader2::SetFileName ( const char * )

virtual

Specify file name for the image file. If the data is stored in multiple files, then use SetFileNames or SetFilePrefix instead.

◆ SetFileNames()

virtual void vtkImageReader2::SetFileNames ( vtkStringArray * )

virtual

Specify a list of file names. Each file must be a single slice, and each slice must be of the same size. The files must be in the correct order. Use SetFileName when reading a volume (multiple slice), since DataExtent will be modified after a SetFileNames call.

◆ SetFileNameSliceOffset()

virtual void vtkImageReader2::SetFileNameSliceOffset ( int )

virtual

When reading files which start at an unusual index, this can be added to the slice number when generating the file name (default = 0)

◆ SetFileNameSliceSpacing()

virtual void vtkImageReader2::SetFileNameSliceSpacing ( int )

virtual

When reading files which have regular, but non contiguous slices (eg filename.1,filename.3,filename.5) a spacing can be specified to skip missing files (default = 1)

◆ SetFilePattern()

virtual void vtkImageReader2::SetFilePattern ( const char * )

virtual

The sprintf-style format string used to build filename from FilePrefix and slice number.

◆ SetFilePrefix()

virtual void vtkImageReader2::SetFilePrefix ( const char * )

virtual

Specify file prefix for the image file or files. This can be used in place of SetFileName or SetFileNames if the filenames follow a specific naming pattern, but you must explicitly set the DataExtent so that the reader will know what range of slices to load.

◆ SetHeaderSize()

virtual void vtkImageReader2::SetHeaderSize ( unsigned long size )

virtual

If there is a tail on the file, you want to explicitly set the header size.

◆ SetMemoryBuffer()

virtual void vtkImageReader2::SetMemoryBuffer ( void * )

virtual

Specify the in memory image buffer. May be used by a reader to allow the reading of an image from memory instead of from file.

◆ SetMemoryBufferLength()

virtual void vtkImageReader2::SetMemoryBufferLength ( vtkIdType buflen )

virtual

Specify the in memory image buffer length.

◆ SetNumberOfScalarComponents()

virtual void vtkImageReader2::SetNumberOfScalarComponents ( int )

virtual

Set/Get the number of scalar components

◆ SetSwapBytes()

virtual void vtkImageReader2::SetSwapBytes ( int )

virtual

Set/Get the byte swapping to explicitly swap the bytes of a file.

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

vtkImageReader2.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CanReadFile()

◆ ComputeInternalFileName()

◆ ExecuteDataWithInformation()

◆ FileLowerLeftOn()

◆ GetDataScalarType()

◆ GetDescriptiveName()

◆ GetFileExtensions()

◆ GetHeaderSize()

◆ IsA()

◆ PrintSelf()

◆ RequestInformation()

◆ SetDataByteOrderToBigEndian()

◆ SetDataExtent()

◆ SetDataOrigin()

◆ SetDataScalarType()

◆ SetDataSpacing()

◆ SetFileDimensionality()

◆ SetFileName()

◆ SetFileNames()

◆ SetFileNameSliceOffset()

◆ SetFileNameSliceSpacing()

◆ SetFilePattern()

◆ SetFilePrefix()

◆ SetHeaderSize()

◆ SetMemoryBuffer()

◆ SetMemoryBufferLength()

◆ SetNumberOfScalarComponents()

◆ SetSwapBytes()