read an SLC volume file. More...

#include <vtkSLCReader.h>

Inheritance diagram for vtkSLCReader:

Collaboration diagram for vtkSLCReader:

Public Types
typedef vtkImageReader2	Superclass

Public Types inherited from vtkImageReader2
typedef vtkImageAlgorithm	Superclass

Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass

enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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

vtkSLCReader *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

int	CanReadFile (const char *fname)


virtual void	SetFileName (const char *)

virtual char *	GetFileName ()


virtual int	GetError ()


virtual const char *	GetFileExtensions ()


virtual const char *	GetDescriptiveName ()

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

virtual void	SetHeaderSize (unsigned long size)

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	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	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 ()

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))

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

vtkImageData *	GetOutput ()

vtkImageData *	GetOutput (int)

virtual void	SetOutput (vtkDataObject *d)

virtual int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector )

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)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

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)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

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

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

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

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

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

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

virtual void	SetAbortExecute (int)

virtual int	GetAbortExecute ()

virtual void	AbortExecuteOn ()

virtual void	AbortExecuteOff ()

virtual void	SetProgress (double)

virtual double	GetProgress ()

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)

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	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 ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

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

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

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
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

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	Print (ostream &os)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkSLCReader *	New ()

static int	IsTypeOf (const char *type)

static vtkSLCReader *	SafeDownCast (vtkObjectBase *o)

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

static int	IsTypeOf (const char *type)

static vtkImageReader2 *	SafeDownCast (vtkObjectBase *o)

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

static vtkImageAlgorithm *	SafeDownCast (vtkObjectBase *o)

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

static int	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 int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

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 int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkSLCReader ()

	~vtkSLCReader ()

virtual void	ExecuteDataWithInformation (vtkDataObject , vtkInformation )

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

unsigned char *	Decode8BitData (unsigned char *in_ptr, int size)

Protected Member Functions inherited from vtkImageReader2
virtual void	ExecuteInformation ()

virtual void	ComputeDataIncrements ()

	vtkImageReader2 ()

	~vtkImageReader2 ()

Protected Member Functions inherited from vtkImageAlgorithm
	vtkImageAlgorithm ()

	~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)

virtual int	FillOutputPortInformation (int port, vtkInformation *info)

virtual int	FillInputPortInformation (int port, vtkInformation *info)

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~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)

virtual vtkExecutive *	CreateDefaultExecutive ()

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	SetNumberOfInputConnections (int port, int n)

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 void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

virtual void	SetErrorCode (unsigned long)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	Error

Protected Attributes inherited from vtkImageReader2
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

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

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

read an SLC volume file.

vtkSLCReader reads an SLC file and creates a structured point dataset. The size of the volume and the data spacing is set from the SLC file header.

Examples:: vtkSLCReader (Examples)

Tests:: vtkSLCReader (Tests)

Definition at line 36 of file vtkSLCReader.h.

Member Typedef Documentation

typedef vtkImageReader2 vtkSLCReader::Superclass

Definition at line 40 of file vtkSLCReader.h.

Constructor & Destructor Documentation

vtkSLCReader::vtkSLCReader ( )

protected

vtkSLCReader::~vtkSLCReader ( )

protected

Member Function Documentation

static vtkSLCReader* vtkSLCReader::New ( )

static

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

static

virtual int vtkSLCReader::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 vtkImageReader2.

static vtkSLCReader* vtkSLCReader::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkSLCReader::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImageReader2.

vtkSLCReader* vtkSLCReader::NewInstance ( ) const

void vtkSLCReader::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 vtkImageReader2.

virtual void vtkSLCReader::SetFileName ( const char * )

virtual

Set/Get the name of the file to read.

Reimplemented from vtkImageReader2.

virtual char* vtkSLCReader::GetFileName ( )

virtual

Set/Get the name of the file to read.

Reimplemented from vtkImageReader2.

virtual int vtkSLCReader::GetError ( )

virtual

Was there an error on the last read performed?

int vtkSLCReader::CanReadFile ( const char * fname )

Is the given file an SLC file?

virtual const char* vtkSLCReader::GetFileExtensions ( )

inlinevirtual

.slc

Reimplemented from vtkImageReader2.

Definition at line 58 of file vtkSLCReader.h.

virtual const char* vtkSLCReader::GetDescriptiveName ( )

inlinevirtual

SLC

Reimplemented from vtkImageReader2.

Definition at line 66 of file vtkSLCReader.h.

virtual void vtkSLCReader::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 vtkImageReader2.

virtual int vtkSLCReader::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 vtkImageReader2.

unsigned char* vtkSLCReader::Decode8BitData	(	unsigned char *	in_ptr,
		int	size
	)

protected

Member Data Documentation

int vtkSLCReader::Error

protected

Definition at line 85 of file vtkSLCReader.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/IO/Image/vtkSLCReader.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation