Store NIfTI header information. More...

#include <vtkNIFTIImageHeader.h>

Inheritance diagram for vtkNIFTIImageHeader:

Collaboration diagram for vtkNIFTIImageHeader:

Public Types
enum	IntentCodeEnum { IntentNone = 0 , IntentCorrel = 2 , IntentTTest = 3 , IntentFTest = 4 , IntentZScore = 5 , IntentChiSQ = 6 , IntentBeta = 7 , IntentBinom = 8 , IntentGamma = 9 , IntentPoisson = 10 , IntentNormal = 11 , IntentFTestNonc = 12 , IntentChiSQNonc = 13 , IntentLogistic = 14 , IntentLaplace = 15 , IntentUniform = 16 , IntentTTestNonc = 17 , IntentWeibull = 18 , IntentChi = 19 , IntentInvGauss = 20 , IntentExtVal = 21 , IntentPVal = 22 , IntentLogPVal = 23 , IntentLog10PVal = 24 , IntentEstimate = 1001 , IntentLabel = 1002 , IntentNeuroName = 1003 , IntentGenMatrix = 1004 , IntentSymMatrix = 1005 , IntentDispVect = 1006 , IntentVector = 1007 , IntentPointSet = 1008 , IntentTriangle = 1009 , IntentQuaternion = 1010 , IntentDimless = 1011 , IntentTimeSeries = 2001 , IntentNodeIndex = 2002 , IntentRGBVector = 2003 , IntentRGBAVector = 2004 , IntentShape = 2005 }
	NIFTI intent codes. More...

enum	XFormCodeEnum { XFormUnkown = 0 , XFormScannerAnat = 1 , XFormAlignedAnat = 2 , XFormTalairach = 3 , XFormMNI152 = 4 }
	NIFTI transform codes. More...

enum	SliceCodeEnum { SliceUnknown = 0 , SliceSeqInc = 1 , SliceSeqDec = 2 , SliceAltInc = 3 , SliceAltDec = 4 , SliceAltInc2 = 5 , SliceAltDec2 = 6 }
	NIFTI slice codes. More...

enum	UnitsXYZTEnum { UnitsUnknown = 0 , UnitsMeter = 1 , UnitsMM = 2 , UnitsMicron = 3 , UnitsSpace = 7 , UnitsSec = 8 , UnitsMSec = 16 , UnitsUSec = 24 , UnitsHz = 32 , UnitsPPM = 40 , UnitsRads = 48 , UnitsTime = 56 }
	NIFTI unit codes. More...

enum	DataTypeEnum { TypeUInt8 = 2 , TypeInt16 = 4 , TypeInt32 = 8 , TypeFloat32 = 16 , TypeComplex64 = 32 , TypeFloat64 = 64 , TypeRGB24 = 128 , TypeInt8 = 256 , TypeUInt16 = 512 , TypeUInt32 = 768 , TypeInt64 = 1024 , TypeUInt64 = 1280 , TypeFloat128 = 1536 , TypeComplex128 = 1792 , TypeComplex256 = 2048 , TypeRGBA32 = 2304 }
	NIFTI data types. More...

enum	HeaderSizeEnum { NIFTI1HeaderSize = 348 , NIFTI2HeaderSize = 540 }
	NIFTI header sizes. More...

Public Member Functions
void	PrintSelf (ostream &os, vtkIndent indent) override
	Print information about this object. More...

const char *	GetMagic ()
	Get the magic number for the NIFTI file as a null-terminated string. More...

vtkTypeInt64	GetVoxOffset ()
	Get the offset to the pixel data within the file. More...

int	GetDataType ()
	Get the data type. More...

int	GetBitPix ()
	Get the number of bits per pixel. More...

vtkTypeInt64	GetDim (int i)
	Get the nth dimension of the data, where GetDim(0) returns the number of dimensions that are defined for the file. More...

double	GetPixDim (int i)
	Get the sample spacing in the nth dimension. More...

void	SetIntentName (const char *name)
	Get the intent name. More...

const char *	GetIntentName ()

void	SetDescrip (const char *descrip)
	Get a null-terminated file descriptor, this usually gives the name of the software that wrote the file. More...

const char *	GetDescrip ()

void	SetAuxFile (VTK_FILEPATH const char *auxfile)
	Get an auxiliary file, e.g. More...

VTK_FILEPATH const char *	GetAuxFile ()

void	Initialize ()
	Initialize the header to default values. More...

void	DeepCopy (vtkNIFTIImageHeader *o)
	Make a copy of the header. More...


virtual void	SetIntentCode (int)
	Get the NIFTI intent code. More...

int	GetIntentCode ()
	Get the NIFTI intent code. More...


virtual void	SetIntentP1 (double)
	Get one of the NIFTI intent parameters. More...

double	GetIntentP1 ()
	Get one of the NIFTI intent parameters. More...

virtual void	SetIntentP2 (double)
	Get one of the NIFTI intent parameters. More...

double	GetIntentP2 ()
	Get one of the NIFTI intent parameters. More...

virtual void	SetIntentP3 (double)
	Get one of the NIFTI intent parameters. More...

double	GetIntentP3 ()
	Get one of the NIFTI intent parameters. More...


virtual void	SetSclSlope (double)
	Get the scale and slope to apply to the data in order to get the real-valued data values. More...

double	GetSclSlope ()
	Get the scale and slope to apply to the data in order to get the real-valued data values. More...

virtual void	SetSclInter (double)
	Get the scale and slope to apply to the data in order to get the real-valued data values. More...

double	GetSclInter ()
	Get the scale and slope to apply to the data in order to get the real-valued data values. More...


virtual void	SetCalMin (double)
	Get the calibrated range of the data, i.e. More...

double	GetCalMin ()
	Get the calibrated range of the data, i.e. More...

virtual void	SetCalMax (double)
	Get the calibrated range of the data, i.e. More...

double	GetCalMax ()
	Get the calibrated range of the data, i.e. More...


virtual void	SetSliceDuration (double)
	Get the slice_duration and toffset from the header. More...

double	GetSliceDuration ()
	Get the slice_duration and toffset from the header. More...

virtual void	SetTOffset (double)
	Get the slice_duration and toffset from the header. More...

double	GetTOffset ()
	Get the slice_duration and toffset from the header. More...


virtual void	SetSliceStart (vtkTypeInt64)
	Get the slice range for the data. More...

vtkTypeInt64	GetSliceStart ()
	Get the slice range for the data. More...

virtual void	SetSliceEnd (vtkTypeInt64)
	Get the slice range for the data. More...

vtkTypeInt64	GetSliceEnd ()
	Get the slice range for the data. More...


virtual void	SetSliceCode (int)
	Get the slice code for the data. More...

int	GetSliceCode ()
	Get the slice code for the data. More...


virtual void	SetXYZTUnits (int)
	Get a bitfield that describes the units for the first 4 dims. More...

int	GetXYZTUnits ()
	Get a bitfield that describes the units for the first 4 dims. More...


virtual void	SetDimInfo (int)
	Get a bitfield with extra information about the dimensions, it states which dimensions are the phase encode, frequency encode, and slice encode dimensions for MRI acquisitions. More...

int	GetDimInfo ()
	Get a bitfield with extra information about the dimensions, it states which dimensions are the phase encode, frequency encode, and slice encode dimensions for MRI acquisitions. More...


virtual void	SetQFormCode (int)
	Get the QForm or SForm code. More...

int	GetQFormCode ()
	Get the QForm or SForm code. More...

virtual void	SetSFormCode (int)
	Get the QForm or SForm code. More...

int	GetSFormCode ()
	Get the QForm or SForm code. More...


virtual void	SetQuaternB (double)
	Get information about the quaternion transformation. More...

double	GetQuaternB ()
	Get information about the quaternion transformation. More...

virtual void	SetQuaternC (double)
	Get information about the quaternion transformation. More...

double	GetQuaternC ()
	Get information about the quaternion transformation. More...

virtual void	SetQuaternD (double)
	Get information about the quaternion transformation. More...

double	GetQuaternD ()
	Get information about the quaternion transformation. More...

virtual void	SetQOffsetX (double)
	Get information about the quaternion transformation. More...

double	GetQOffsetX ()
	Get information about the quaternion transformation. More...

virtual void	SetQOffsetY (double)
	Get information about the quaternion transformation. More...

double	GetQOffsetY ()
	Get information about the quaternion transformation. More...

virtual void	SetQOffsetZ (double)
	Get information about the quaternion transformation. More...

double	GetQOffsetZ ()
	Get information about the quaternion transformation. More...


virtual void	SetSRowX (double, double, double, double)
	Get information about the matrix transformation. More...

virtual void	SetSRowX (double[4])
	Get information about the matrix transformation. More...

virtual double *	GetSRowX ()
	Get information about the matrix transformation. More...

virtual void	GetSRowX (double &, double &, double &, double &)
	Get information about the matrix transformation. More...

virtual void	GetSRowX (double[4])
	Get information about the matrix transformation. More...

virtual void	SetSRowY (double, double, double, double)
	Get information about the matrix transformation. More...

virtual void	SetSRowY (double[4])
	Get information about the matrix transformation. More...

virtual double *	GetSRowY ()
	Get information about the matrix transformation. More...

virtual void	GetSRowY (double &, double &, double &, double &)
	Get information about the matrix transformation. More...

virtual void	GetSRowY (double[4])
	Get information about the matrix transformation. More...

virtual void	SetSRowZ (double, double, double, double)
	Get information about the matrix transformation. More...

virtual void	SetSRowZ (double[4])
	Get information about the matrix transformation. More...

virtual double *	GetSRowZ ()
	Get information about the matrix transformation. More...

virtual void	GetSRowZ (double &, double &, double &, double &)
	Get information about the matrix transformation. More...

virtual void	GetSRowZ (double[4])
	Get information about the matrix transformation. More...


void	SetHeader (const nifti_1_header *hdr)
	Set the values from an existing nifti struct, or store the values in an existing nifti struct. More...

void	GetHeader (nifti_1_header *hdr)
	Set the values from an existing nifti struct, or store the values in an existing nifti struct. More...

void	SetHeader (const nifti_2_header *hdr)
	Set the values from an existing nifti struct, or store the values in an existing nifti struct. More...

void	GetHeader (nifti_2_header *hdr)
	Set the values from an existing nifti struct, or store the values in an existing nifti struct. More...

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

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

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

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

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). 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	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Protected Member Functions
	vtkNIFTIImageHeader ()

	~vtkNIFTIImageHeader () override

void	SetStringValue (char x, const char y, size_t n)

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 ()
	These methods allow a command to exclusively grab all events. More...

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

Protected Attributes
char	Magic [12]

vtkTypeInt64	VoxOffset

int	DataType

int	BitPix

vtkTypeInt64	Dim [8]

double	PixDim [8]

int	IntentCode

char	IntentName [18]

double	IntentP1

double	IntentP2

double	IntentP3

double	SclSlope

double	SclInter

double	CalMin

double	CalMax

double	SliceDuration

double	TOffset

vtkTypeInt64	SliceStart

vtkTypeInt64	SliceEnd

int	SliceCode

int	XYZTUnits

int	DimInfo

char	Descrip [82]

char	AuxFile [26]

int	QFormCode

int	SFormCode

double	QuaternB

double	QuaternC

double	QuaternD

double	QOffsetX

double	QOffsetY

double	QOffsetZ

double	SRowX [4]

double	SRowY [4]

double	SRowZ [4]

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkObject	Superclass
	Static method for construction. More...

static vtkNIFTIImageHeader *	New ()
	Static method for construction. More...

static vtkTypeBool	IsTypeOf (const char *type)
	Static method for construction. More...

static vtkNIFTIImageHeader *	SafeDownCast (vtkObjectBase *o)
	Static method for construction. More...

virtual vtkTypeBool	IsA (const char *type)
	Static method for construction. More...

vtkNIFTIImageHeader *	NewInstance () const
	Static method for construction. More...

virtual vtkObjectBase *	NewInstanceInternal () const
	Static method for construction. More...

Additional Inherited Members
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. 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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

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

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Store NIfTI header information.

This class stores the header of a NIfTI file in a VTK-friendly format. By using this class, it is possible to specify the header information that will be stored in a file written by the vtkNIFTIImageWriter. Note that the SForm and QForm orientation information in this class will be ignored by the writer if an SForm and QForm have been explicitly set via the writer's SetSForm and SetQForm methods. Also note that all info like Dim, PixDim, DataType, etc. will be ignored by the writer because this information must instead be taken from the vtkImageData information. Finally, note that the vtkNIFTIImageWriter will ignore the Descrip field, since it has its own SetDescription method.

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

See also: vtkNIFTIImageReader, vtkNIFTIImageWriter

Definition at line 46 of file vtkNIFTIImageHeader.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkNIFTIImageHeader::Superclass

Static method for construction.

Definition at line 181 of file vtkNIFTIImageHeader.h.

Member Enumeration Documentation

◆ IntentCodeEnum

enum vtkNIFTIImageHeader::IntentCodeEnum

NIFTI intent codes.

Enumerator
IntentNone
IntentCorrel
IntentTTest
IntentFTest
IntentZScore
IntentChiSQ
IntentBeta
IntentBinom
IntentGamma
IntentPoisson
IntentNormal
IntentFTestNonc
IntentChiSQNonc
IntentLogistic
IntentLaplace
IntentUniform
IntentTTestNonc
IntentWeibull
IntentChi
IntentInvGauss
IntentExtVal
IntentPVal
IntentLogPVal
IntentLog10PVal
IntentEstimate
IntentLabel
IntentNeuroName
IntentGenMatrix
IntentSymMatrix
IntentDispVect
IntentVector
IntentPointSet
IntentTriangle
IntentQuaternion
IntentDimless
IntentTimeSeries
IntentNodeIndex
IntentRGBVector
IntentRGBAVector
IntentShape

Definition at line 52 of file vtkNIFTIImageHeader.h.

◆ XFormCodeEnum

enum vtkNIFTIImageHeader::XFormCodeEnum

NIFTI transform codes.

Enumerator
XFormUnkown
XFormScannerAnat
XFormAlignedAnat
XFormTalairach
XFormMNI152

Definition at line 99 of file vtkNIFTIImageHeader.h.

◆ SliceCodeEnum

enum vtkNIFTIImageHeader::SliceCodeEnum

NIFTI slice codes.

Enumerator
SliceUnknown
SliceSeqInc
SliceSeqDec
SliceAltInc
SliceAltDec
SliceAltInc2
SliceAltDec2

Definition at line 111 of file vtkNIFTIImageHeader.h.

◆ UnitsXYZTEnum

enum vtkNIFTIImageHeader::UnitsXYZTEnum

NIFTI unit codes.

Enumerator
UnitsUnknown
UnitsMeter
UnitsMM
UnitsMicron
UnitsSpace
UnitsSec
UnitsMSec
UnitsUSec
UnitsHz
UnitsPPM
UnitsRads
UnitsTime

Definition at line 125 of file vtkNIFTIImageHeader.h.

◆ DataTypeEnum

enum vtkNIFTIImageHeader::DataTypeEnum

NIFTI data types.

Types RGB24 and RGB32 are represented in VTK as a multi-component unsigned char image. Complex values are represented as two-component images. The NIFTI types Float128 and Complex256 are not supported.

Enumerator
TypeUInt8
TypeInt16
TypeInt32
TypeFloat32
TypeComplex64
TypeFloat64
TypeRGB24
TypeInt8
TypeUInt16
TypeUInt32
TypeInt64
TypeUInt64
TypeFloat128
TypeComplex128
TypeComplex256
TypeRGBA32

Definition at line 147 of file vtkNIFTIImageHeader.h.

◆ HeaderSizeEnum

enum vtkNIFTIImageHeader::HeaderSizeEnum

NIFTI header sizes.

Enumerator
NIFTI1HeaderSize
NIFTI2HeaderSize

Definition at line 170 of file vtkNIFTIImageHeader.h.

Constructor & Destructor Documentation

◆ vtkNIFTIImageHeader()

vtkNIFTIImageHeader::vtkNIFTIImageHeader ( )

protected

◆ ~vtkNIFTIImageHeader()

vtkNIFTIImageHeader::~vtkNIFTIImageHeader ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkNIFTIImageHeader * vtkNIFTIImageHeader::New ( )

static

Static method for construction.

◆ IsTypeOf()

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

static

Static method for construction.

◆ IsA()

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

virtual

Static method for construction.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

Static method for construction.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkNIFTIImageHeader::NewInstanceInternal ( ) const

protectedvirtual

Static method for construction.

◆ NewInstance()

vtkNIFTIImageHeader * vtkNIFTIImageHeader::NewInstance ( ) const

Static method for construction.

◆ PrintSelf()

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

overridevirtual

Print information about this object.

Reimplemented from vtkObject.

◆ GetMagic()

const char * vtkNIFTIImageHeader::GetMagic ( )

inline

Get the magic number for the NIFTI file as a null-terminated string.

Definition at line 192 of file vtkNIFTIImageHeader.h.

◆ GetVoxOffset()

vtkTypeInt64 vtkNIFTIImageHeader::GetVoxOffset ( )

inline

Get the offset to the pixel data within the file.

Definition at line 197 of file vtkNIFTIImageHeader.h.

◆ GetDataType()

int vtkNIFTIImageHeader::GetDataType ( )

inline

Get the data type.

Definition at line 202 of file vtkNIFTIImageHeader.h.

◆ GetBitPix()

int vtkNIFTIImageHeader::GetBitPix ( )

inline

Get the number of bits per pixel.

Definition at line 207 of file vtkNIFTIImageHeader.h.

◆ GetDim()

vtkTypeInt64 vtkNIFTIImageHeader::GetDim ( int i )

inline

Get the nth dimension of the data, where GetDim(0) returns the number of dimensions that are defined for the file.

Definition at line 213 of file vtkNIFTIImageHeader.h.

◆ GetPixDim()

double vtkNIFTIImageHeader::GetPixDim ( int i )

inline

Get the sample spacing in the nth dimension.

If GetPixDim(0) is negative, then the quaternion for the qform describes the correct orientation only after the slice ordering has been reversed.

Definition at line 220 of file vtkNIFTIImageHeader.h.

◆ SetIntentCode()

virtual void vtkNIFTIImageHeader::SetIntentCode ( int )

virtual

Get the NIFTI intent code.

This is an enumerated value in the NIFTI header that states what the data is intended to be used for.

◆ GetIntentCode()

int vtkNIFTIImageHeader::GetIntentCode ( )

inline

Get the NIFTI intent code.

This is an enumerated value in the NIFTI header that states what the data is intended to be used for.

Definition at line 228 of file vtkNIFTIImageHeader.h.

◆ SetIntentName()

void vtkNIFTIImageHeader::SetIntentName ( const char * name )

Get the intent name.

This should match the intent code.

◆ GetIntentName()

const char * vtkNIFTIImageHeader::GetIntentName ( )

inline

Definition at line 235 of file vtkNIFTIImageHeader.h.

◆ SetIntentP1()

virtual void vtkNIFTIImageHeader::SetIntentP1 ( double )

virtual

Get one of the NIFTI intent parameters.

The definition of these parameters varies according to the IntentCode.

◆ GetIntentP1()

double vtkNIFTIImageHeader::GetIntentP1 ( )

inline

Get one of the NIFTI intent parameters.

The definition of these parameters varies according to the IntentCode.

Definition at line 243 of file vtkNIFTIImageHeader.h.

◆ SetIntentP2()

virtual void vtkNIFTIImageHeader::SetIntentP2 ( double )

virtual

Get one of the NIFTI intent parameters.

The definition of these parameters varies according to the IntentCode.

◆ GetIntentP2()

double vtkNIFTIImageHeader::GetIntentP2 ( )

inline

Get one of the NIFTI intent parameters.

The definition of these parameters varies according to the IntentCode.

Definition at line 245 of file vtkNIFTIImageHeader.h.

◆ SetIntentP3()

virtual void vtkNIFTIImageHeader::SetIntentP3 ( double )

virtual

Get one of the NIFTI intent parameters.

The definition of these parameters varies according to the IntentCode.

◆ GetIntentP3()

double vtkNIFTIImageHeader::GetIntentP3 ( )

inline

Get one of the NIFTI intent parameters.

The definition of these parameters varies according to the IntentCode.

Definition at line 247 of file vtkNIFTIImageHeader.h.

◆ SetSclSlope()

virtual void vtkNIFTIImageHeader::SetSclSlope ( double )

virtual

Get the scale and slope to apply to the data in order to get the real-valued data values.

◆ GetSclSlope()

double vtkNIFTIImageHeader::GetSclSlope ( )

inline

Get the scale and slope to apply to the data in order to get the real-valued data values.

Definition at line 256 of file vtkNIFTIImageHeader.h.

◆ SetSclInter()

virtual void vtkNIFTIImageHeader::SetSclInter ( double )

virtual

Get the scale and slope to apply to the data in order to get the real-valued data values.

◆ GetSclInter()

double vtkNIFTIImageHeader::GetSclInter ( )

inline

Get the scale and slope to apply to the data in order to get the real-valued data values.

Definition at line 258 of file vtkNIFTIImageHeader.h.

◆ SetCalMin()

virtual void vtkNIFTIImageHeader::SetCalMin ( double )

virtual

Get the calibrated range of the data, i.e.

the values stored in the cal_min and cal_max fields in the header.

◆ GetCalMin()

double vtkNIFTIImageHeader::GetCalMin ( )

inline

Get the calibrated range of the data, i.e.

the values stored in the cal_min and cal_max fields in the header.

Definition at line 267 of file vtkNIFTIImageHeader.h.

◆ SetCalMax()

virtual void vtkNIFTIImageHeader::SetCalMax ( double )

virtual

Get the calibrated range of the data, i.e.

the values stored in the cal_min and cal_max fields in the header.

◆ GetCalMax()

double vtkNIFTIImageHeader::GetCalMax ( )

inline

Get the calibrated range of the data, i.e.

the values stored in the cal_min and cal_max fields in the header.

Definition at line 269 of file vtkNIFTIImageHeader.h.

◆ SetSliceDuration()

virtual void vtkNIFTIImageHeader::SetSliceDuration ( double )

virtual

Get the slice_duration and toffset from the header.

◆ GetSliceDuration()

double vtkNIFTIImageHeader::GetSliceDuration ( )

inline

Get the slice_duration and toffset from the header.

Definition at line 277 of file vtkNIFTIImageHeader.h.

◆ SetTOffset()

virtual void vtkNIFTIImageHeader::SetTOffset ( double )

virtual

Get the slice_duration and toffset from the header.

◆ GetTOffset()

double vtkNIFTIImageHeader::GetTOffset ( )

inline

Get the slice_duration and toffset from the header.

Definition at line 279 of file vtkNIFTIImageHeader.h.

◆ SetSliceStart()

virtual void vtkNIFTIImageHeader::SetSliceStart ( vtkTypeInt64 )

virtual

Get the slice range for the data.

◆ GetSliceStart()

vtkTypeInt64 vtkNIFTIImageHeader::GetSliceStart ( )

inline

Get the slice range for the data.

Definition at line 287 of file vtkNIFTIImageHeader.h.

◆ SetSliceEnd()

virtual void vtkNIFTIImageHeader::SetSliceEnd ( vtkTypeInt64 )

virtual

Get the slice range for the data.

◆ GetSliceEnd()

vtkTypeInt64 vtkNIFTIImageHeader::GetSliceEnd ( )

inline

Get the slice range for the data.

Definition at line 289 of file vtkNIFTIImageHeader.h.

◆ SetSliceCode()

virtual void vtkNIFTIImageHeader::SetSliceCode ( int )

virtual

Get the slice code for the data.

◆ GetSliceCode()

int vtkNIFTIImageHeader::GetSliceCode ( )

inline

Get the slice code for the data.

Definition at line 297 of file vtkNIFTIImageHeader.h.

◆ SetXYZTUnits()

virtual void vtkNIFTIImageHeader::SetXYZTUnits ( int )

virtual

Get a bitfield that describes the units for the first 4 dims.

◆ GetXYZTUnits()

int vtkNIFTIImageHeader::GetXYZTUnits ( )

inline

Get a bitfield that describes the units for the first 4 dims.

Definition at line 305 of file vtkNIFTIImageHeader.h.

◆ SetDimInfo()

virtual void vtkNIFTIImageHeader::SetDimInfo ( int )

virtual

Get a bitfield with extra information about the dimensions, it states which dimensions are the phase encode, frequency encode, and slice encode dimensions for MRI acquisitions.

◆ GetDimInfo()

int vtkNIFTIImageHeader::GetDimInfo ( )

inline

Get a bitfield with extra information about the dimensions, it states which dimensions are the phase encode, frequency encode, and slice encode dimensions for MRI acquisitions.

Definition at line 315 of file vtkNIFTIImageHeader.h.

◆ SetDescrip()

void vtkNIFTIImageHeader::SetDescrip ( const char * descrip )

Get a null-terminated file descriptor, this usually gives the name of the software that wrote the file.

It will have a maximum length of 80 characters. Use ASCII to ensure compatibility with all NIFTI software, the NIFTI standard itself does not specify what encodings are permitted.

◆ GetDescrip()

const char * vtkNIFTIImageHeader::GetDescrip ( )

inline

Definition at line 326 of file vtkNIFTIImageHeader.h.

◆ SetAuxFile()

void vtkNIFTIImageHeader::SetAuxFile ( VTK_FILEPATH const char * auxfile )

Get an auxiliary file, e.g.

a color table, that is associated with this data. The length of the filename must be a maximum of 24 characters, and it will be assumed to be in the same directory as the NIFTI file.

◆ GetAuxFile()

VTK_FILEPATH const char * vtkNIFTIImageHeader::GetAuxFile ( )

inline

Definition at line 335 of file vtkNIFTIImageHeader.h.

◆ SetQFormCode()

virtual void vtkNIFTIImageHeader::SetQFormCode ( int )

virtual

Get the QForm or SForm code.

◆ GetQFormCode()

int vtkNIFTIImageHeader::GetQFormCode ( )

inline

Get the QForm or SForm code.

Definition at line 342 of file vtkNIFTIImageHeader.h.

◆ SetSFormCode()

virtual void vtkNIFTIImageHeader::SetSFormCode ( int )

virtual

Get the QForm or SForm code.

◆ GetSFormCode()

int vtkNIFTIImageHeader::GetSFormCode ( )

inline

Get the QForm or SForm code.

Definition at line 344 of file vtkNIFTIImageHeader.h.

◆ SetQuaternB()

virtual void vtkNIFTIImageHeader::SetQuaternB ( double )

virtual

Get information about the quaternion transformation.

Note that the vtkNIFTIImageWriter ignores this part of the header if a quaternion has been set via vtkNIFTIImageWriter::SetQFormMatrix().

◆ GetQuaternB()

double vtkNIFTIImageHeader::GetQuaternB ( )

inline

Get information about the quaternion transformation.

Note that the vtkNIFTIImageWriter ignores this part of the header if a quaternion has been set via vtkNIFTIImageWriter::SetQFormMatrix().

Definition at line 354 of file vtkNIFTIImageHeader.h.

◆ SetQuaternC()

virtual void vtkNIFTIImageHeader::SetQuaternC ( double )

virtual

Get information about the quaternion transformation.

Note that the vtkNIFTIImageWriter ignores this part of the header if a quaternion has been set via vtkNIFTIImageWriter::SetQFormMatrix().

◆ GetQuaternC()

double vtkNIFTIImageHeader::GetQuaternC ( )

inline

Get information about the quaternion transformation.

Note that the vtkNIFTIImageWriter ignores this part of the header if a quaternion has been set via vtkNIFTIImageWriter::SetQFormMatrix().

Definition at line 356 of file vtkNIFTIImageHeader.h.

◆ SetQuaternD()

virtual void vtkNIFTIImageHeader::SetQuaternD ( double )

virtual

Get information about the quaternion transformation.

Note that the vtkNIFTIImageWriter ignores this part of the header if a quaternion has been set via vtkNIFTIImageWriter::SetQFormMatrix().

◆ GetQuaternD()

double vtkNIFTIImageHeader::GetQuaternD ( )

inline

Get information about the quaternion transformation.

Note that the vtkNIFTIImageWriter ignores this part of the header if a quaternion has been set via vtkNIFTIImageWriter::SetQFormMatrix().

Definition at line 358 of file vtkNIFTIImageHeader.h.

◆ SetQOffsetX()

virtual void vtkNIFTIImageHeader::SetQOffsetX ( double )

virtual

Get information about the quaternion transformation.

Note that the vtkNIFTIImageWriter ignores this part of the header if a quaternion has been set via vtkNIFTIImageWriter::SetQFormMatrix().

◆ GetQOffsetX()

double vtkNIFTIImageHeader::GetQOffsetX ( )

inline

Get information about the quaternion transformation.

Note that the vtkNIFTIImageWriter ignores this part of the header if a quaternion has been set via vtkNIFTIImageWriter::SetQFormMatrix().

Definition at line 360 of file vtkNIFTIImageHeader.h.

◆ SetQOffsetY()

virtual void vtkNIFTIImageHeader::SetQOffsetY ( double )

virtual

Get information about the quaternion transformation.

Note that the vtkNIFTIImageWriter ignores this part of the header if a quaternion has been set via vtkNIFTIImageWriter::SetQFormMatrix().

◆ GetQOffsetY()

double vtkNIFTIImageHeader::GetQOffsetY ( )

inline

Get information about the quaternion transformation.

Note that the vtkNIFTIImageWriter ignores this part of the header if a quaternion has been set via vtkNIFTIImageWriter::SetQFormMatrix().

Definition at line 362 of file vtkNIFTIImageHeader.h.

◆ SetQOffsetZ()

virtual void vtkNIFTIImageHeader::SetQOffsetZ ( double )

virtual

Get information about the quaternion transformation.

Note that the vtkNIFTIImageWriter ignores this part of the header if a quaternion has been set via vtkNIFTIImageWriter::SetQFormMatrix().

◆ GetQOffsetZ()

double vtkNIFTIImageHeader::GetQOffsetZ ( )

inline

Get information about the quaternion transformation.

Note that the vtkNIFTIImageWriter ignores this part of the header if a quaternion has been set via vtkNIFTIImageWriter::SetQFormMatrix().

Definition at line 364 of file vtkNIFTIImageHeader.h.