VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkNIFTIImageWriter Class Reference

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

#include <vtkNIFTIImageWriter.h>

Inheritance diagram for vtkNIFTIImageWriter:
[legend]
Collaboration diagram for vtkNIFTIImageWriter:
[legend]

Public Types

typedef vtkImageWriter Superclass
 
- 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
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkNIFTIImageWriterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Print information about this object. More...
 
virtual void SetNIFTIVersion (int)
 Set the version number for the NIfTI file format to use. More...
 
virtual int GetNIFTIVersion ()
 
virtual void SetDescription (const char *)
 Set a short description (max 80 chars) of how the file was produced. More...
 
virtual char * GetDescription ()
 
virtual int GetTimeDimension ()
 Set the time dimension to use in the NIFTI file (or zero if none). More...
 
virtual void SetTimeDimension (int)
 
virtual double GetTimeSpacing ()
 
virtual void SetTimeSpacing (double)
 
virtual void SetRescaleSlope (double)
 Set the slope and intercept for calibrating the scalar values. More...
 
virtual double GetRescaleSlope ()
 
virtual void SetRescaleIntercept (double)
 
virtual double GetRescaleIntercept ()
 
virtual bool GetPlanarRGB ()
 Write planar RGB (separate R, G, and B planes), rather than packed RGB. More...
 
virtual void SetPlanarRGB (bool)
 
virtual void PlanarRGBOn ()
 
virtual void PlanarRGBOff ()
 
virtual void SetQFac (double)
 The QFac sets the ordering of the slices in the NIFTI file. More...
 
virtual double GetQFac ()
 
void SetQFormMatrix (vtkMatrix4x4 *)
 Set the "qform" orientation and offset for the image data. More...
 
vtkMatrix4x4GetQFormMatrix ()
 
void SetSFormMatrix (vtkMatrix4x4 *)
 Set a matrix for the "sform" transformation stored in the file. More...
 
vtkMatrix4x4GetSFormMatrix ()
 
void SetNIFTIHeader (vtkNIFTIImageHeader *hdr)
 Set the NIFTI header information to use when writing the file. More...
 
vtkNIFTIImageHeaderGetNIFTIHeader ()
 
- Public Member Functions inherited from vtkImageWriter
vtkImageWriterNewInstance () const
 
virtual void SetFileName (const char *)
 Specify file name for the image file. More...
 
virtual char * GetFileName ()
 
virtual void SetFilePrefix (const char *)
 Specify file prefix for the image file(s).You should specify either a FileName or FilePrefix. More...
 
virtual char * GetFilePrefix ()
 
virtual void SetFilePattern (const char *)
 The snprintf format used to build filename from FilePrefix and number. More...
 
virtual char * GetFilePattern ()
 
virtual void SetFileDimensionality (int)
 What dimension are the files to be written. More...
 
virtual int GetFileDimensionality ()
 
vtkImageDataGetInput ()
 Set/Get the input object from the image pipeline. More...
 
virtual void Write ()
 The main interface which triggers the writer to start. More...
 
void DeleteFiles ()
 
- Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithmNewInstance () const
 
vtkImageDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkImageDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Process a request from the executive. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
vtkDataObjectGetInput (int port)
 Get a data object for one of the input port connections. More...
 
vtkDataObjectGetInput ()
 
vtkImageDataGetImageDataInput (int port)
 
virtual void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
virtual void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
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. More...
 
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. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
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)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
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). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
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. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (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 ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
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)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkNIFTIImageWriterNew ()
 Static method for construction. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkNIFTIImageWriterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageWriter
static vtkImageWriterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageWriterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImageAlgorithm
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkNIFTIImageWriter ()
 
 ~vtkNIFTIImageWriter () override
 
int GenerateHeader (vtkInformation *info, bool singleFile)
 Generate the header information for the file. More...
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 The main execution method, which writes the file. More...
 
- Protected Member Functions inherited from vtkImageWriter
 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 *)
 
- Protected Member Functions inherited from vtkImageAlgorithm
 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. More...
 
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. More...
 
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. More...
 
virtual void ExecuteDataWithInformation (vtkDataObject *output, vtkInformation *outInfo)
 This is a convenience method that is implemented in many subclasses instead of RequestData. More...
 
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. More...
 
virtual void Execute ()
 
virtual void AllocateOutputData (vtkImageData *out, vtkInformation *outInfo, int *uExtent)
 Allocate the output data. More...
 
virtual vtkImageDataAllocateOutputData (vtkDataObject *out, vtkInformation *outInfo)
 
virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
 Copy the other point and cell data. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 These method should be reimplemented by subclasses that have more than a single input or single output. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
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. More...
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (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. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- 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. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static char * ReplaceExtension (const char *fname, const char *ext1, const char *ext2)
 Make a new filename by replacing extension "ext1" with "ext2". More...
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 

Protected Attributes

int TimeDimension
 The size and spacing of the Time dimension to use in the file. More...
 
double TimeSpacing
 
double RescaleIntercept
 Information for rescaling data to quantitative units. More...
 
double RescaleSlope
 
double QFac
 Is -1 if VTK slice order is opposite to NIFTI slice order, +1 otherwise. More...
 
vtkMatrix4x4QFormMatrix
 The orientation matrices for the NIFTI file. More...
 
vtkMatrix4x4SFormMatrix
 
char * Description
 A description of how the file was produced. More...
 
vtkNIFTIImageHeaderNIFTIHeader
 The header information. More...
 
vtkNIFTIImageHeaderOwnHeader
 
int NIFTIVersion
 
bool PlanarRGB
 Use planar RGB instead of the default (packed). More...
 
- 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
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

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
Tests:
vtkNIFTIImageWriter (Tests)

Definition at line 45 of file vtkNIFTIImageWriter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 53 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

◆ IsA()

virtual vtkTypeBool vtkNIFTIImageWriter::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 vtkImageWriter.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkNIFTIImageWriter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkImageWriter.

◆ NewInstance()

vtkNIFTIImageWriter* vtkNIFTIImageWriter::NewInstance ( ) const

◆ 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

◆ 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

◆ 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

◆ GetTimeSpacing()

virtual double vtkNIFTIImageWriter::GetTimeSpacing ( )
virtual

◆ SetTimeSpacing()

virtual void vtkNIFTIImageWriter::SetTimeSpacing ( double  )
virtual

◆ 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

◆ SetRescaleIntercept()

virtual void vtkNIFTIImageWriter::SetRescaleIntercept ( double  )
virtual

◆ GetRescaleIntercept()

virtual double vtkNIFTIImageWriter::GetRescaleIntercept ( )
virtual

◆ 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

◆ PlanarRGBOn()

virtual void vtkNIFTIImageWriter::PlanarRGBOn ( )
virtual

◆ PlanarRGBOff()

virtual void vtkNIFTIImageWriter::PlanarRGBOff ( )
virtual

◆ 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

◆ 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 140 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 150 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 ( )

◆ 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 *  fname,
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 193 of file vtkNIFTIImageWriter.h.

◆ TimeSpacing

double vtkNIFTIImageWriter::TimeSpacing
protected

Definition at line 194 of file vtkNIFTIImageWriter.h.

◆ RescaleIntercept

double vtkNIFTIImageWriter::RescaleIntercept
protected

Information for rescaling data to quantitative units.

Definition at line 201 of file vtkNIFTIImageWriter.h.

◆ RescaleSlope

double vtkNIFTIImageWriter::RescaleSlope
protected

Definition at line 202 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 208 of file vtkNIFTIImageWriter.h.

◆ QFormMatrix

vtkMatrix4x4* vtkNIFTIImageWriter::QFormMatrix
protected

The orientation matrices for the NIFTI file.

Definition at line 214 of file vtkNIFTIImageWriter.h.

◆ SFormMatrix

vtkMatrix4x4* vtkNIFTIImageWriter::SFormMatrix
protected

Definition at line 215 of file vtkNIFTIImageWriter.h.

◆ Description

char* vtkNIFTIImageWriter::Description
protected

A description of how the file was produced.

Definition at line 221 of file vtkNIFTIImageWriter.h.

◆ NIFTIHeader

vtkNIFTIImageHeader* vtkNIFTIImageWriter::NIFTIHeader
protected

The header information.

Definition at line 227 of file vtkNIFTIImageWriter.h.

◆ OwnHeader

vtkNIFTIImageHeader* vtkNIFTIImageWriter::OwnHeader
protected

Definition at line 228 of file vtkNIFTIImageWriter.h.

◆ NIFTIVersion

int vtkNIFTIImageWriter::NIFTIVersion
protected

Definition at line 229 of file vtkNIFTIImageWriter.h.

◆ PlanarRGB

bool vtkNIFTIImageWriter::PlanarRGB
protected

Use planar RGB instead of the default (packed).

Definition at line 235 of file vtkNIFTIImageWriter.h.


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