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

Store NIfTI header information. More...

#include <vtkNIFTIImageHeader.h>

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

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...
 
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...
 
vtkNIFTIImageHeaderNewInstance () const
 
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...
 
virtual void SetIntentCode (int)
 Get the NIFTI intent code. More...
 
int GetIntentCode ()
 
void SetIntentName (const char *name)
 Get the intent name. More...
 
const char * GetIntentName ()
 
virtual void SetIntentP1 (double)
 Get one of the NIFTI intent parameters. More...
 
double GetIntentP1 ()
 
virtual void SetIntentP2 (double)
 
double GetIntentP2 ()
 
virtual void SetIntentP3 (double)
 
double GetIntentP3 ()
 
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 ()
 
virtual void SetSclInter (double)
 
double GetSclInter ()
 
virtual void SetCalMin (double)
 Get the calibrated range of the data, i.e. More...
 
double GetCalMin ()
 
virtual void SetCalMax (double)
 
double GetCalMax ()
 
virtual void SetSliceDuration (double)
 Get the slice_duration and toffset from the header. More...
 
double GetSliceDuration ()
 
virtual void SetTOffset (double)
 
double GetTOffset ()
 
virtual void SetSliceStart (vtkTypeInt64)
 Get the slice range for the data. More...
 
vtkTypeInt64 GetSliceStart ()
 
virtual void SetSliceEnd (vtkTypeInt64)
 
vtkTypeInt64 GetSliceEnd ()
 
virtual void SetSliceCode (int)
 Get the slice code for the data. More...
 
int GetSliceCode ()
 
virtual void SetXYZTUnits (int)
 Get a bitfield that describes the units for the first 4 dims. More...
 
int GetXYZTUnits ()
 
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 ()
 
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 (const char *auxfile)
 Get an auxiliary file, e.g. More...
 
const char * GetAuxFile ()
 
virtual void SetQFormCode (int)
 Get the QForm or SForm code. More...
 
int GetQFormCode ()
 
virtual void SetSFormCode (int)
 
int GetSFormCode ()
 
virtual void SetQuaternB (double)
 Get information about the quaternion transformation. More...
 
double GetQuaternB ()
 
virtual void SetQuaternC (double)
 
double GetQuaternC ()
 
virtual void SetQuaternD (double)
 
double GetQuaternD ()
 
virtual void SetQOffsetX (double)
 
double GetQOffsetX ()
 
virtual void SetQOffsetY (double)
 
double GetQOffsetY ()
 
virtual void SetQOffsetZ (double)
 
double GetQOffsetZ ()
 
virtual void SetSRowX (double, double, double, double)
 Get information about the matrix transformation. More...
 
virtual void SetSRowX (double[4])
 
virtual double * GetSRowX ()
 
virtual void GetSRowX (double &, double &, double &, double &)
 
virtual void GetSRowX (double[4])
 
virtual void SetSRowY (double, double, double, double)
 
virtual void SetSRowY (double[4])
 
virtual double * GetSRowY ()
 
virtual void GetSRowY (double &, double &, double &, double &)
 
virtual void GetSRowY (double[4])
 
virtual void SetSRowZ (double, double, double, double)
 
virtual void SetSRowZ (double[4])
 
virtual double * GetSRowZ ()
 
virtual void GetSRowZ (double &, double &, double &, double &)
 
virtual void GetSRowZ (double[4])
 
void Initialize ()
 Initialize the header to default values. More...
 
void DeepCopy (vtkNIFTIImageHeader *o)
 Make a copy of the header. 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)
 
void SetHeader (const nifti_2_header *hdr)
 
void GetHeader (nifti_2_header *hdr)
 
- 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 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkNIFTIImageHeaderNew ()
 Static method for construction. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkNIFTIImageHeaderSafeDownCast (vtkObjectBase *o)
 
- 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 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 vtkObjectBaseNew ()
 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...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
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
 

Additional Inherited Members

- 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

Definition at line 181 of file vtkNIFTIImageHeader.h.

Member Enumeration Documentation

◆ 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

NIFTI transform codes.

Enumerator
XFormUnkown 
XFormScannerAnat 
XFormAlignedAnat 
XFormTalairach 
XFormMNI152 

Definition at line 99 of file vtkNIFTIImageHeader.h.

◆ SliceCodeEnum

NIFTI slice codes.

Enumerator
SliceUnknown 
SliceSeqInc 
SliceSeqDec 
SliceAltInc 
SliceAltDec 
SliceAltInc2 
SliceAltDec2 

Definition at line 111 of file vtkNIFTIImageHeader.h.

◆ 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

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

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

◆ IsA()

virtual vtkTypeBool vtkNIFTIImageHeader::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 vtkObjectBase.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkNIFTIImageHeader::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkNIFTIImageHeader* vtkNIFTIImageHeader::NewInstance ( ) const

◆ 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

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

Definition at line 243 of file vtkNIFTIImageHeader.h.

◆ SetIntentP2()

virtual void vtkNIFTIImageHeader::SetIntentP2 ( double  )
virtual

◆ GetIntentP2()

double vtkNIFTIImageHeader::GetIntentP2 ( )
inline

Definition at line 245 of file vtkNIFTIImageHeader.h.

◆ SetIntentP3()

virtual void vtkNIFTIImageHeader::SetIntentP3 ( double  )
virtual

◆ GetIntentP3()

double vtkNIFTIImageHeader::GetIntentP3 ( )
inline

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

Definition at line 256 of file vtkNIFTIImageHeader.h.

◆ SetSclInter()

virtual void vtkNIFTIImageHeader::SetSclInter ( double  )
virtual

◆ GetSclInter()

double vtkNIFTIImageHeader::GetSclInter ( )
inline

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

Definition at line 267 of file vtkNIFTIImageHeader.h.

◆ SetCalMax()

virtual void vtkNIFTIImageHeader::SetCalMax ( double  )
virtual

◆ GetCalMax()

double vtkNIFTIImageHeader::GetCalMax ( )
inline

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

Definition at line 277 of file vtkNIFTIImageHeader.h.

◆ SetTOffset()

virtual void vtkNIFTIImageHeader::SetTOffset ( double  )
virtual

◆ GetTOffset()

double vtkNIFTIImageHeader::GetTOffset ( )
inline

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

Definition at line 287 of file vtkNIFTIImageHeader.h.

◆ SetSliceEnd()

virtual void vtkNIFTIImageHeader::SetSliceEnd ( vtkTypeInt64  )
virtual

◆ GetSliceEnd()

vtkTypeInt64 vtkNIFTIImageHeader::GetSliceEnd ( )
inline

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

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

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

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

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

Definition at line 342 of file vtkNIFTIImageHeader.h.

◆ SetSFormCode()

virtual void vtkNIFTIImageHeader::SetSFormCode ( int  )
virtual

◆ GetSFormCode()

int vtkNIFTIImageHeader::GetSFormCode ( )
inline

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

Definition at line 354 of file vtkNIFTIImageHeader.h.

◆ SetQuaternC()

virtual void vtkNIFTIImageHeader::SetQuaternC ( double  )
virtual

◆ GetQuaternC()

double vtkNIFTIImageHeader::GetQuaternC ( )
inline

Definition at line 356 of file vtkNIFTIImageHeader.h.

◆ SetQuaternD()

virtual void vtkNIFTIImageHeader::SetQuaternD ( double  )
virtual

◆ GetQuaternD()

double vtkNIFTIImageHeader::GetQuaternD ( )
inline

Definition at line 358 of file vtkNIFTIImageHeader.h.

◆ SetQOffsetX()

virtual void vtkNIFTIImageHeader::SetQOffsetX ( double  )
virtual

◆ GetQOffsetX()

double vtkNIFTIImageHeader::GetQOffsetX ( )
inline

Definition at line 360 of file vtkNIFTIImageHeader.h.

◆ SetQOffsetY()

virtual void vtkNIFTIImageHeader::SetQOffsetY ( double  )
virtual

◆ GetQOffsetY()

double vtkNIFTIImageHeader::GetQOffsetY ( )
inline

Definition at line 362 of file vtkNIFTIImageHeader.h.

◆ SetQOffsetZ()

virtual void vtkNIFTIImageHeader::SetQOffsetZ ( double  )
virtual

◆ GetQOffsetZ()

double vtkNIFTIImageHeader::GetQOffsetZ ( )
inline

Definition at line 364 of file vtkNIFTIImageHeader.h.

◆ SetSRowX() [1/2]

virtual void vtkNIFTIImageHeader::SetSRowX ( double  ,
double  ,
double  ,
double   
)
virtual

Get information about the matrix transformation.

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

◆ SetSRowX() [2/2]

virtual void vtkNIFTIImageHeader::SetSRowX ( double  [4])
virtual

◆ GetSRowX() [1/3]

virtual double* vtkNIFTIImageHeader::GetSRowX ( )
virtual

◆ GetSRowX() [2/3]

virtual void vtkNIFTIImageHeader::GetSRowX ( double &  ,
double &  ,
double &  ,
double &   
)
virtual

◆ GetSRowX() [3/3]

virtual void vtkNIFTIImageHeader::GetSRowX ( double  [4])
virtual

◆ SetSRowY() [1/2]

virtual void vtkNIFTIImageHeader::SetSRowY ( double  ,
double  ,
double  ,
double   
)
virtual

◆ SetSRowY() [2/2]

virtual void vtkNIFTIImageHeader::SetSRowY ( double  [4])
virtual

◆ GetSRowY() [1/3]

virtual double* vtkNIFTIImageHeader::GetSRowY ( )
virtual

◆ GetSRowY() [2/3]

virtual void vtkNIFTIImageHeader::GetSRowY ( double &  ,
double &  ,
double &  ,
double &   
)
virtual

◆ GetSRowY() [3/3]

virtual void vtkNIFTIImageHeader::GetSRowY ( double  [4])
virtual

◆ SetSRowZ() [1/2]

virtual void vtkNIFTIImageHeader::SetSRowZ ( double  ,
double  ,
double  ,
double   
)
virtual

◆ SetSRowZ() [2/2]

virtual void vtkNIFTIImageHeader::SetSRowZ ( double  [4])
virtual

◆ GetSRowZ() [1/3]

virtual double* vtkNIFTIImageHeader::GetSRowZ ( )
virtual

◆ GetSRowZ() [2/3]

virtual void vtkNIFTIImageHeader::GetSRowZ ( double &  ,
double &  ,
double &  ,
double &   
)
virtual

◆ GetSRowZ() [3/3]

virtual void vtkNIFTIImageHeader::GetSRowZ ( double  [4])
virtual

◆ Initialize()

void vtkNIFTIImageHeader::Initialize ( )

Initialize the header to default values.

◆ DeepCopy()

void vtkNIFTIImageHeader::DeepCopy ( vtkNIFTIImageHeader o)

Make a copy of the header.

◆ SetHeader() [1/2]

void vtkNIFTIImageHeader::SetHeader ( const nifti_1_header hdr)

Set the values from an existing nifti struct, or store the values in an existing nifti struct.

◆ GetHeader() [1/2]

void vtkNIFTIImageHeader::GetHeader ( nifti_1_header hdr)

◆ SetHeader() [2/2]

void vtkNIFTIImageHeader::SetHeader ( const nifti_2_header hdr)

◆ GetHeader() [2/2]

void vtkNIFTIImageHeader::GetHeader ( nifti_2_header hdr)

◆ SetStringValue()

void vtkNIFTIImageHeader::SetStringValue ( char *  x,
const char *  y,
size_t  n 
)
protected

Member Data Documentation

◆ Magic

char vtkNIFTIImageHeader::Magic[12]
protected

Definition at line 406 of file vtkNIFTIImageHeader.h.

◆ VoxOffset

vtkTypeInt64 vtkNIFTIImageHeader::VoxOffset
protected

Definition at line 407 of file vtkNIFTIImageHeader.h.

◆ DataType

int vtkNIFTIImageHeader::DataType
protected

Definition at line 408 of file vtkNIFTIImageHeader.h.

◆ BitPix

int vtkNIFTIImageHeader::BitPix
protected

Definition at line 409 of file vtkNIFTIImageHeader.h.

◆ Dim

vtkTypeInt64 vtkNIFTIImageHeader::Dim[8]
protected

Definition at line 410 of file vtkNIFTIImageHeader.h.

◆ PixDim

double vtkNIFTIImageHeader::PixDim[8]
protected

Definition at line 411 of file vtkNIFTIImageHeader.h.

◆ IntentCode

int vtkNIFTIImageHeader::IntentCode
protected

Definition at line 412 of file vtkNIFTIImageHeader.h.

◆ IntentName

char vtkNIFTIImageHeader::IntentName[18]
protected

Definition at line 413 of file vtkNIFTIImageHeader.h.

◆ IntentP1

double vtkNIFTIImageHeader::IntentP1
protected

Definition at line 414 of file vtkNIFTIImageHeader.h.

◆ IntentP2

double vtkNIFTIImageHeader::IntentP2
protected

Definition at line 415 of file vtkNIFTIImageHeader.h.

◆ IntentP3

double vtkNIFTIImageHeader::IntentP3
protected

Definition at line 416 of file vtkNIFTIImageHeader.h.

◆ SclSlope

double vtkNIFTIImageHeader::SclSlope
protected

Definition at line 417 of file vtkNIFTIImageHeader.h.

◆ SclInter

double vtkNIFTIImageHeader::SclInter
protected

Definition at line 418 of file vtkNIFTIImageHeader.h.

◆ CalMin

double vtkNIFTIImageHeader::CalMin
protected

Definition at line 419 of file vtkNIFTIImageHeader.h.

◆ CalMax

double vtkNIFTIImageHeader::CalMax
protected

Definition at line 420 of file vtkNIFTIImageHeader.h.

◆ SliceDuration

double vtkNIFTIImageHeader::SliceDuration
protected

Definition at line 421 of file vtkNIFTIImageHeader.h.

◆ TOffset

double vtkNIFTIImageHeader::TOffset
protected

Definition at line 422 of file vtkNIFTIImageHeader.h.

◆ SliceStart

vtkTypeInt64 vtkNIFTIImageHeader::SliceStart
protected

Definition at line 423 of file vtkNIFTIImageHeader.h.

◆ SliceEnd

vtkTypeInt64 vtkNIFTIImageHeader::SliceEnd
protected

Definition at line 424 of file vtkNIFTIImageHeader.h.

◆ SliceCode

int vtkNIFTIImageHeader::SliceCode
protected

Definition at line 425 of file vtkNIFTIImageHeader.h.

◆ XYZTUnits

int vtkNIFTIImageHeader::XYZTUnits
protected

Definition at line 426 of file vtkNIFTIImageHeader.h.

◆ DimInfo

int vtkNIFTIImageHeader::DimInfo
protected

Definition at line 427 of file vtkNIFTIImageHeader.h.

◆ Descrip

char vtkNIFTIImageHeader::Descrip[82]
protected

Definition at line 428 of file vtkNIFTIImageHeader.h.

◆ AuxFile

char vtkNIFTIImageHeader::AuxFile[26]
protected

Definition at line 429 of file vtkNIFTIImageHeader.h.

◆ QFormCode

int vtkNIFTIImageHeader::QFormCode
protected

Definition at line 430 of file vtkNIFTIImageHeader.h.

◆ SFormCode

int vtkNIFTIImageHeader::SFormCode
protected

Definition at line 431 of file vtkNIFTIImageHeader.h.

◆ QuaternB

double vtkNIFTIImageHeader::QuaternB
protected

Definition at line 432 of file vtkNIFTIImageHeader.h.

◆ QuaternC

double vtkNIFTIImageHeader::QuaternC
protected

Definition at line 433 of file vtkNIFTIImageHeader.h.

◆ QuaternD

double vtkNIFTIImageHeader::QuaternD
protected

Definition at line 434 of file vtkNIFTIImageHeader.h.

◆ QOffsetX

double vtkNIFTIImageHeader::QOffsetX
protected

Definition at line 435 of file vtkNIFTIImageHeader.h.

◆ QOffsetY

double vtkNIFTIImageHeader::QOffsetY
protected

Definition at line 436 of file vtkNIFTIImageHeader.h.

◆ QOffsetZ

double vtkNIFTIImageHeader::QOffsetZ
protected

Definition at line 437 of file vtkNIFTIImageHeader.h.

◆ SRowX

double vtkNIFTIImageHeader::SRowX[4]
protected

Definition at line 438 of file vtkNIFTIImageHeader.h.

◆ SRowY

double vtkNIFTIImageHeader::SRowY[4]
protected

Definition at line 439 of file vtkNIFTIImageHeader.h.

◆ SRowZ

double vtkNIFTIImageHeader::SRowZ[4]
protected

Definition at line 440 of file vtkNIFTIImageHeader.h.


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