vtkNIFTIImageWriter Class Reference

Write NIfTI-1 and NIfTI-2 medical image files. More...

#include <vtkNIFTIImageWriter.h>

Inheritance diagram for vtkNIFTIImageWriter:

Collaboration diagram for vtkNIFTIImageWriter:

Public Member Functions
void	PrintSelf (ostream &os, vtkIndent indent) override
	Print information about this object.
void	SetQFormMatrix (vtkMatrix4x4 *)
	Set the "qform" orientation and offset for the image data.
vtkMatrix4x4 *	GetQFormMatrix ()
void	SetSFormMatrix (vtkMatrix4x4 *)
	Set a matrix for the "sform" transformation stored in the file.
vtkMatrix4x4 *	GetSFormMatrix ()
virtual void	SetNIFTIVersion (int)
	Set the version number for the NIfTI file format to use.
virtual int	GetNIFTIVersion ()
	Set the version number for the NIfTI file format to use.
virtual void	SetDescription (const char *)
	Set a short description (max 80 chars) of how the file was produced.
virtual char *	GetDescription ()
	Set a short description (max 80 chars) of how the file was produced.
virtual int	GetTimeDimension ()
	Set the time dimension to use in the NIFTI file (or zero if none).
virtual void	SetTimeDimension (int)
	Set the time dimension to use in the NIFTI file (or zero if none).
virtual double	GetTimeSpacing ()
	Set the time dimension to use in the NIFTI file (or zero if none).
virtual void	SetTimeSpacing (double)
	Set the time dimension to use in the NIFTI file (or zero if none).
virtual void	SetRescaleSlope (double)
	Set the slope and intercept for calibrating the scalar values.
virtual double	GetRescaleSlope ()
	Set the slope and intercept for calibrating the scalar values.
virtual void	SetRescaleIntercept (double)
	Set the slope and intercept for calibrating the scalar values.
virtual double	GetRescaleIntercept ()
	Set the slope and intercept for calibrating the scalar values.
virtual bool	GetPlanarRGB ()
	Write planar RGB (separate R, G, and B planes), rather than packed RGB.
virtual void	SetPlanarRGB (bool)
	Write planar RGB (separate R, G, and B planes), rather than packed RGB.
virtual void	PlanarRGBOn ()
	Write planar RGB (separate R, G, and B planes), rather than packed RGB.
virtual void	PlanarRGBOff ()
	Write planar RGB (separate R, G, and B planes), rather than packed RGB.
virtual void	SetQFac (double)
	The QFac sets the ordering of the slices in the NIFTI file.
virtual double	GetQFac ()
	The QFac sets the ordering of the slices in the NIFTI file.
void	SetNIFTIHeader (vtkNIFTIImageHeader *hdr)
	Set the NIFTI header information to use when writing the file.
vtkNIFTIImageHeader *	GetNIFTIHeader ()
	Set the NIFTI header information to use when writing the file.
Public Member Functions inherited from vtkImageWriter
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkImageWriter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkImageData *	GetInput ()
	Set/Get the input object from the image pipeline.
virtual void	Write ()
	The main interface which triggers the writer to start.
void	DeleteFiles ()
	vtkSetFilePathMacro (FileName)
	Specify file name for the image file.
	vtkGetFilePathMacro (FileName)
	Specify file name for the image file.
	vtkSetFilePathMacro (FilePrefix)
	Specify file prefix for the image file(s).You should specify either a FileName or FilePrefix.
	vtkGetFilePathMacro (FilePrefix)
	Specify file prefix for the image file(s).You should specify either a FileName or FilePrefix.
	vtkSetFilePathMacro (FilePattern)
	The snprintf format used to build filename from FilePrefix and number.
	vtkGetFilePathMacro (FilePattern)
	The snprintf format used to build filename from FilePrefix and number.
virtual void	SetFileDimensionality (int)
	What dimension are the files to be written.
virtual int	GetFileDimensionality ()
	What dimension are the files to be written.
Public Member Functions inherited from vtkImageAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkImageAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkTypeBool	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	Process a request from the executive.
vtkImageData *	GetOutput ()
	Get the output data object for a port on this algorithm.
vtkImageData *	GetOutput (int)
	Get the output data object for a port on this algorithm.
virtual void	SetOutput (vtkDataObject *d)
	Get the output data object for a port on this algorithm.
void	SetInputData (vtkDataObject *)
	Assign a data object as input.
void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.
vtkDataObject *	GetInput (int port)
	Get a data object for one of the input port connections.
vtkDataObject *	GetInput ()
	Get a data object for one of the input port connections.
vtkImageData *	GetImageDataInput (int port)
	Get a data object for one of the input port connections.
virtual void	AddInputData (vtkDataObject *)
	Assign a data object as input.
virtual void	AddInputData (int, vtkDataObject *)
	Assign a data object as input.
Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
int	HasExecutive ()
	Check whether this algorithm has an assigned executive.
vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.
virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.
virtual vtkTypeBool	ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
vtkTypeBool	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.
virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.
vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.
vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.
int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.
int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.
void	SetProgress (double)
	SetProgress is deprecated.
void	UpdateProgress (double amount)
	Update the progress of the process object.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
	String based versions of SetInputArrayToProcess().
vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.
void	RemoveAllInputs ()
	Remove all the input data.
vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.
vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.
virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.
virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.
virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.
vtkAlgorithmOutput *	GetOutputPort ()
int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.
int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).
vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.
vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)
vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.
vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)
vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.
virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).
virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date.
virtual void	UpdateDataObject ()
	Create output object(s).
virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.
virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.
virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.
void	Register (vtkObjectBase *o) override
	Participate in garbage collection.
void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection.
virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.
virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.
virtual double	GetProgress ()
	Get the execution progress of a process object.
void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.
virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.
virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date.
virtual void	Update ()
	Bring this algorithm's outputs up-to-date.
virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports.
virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.
int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.
int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.
void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Protected Member Functions
	vtkNIFTIImageWriter ()
	~vtkNIFTIImageWriter () override
int	GenerateHeader (vtkInformation *info, bool singleFile)
	Generate the header information for the file.
int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
	The main execution method, which writes the file.
Protected Member Functions inherited from vtkImageWriter
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkImageWriter ()
	~vtkImageWriter () override
virtual void	RecursiveWrite (int dim, vtkImageData *region, vtkInformation *inInfo, ostream *file)
virtual void	RecursiveWrite (int dim, vtkImageData *cache, vtkImageData *data, vtkInformation *inInfo, ostream *file)
virtual void	WriteFile (ostream *file, vtkImageData *data, int extent[6], int wExtent[6])
virtual void	WriteFileHeader (ostream *, vtkImageData *, int[6])
virtual void	WriteFileTrailer (ostream *, vtkImageData *)
virtual void	MemoryWrite (int, vtkImageData *, int[6], vtkInformation *)
int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
	This is called in response to a REQUEST_DATA request from the executive.
Protected Member Functions inherited from vtkImageAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkImageAlgorithm ()
	~vtkImageAlgorithm () override
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
	Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
	Subclasses can reimplement this method to translate the update extent requests from each output port into update extent requests for the input connections.
virtual void	CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
	Convenience method to copy the scalar type and number of components from the input data to the output data.
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
	This is called in response to a REQUEST_DATA request from the executive.
virtual void	ExecuteDataWithInformation (vtkDataObject *output, vtkInformation *outInfo)
	This is a convenience method that is implemented in many subclasses instead of RequestData.
virtual void	CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
	Copy the other point and cell data.
virtual void	ExecuteData (vtkDataObject *output)
	This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers.
virtual void	Execute ()
	This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers.
virtual void	AllocateOutputData (vtkImageData *out, vtkInformation *outInfo, int *uExtent)
	Allocate the output data.
virtual vtkImageData *	AllocateOutputData (vtkDataObject *out, vtkInformation *outInfo)
	Allocate the output data.
int	FillOutputPortInformation (int port, vtkInformation *info) override
	These method should be reimplemented by subclasses that have more than a single input or single output.
int	FillInputPortInformation (int port, vtkInformation *info) override
	These method should be reimplemented by subclasses that have more than a single input or single output.
Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkAlgorithm ()
	~vtkAlgorithm () override
virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.
virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.
virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.
void	ReportReferences (vtkGarbageCollector *) override
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port.
virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port.
void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input.
void	AddInputDataInternal (int port, vtkDataObject *input)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature.
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature.
virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file.
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static char *	ReplaceExtension (const char *filename, const char *ext1, const char *ext2)
	Make a new filename by replacing extension "ext1" with "ext2".
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
double	QFac
	Is -1 if VTK slice order is opposite to NIFTI slice order, +1 otherwise.
char *	Description
	A description of how the file was produced.
bool	PlanarRGB
	Use planar RGB instead of the default (packed).
int	TimeDimension
	The size and spacing of the Time dimension to use in the file.
double	TimeSpacing
	The size and spacing of the Time dimension to use in the file.
double	RescaleIntercept
	Information for rescaling data to quantitative units.
double	RescaleSlope
	Information for rescaling data to quantitative units.
vtkMatrix4x4 *	QFormMatrix
	The orientation matrices for the NIFTI file.
vtkMatrix4x4 *	SFormMatrix
	The orientation matrices for the NIFTI file.
vtkNIFTIImageHeader *	NIFTIHeader
	The header information.
vtkNIFTIImageHeader *	OwnHeader
	The header information.
int	NIFTIVersion
	The header information.
Protected Attributes inherited from vtkImageWriter
int	FileDimensionality
char *	FilePrefix
char *	FilePattern
char *	FileName
int	FileNumber
int	FileLowerLeft
char *	InternalFileName
size_t	InternalFileNameSize
vtkTypeUBool	WriteToMemory
int	MinimumFileNumber
int	MaximumFileNumber
int	FilesDeleted
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers
typedef vtkImageWriter	Superclass
	Static method for construction.
static vtkNIFTIImageWriter *	New ()
	Static method for construction.
static vtkTypeBool	IsTypeOf (const char *type)
	Static method for construction.
static vtkNIFTIImageWriter *	SafeDownCast (vtkObjectBase *o)
	Static method for construction.
virtual vtkTypeBool	IsA (const char *type)
	Static method for construction.
vtkNIFTIImageWriter *	NewInstance () const
	Static method for construction.
virtual vtkObjectBase *	NewInstanceInternal () const
	Static method for construction.

Additional Inherited Members
Public Types inherited from vtkImageWriter
typedef vtkImageAlgorithm	Superclass
Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...
typedef vtkObject	Superclass
Static Public Member Functions inherited from vtkImageWriter
static vtkImageWriter *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkImageWriter *	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 ()
	Keys used to specify input port requirements.
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 ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Write NIfTI-1 and NIfTI-2 medical image files.

This class writes NIFTI files, either in .nii format or as separate .img and .hdr files. If told to write a file that ends in ".gz", then the writer will automatically compress the file with zlib. Images of type unsigned char that have 3 or 4 scalar components will automatically be written as RGB or RGBA respectively. Images of type float or double that have 2 components will automatically be written as complex values.

Thanks:

This class was contributed to VTK by the Calgary Image Processing and Analysis Centre (CIPAC).

See also

vtkNIFTIImageReader

Definition at line 42 of file vtkNIFTIImageWriter.h.

Member Typedef Documentation

Superclass

typedef vtkImageWriter vtkNIFTIImageWriter::Superclass

Static method for construction.

Definition at line 50 of file vtkNIFTIImageWriter.h.

Constructor & Destructor Documentation

vtkNIFTIImageWriter()

vtkNIFTIImageWriter::vtkNIFTIImageWriter ( )

protected

~vtkNIFTIImageWriter()

vtkNIFTIImageWriter::~vtkNIFTIImageWriter ( )

overrideprotected

Member Function Documentation

New()

static vtkNIFTIImageWriter * vtkNIFTIImageWriter::New ( )

static

Static method for construction.

IsTypeOf()

static vtkTypeBool vtkNIFTIImageWriter::IsTypeOf ( const char *  type )

static

Static method for construction.

IsA()

virtual vtkTypeBool vtkNIFTIImageWriter::IsA ( const char *  type )

virtual

Static method for construction.

Reimplemented from vtkImageWriter.

SafeDownCast()

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

static

Static method for construction.

NewInstanceInternal()

virtual vtkObjectBase * vtkNIFTIImageWriter::NewInstanceInternal ( ) const

protectedvirtual

Static method for construction.

Reimplemented from vtkImageWriter.

NewInstance()

vtkNIFTIImageWriter * vtkNIFTIImageWriter::NewInstance

(

)

const

Static method for construction.

PrintSelf()

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

overridevirtual

Print information about this object.

Reimplemented from vtkImageWriter.

SetNIFTIVersion()

virtual void vtkNIFTIImageWriter::SetNIFTIVersion ( int  )

virtual

Set the version number for the NIfTI file format to use.

This can be 1, 2, or 0 (the default). If set to zero, then it will save as NIfTI version 1 unless SetNIFTIHeader() provided header information from a NIfTI version 2 file.

GetNIFTIVersion()

virtual int vtkNIFTIImageWriter::GetNIFTIVersion ( )

virtual

Set the version number for the NIfTI file format to use.

This can be 1, 2, or 0 (the default). If set to zero, then it will save as NIfTI version 1 unless SetNIFTIHeader() provided header information from a NIfTI version 2 file.

SetDescription()

virtual void vtkNIFTIImageWriter::SetDescription ( const char *  )

virtual

Set a short description (max 80 chars) of how the file was produced.

The default description is "VTKX.Y" where X.Y is the VTK version.

GetDescription()

virtual char * vtkNIFTIImageWriter::GetDescription ( )

virtual

Set a short description (max 80 chars) of how the file was produced.

The default description is "VTKX.Y" where X.Y is the VTK version.

GetTimeDimension()

virtual int vtkNIFTIImageWriter::GetTimeDimension ( )

virtual

Set the time dimension to use in the NIFTI file (or zero if none).

The number of components of the input data must be divisible by the time dimension if the time dimension is not set to zero. The vector dimension will be set to the number of components divided by the time dimension.

SetTimeDimension()

virtual void vtkNIFTIImageWriter::SetTimeDimension ( int  )

virtual

Set the time dimension to use in the NIFTI file (or zero if none).

The number of components of the input data must be divisible by the time dimension if the time dimension is not set to zero. The vector dimension will be set to the number of components divided by the time dimension.

GetTimeSpacing()

virtual double vtkNIFTIImageWriter::GetTimeSpacing ( )

virtual

Set the time dimension to use in the NIFTI file (or zero if none).

The number of components of the input data must be divisible by the time dimension if the time dimension is not set to zero. The vector dimension will be set to the number of components divided by the time dimension.

SetTimeSpacing()

virtual void vtkNIFTIImageWriter::SetTimeSpacing ( double  )

virtual

Set the time dimension to use in the NIFTI file (or zero if none).

The number of components of the input data must be divisible by the time dimension if the time dimension is not set to zero. The vector dimension will be set to the number of components divided by the time dimension.

SetRescaleSlope()

virtual void vtkNIFTIImageWriter::SetRescaleSlope ( double  )

virtual

Set the slope and intercept for calibrating the scalar values.

Other programs that read the NIFTI file can use the equation v = u*RescaleSlope + RescaleIntercept to rescale the data to real values. If both the slope and the intercept are zero, then the SclSlope and SclIntercept in the header info provided via SetNIFTIHeader() are used instead.

GetRescaleSlope()

virtual double vtkNIFTIImageWriter::GetRescaleSlope ( )

virtual

Set the slope and intercept for calibrating the scalar values.

Other programs that read the NIFTI file can use the equation v = u*RescaleSlope + RescaleIntercept to rescale the data to real values. If both the slope and the intercept are zero, then the SclSlope and SclIntercept in the header info provided via SetNIFTIHeader() are used instead.

SetRescaleIntercept()

virtual void vtkNIFTIImageWriter::SetRescaleIntercept ( double  )

virtual

Set the slope and intercept for calibrating the scalar values.

Other programs that read the NIFTI file can use the equation v = u*RescaleSlope + RescaleIntercept to rescale the data to real values. If both the slope and the intercept are zero, then the SclSlope and SclIntercept in the header info provided via SetNIFTIHeader() are used instead.

GetRescaleIntercept()

virtual double vtkNIFTIImageWriter::GetRescaleIntercept ( )

virtual

Set the slope and intercept for calibrating the scalar values.

Other programs that read the NIFTI file can use the equation v = u*RescaleSlope + RescaleIntercept to rescale the data to real values. If both the slope and the intercept are zero, then the SclSlope and SclIntercept in the header info provided via SetNIFTIHeader() are used instead.

GetPlanarRGB()

virtual bool vtkNIFTIImageWriter::GetPlanarRGB ( )

virtual

Write planar RGB (separate R, G, and B planes), rather than packed RGB.

Use this option with extreme caution: the NIFTI standard requires RGB pixels to be packed. The Analyze format, however, was used to store both planar RGB and packed RGB depending on the software, without any indication in the header about which convention was being used.

SetPlanarRGB()

virtual void vtkNIFTIImageWriter::SetPlanarRGB ( bool  )

virtual

Write planar RGB (separate R, G, and B planes), rather than packed RGB.

Use this option with extreme caution: the NIFTI standard requires RGB pixels to be packed. The Analyze format, however, was used to store both planar RGB and packed RGB depending on the software, without any indication in the header about which convention was being used.

PlanarRGBOn()

virtual void vtkNIFTIImageWriter::PlanarRGBOn ( )

virtual

Write planar RGB (separate R, G, and B planes), rather than packed RGB.

Use this option with extreme caution: the NIFTI standard requires RGB pixels to be packed. The Analyze format, however, was used to store both planar RGB and packed RGB depending on the software, without any indication in the header about which convention was being used.

PlanarRGBOff()

virtual void vtkNIFTIImageWriter::PlanarRGBOff ( )

virtual

Write planar RGB (separate R, G, and B planes), rather than packed RGB.

Use this option with extreme caution: the NIFTI standard requires RGB pixels to be packed. The Analyze format, however, was used to store both planar RGB and packed RGB depending on the software, without any indication in the header about which convention was being used.

SetQFac()

virtual void vtkNIFTIImageWriter::SetQFac ( double  )

virtual

The QFac sets the ordering of the slices in the NIFTI file.

If QFac is -1, then the slice ordering in the file will be reversed as compared to VTK. Use with caution.

GetQFac()

virtual double vtkNIFTIImageWriter::GetQFac ( )

virtual

The QFac sets the ordering of the slices in the NIFTI file.

If QFac is -1, then the slice ordering in the file will be reversed as compared to VTK. Use with caution.

SetQFormMatrix()

void vtkNIFTIImageWriter::SetQFormMatrix

(

vtkMatrix4x4 *

)

Set the "qform" orientation and offset for the image data.

The 3x3 portion of the matrix must be orthonormal and have a positive determinant, it will be used to compute the quaternion. The last column of the matrix will be used for the offset. In the NIFTI header, the qform_code will be set to 1.

GetQFormMatrix()

vtkMatrix4x4 * vtkNIFTIImageWriter::GetQFormMatrix ( )

inline

Definition at line 137 of file vtkNIFTIImageWriter.h.

SetSFormMatrix()

void vtkNIFTIImageWriter::SetSFormMatrix

(

vtkMatrix4x4 *

)

Set a matrix for the "sform" transformation stored in the file.

Unlike the qform matrix, the sform matrix can contain scaling information. Before being stored in the NIFTI header, the first three columns of the matrix will be multiplied by the voxel spacing. In the NIFTI header, the sform_code will be set to 2.

GetSFormMatrix()

vtkMatrix4x4 * vtkNIFTIImageWriter::GetSFormMatrix ( )

inline

Definition at line 147 of file vtkNIFTIImageWriter.h.

SetNIFTIHeader()

void vtkNIFTIImageWriter::SetNIFTIHeader

(

vtkNIFTIImageHeader *

hdr

)

Set the NIFTI header information to use when writing the file.

The data dimensions and pixdim from the supplied header will be ignored. Likewise, the QForm and SForm information in the supplied header will be ignored if you have called SetQFormMatrix() or SetSFormMatrix() to provide the orientation information for the file.

GetNIFTIHeader()

vtkNIFTIImageHeader * vtkNIFTIImageWriter::GetNIFTIHeader

(

)

Set the NIFTI header information to use when writing the file.

The data dimensions and pixdim from the supplied header will be ignored. Likewise, the QForm and SForm information in the supplied header will be ignored if you have called SetQFormMatrix() or SetSFormMatrix() to provide the orientation information for the file.

GenerateHeader()

int vtkNIFTIImageWriter::GenerateHeader ( vtkInformation *  info, bool  singleFile  )

protected

Generate the header information for the file.

RequestData()

int vtkNIFTIImageWriter::RequestData ( vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector  )

overrideprotectedvirtual

The main execution method, which writes the file.

Reimplemented from vtkImageWriter.

ReplaceExtension()

static char * vtkNIFTIImageWriter::ReplaceExtension ( const char *  filename, const char *  ext1, const char *  ext2  )

staticprotected

Make a new filename by replacing extension "ext1" with "ext2".

The extensions must include a period, must be three characters long, and must be lower case. A new string is returned that must be deleted by the caller.

Member Data Documentation

TimeDimension

int vtkNIFTIImageWriter::TimeDimension

protected

The size and spacing of the Time dimension to use in the file.

Definition at line 188 of file vtkNIFTIImageWriter.h.

TimeSpacing

double vtkNIFTIImageWriter::TimeSpacing

protected

The size and spacing of the Time dimension to use in the file.

Definition at line 189 of file vtkNIFTIImageWriter.h.

RescaleIntercept

double vtkNIFTIImageWriter::RescaleIntercept

protected

Information for rescaling data to quantitative units.

Definition at line 196 of file vtkNIFTIImageWriter.h.

RescaleSlope

double vtkNIFTIImageWriter::RescaleSlope

protected

Information for rescaling data to quantitative units.

Definition at line 197 of file vtkNIFTIImageWriter.h.

QFac

double vtkNIFTIImageWriter::QFac

protected

Is -1 if VTK slice order is opposite to NIFTI slice order, +1 otherwise.

Definition at line 203 of file vtkNIFTIImageWriter.h.

QFormMatrix

vtkMatrix4x4* vtkNIFTIImageWriter::QFormMatrix

protected

The orientation matrices for the NIFTI file.

Definition at line 209 of file vtkNIFTIImageWriter.h.

SFormMatrix

vtkMatrix4x4* vtkNIFTIImageWriter::SFormMatrix

protected

The orientation matrices for the NIFTI file.

Definition at line 210 of file vtkNIFTIImageWriter.h.

Description

char* vtkNIFTIImageWriter::Description

protected

A description of how the file was produced.

Definition at line 216 of file vtkNIFTIImageWriter.h.

NIFTIHeader

vtkNIFTIImageHeader* vtkNIFTIImageWriter::NIFTIHeader

protected

The header information.

Definition at line 222 of file vtkNIFTIImageWriter.h.

OwnHeader

vtkNIFTIImageHeader* vtkNIFTIImageWriter::OwnHeader

protected

The header information.

Definition at line 223 of file vtkNIFTIImageWriter.h.

NIFTIVersion

int vtkNIFTIImageWriter::NIFTIVersion

protected

The header information.

Definition at line 224 of file vtkNIFTIImageWriter.h.

PlanarRGB

bool vtkNIFTIImageWriter::PlanarRGB

protected

Use planar RGB instead of the default (packed).

Definition at line 230 of file vtkNIFTIImageWriter.h.

---

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

• IO/Image/vtkNIFTIImageWriter.h