vtkNIFTIImagePrivate.h

Go to the documentation of this file.

#ifndef vtkNIFTIImagePrivate_h
#define vtkNIFTIImagePrivate_h

/*****************************************************************************
      ** This file defines the "NIFTI-1" header format.               **
      ** It is derived from 2 meetings at the NIH (31 Mar 2003 and    **
      ** 02 Sep 2003) of the Data Format Working Group (DFWG),        **
      ** chartered by the NIfTI (Neuroimaging Informatics Technology  **
      ** Initiative) at the National Institutes of Health (NIH).      **
      **--------------------------------------------------------------**
      ** Neither the National Institutes of Health (NIH), the DFWG,   **
      ** nor any of the members or employees of these institutions    **
      ** imply any warranty of usefulness of this material for any    **
      ** purpose, and do not assume any liability for damages,        **
      ** incidental or otherwise, caused by any use of this document. **
      ** If these conditions are not acceptable, do not use this!     **
      **--------------------------------------------------------------**
      ** Author:   Robert W Cox (NIMH, Bethesda)                      **
      ** Advisors: John Ashburner (FIL, London),                      **
      **           Stephen Smith (FMRIB, Oxford),                     **
      **           Mark Jenkinson (FMRIB, Oxford)                     **
******************************************************************************/

/*=================*/
#ifdef  __cplusplus
extern "C" {
#endif
/*=================*/

                        /*************************/  /************/
struct nifti_1_header { /* NIFTI-1 usage         */  /*  offset  */
                        /*************************/  /************/

  int   sizeof_hdr;      /*   0 */
  char  data_type[10];   /*   4 */
  char  db_name[18];     /*  14 */
  int   extents;         /*  32 */
  short session_error;   /*  36 */
  char  regular;         /*  38 */
  char  dim_info;        /*  39 */
  short dim[8];          /*  40 */
  float intent_p1;       /*  56 */
  float intent_p2;       /*  60 */
  float intent_p3;       /*  64 */
  short intent_code;     /*  68 */
  short datatype;        /*  70 */
  short bitpix;          /*  72 */
  short slice_start;     /*  74 */
  float pixdim[8];       /*  76 */
  float vox_offset;      /* 108 */
  float scl_slope;       /* 112 */
  float scl_inter;       /* 116 */
  short slice_end;       /* 120 */
  char  slice_code;      /* 122 */
  char  xyzt_units;      /* 123 */
  float cal_max;         /* 124 */
  float cal_min;         /* 128 */
  float slice_duration;  /* 132 */
  float toffset;         /* 136 */
  int   glmax;           /* 140 */
  int   glmin;           /* 144 */
  char  descrip[80];     /* 148 */
  char  aux_file[24];    /* 228 */
  short qform_code;      /* 252 */
  short sform_code;      /* 254 */
  float quatern_b;       /* 256 */
  float quatern_c;       /* 260 */
  float quatern_d;       /* 264 */
  float qoffset_x;       /* 268 */
  float qoffset_y;       /* 272 */
  float qoffset_z;       /* 276 */
  float srow_x[4];       /* 280 */
  float srow_y[4];       /* 296 */
  float srow_z[4];       /* 312 */
  char intent_name[16];  /* 328 */
  char magic[4];         /* 344 */

};                    /**** 348 bytes total ****/

typedef struct nifti_1_header nifti_1_header;

/*---------------------------------------------------------------------------*/
/* TYPE OF DATA (acceptable values for datatype field):
   ---------------------------------------------------
   Values of datatype smaller than 256 are ANALYZE 7.5 compatible.
   Larger values are NIFTI-1 additions.  These are all multiples of 256, so
   that no bits below position 8 are set in datatype.  But there is no need
   to use only powers-of-2, as the original ANALYZE 7.5 datatype codes do.

   The additional codes are intended to include a complete list of basic
   scalar types, including signed and unsigned integers from 8 to 64 bits,
   floats from 32 to 128 bits, and complex (float pairs) from 64 to 256 bits.

   Note that most programs will support only a few of these datatypes!
   A NIFTI-1 program should fail gracefully (e.g., print a warning message)
   when it encounters a dataset with a type it doesn't like.
-----------------------------------------------------------------------------*/

#define NIFTI_TYPE_UINT8           2

#define NIFTI_TYPE_INT16           4

#define NIFTI_TYPE_INT32           8

#define NIFTI_TYPE_FLOAT32        16

#define NIFTI_TYPE_COMPLEX64      32

#define NIFTI_TYPE_FLOAT64        64

#define NIFTI_TYPE_RGB24         128

#define NIFTI_TYPE_INT8          256

#define NIFTI_TYPE_UINT16        512

#define NIFTI_TYPE_UINT32        768

#define NIFTI_TYPE_INT64        1024

#define NIFTI_TYPE_UINT64       1280

#define NIFTI_TYPE_FLOAT128     1536

#define NIFTI_TYPE_COMPLEX128   1792

#define NIFTI_TYPE_COMPLEX256   2048

#define NIFTI_TYPE_RGBA32       2304
/* @} */


/*---------------------------------------------------------------------------*/
/* MISCELLANEOUS C MACROS
-----------------------------------------------------------------------------*/

/*.................*/
#define NIFTI_VERSION(h)                               \
 ( ( (h).magic[0]=='n' && (h).magic[3]=='\0'    &&     \
     ( (h).magic[1]=='i' || (h).magic[1]=='+' ) &&     \
     ( (h).magic[2]>='1' && (h).magic[2]<='9' )   )    \
 ? (h).magic[2]-'0' : 0 )

/*.................*/
#define NIFTI_ONEFILE(h) ( (h).magic[1] == '+' )

/*.................*/
#define NIFTI_NEEDS_SWAP(h) ( (h).dim[0] < 0 || (h).dim[0] > 7 )


/*=================*/
#ifdef  __cplusplus
}
#endif
/*=================*/

/*---------------------------------------------------------------------------*/
/* Changes to the header from NIFTI-1 to NIFTI-2 are intended to allow for
   larger and more accurate fields.  The changes are as follows:

      - short dim[8]         -> int64_t dim[8]
      - float intent_p1,2,3  -> double intent_p1,2,3    (3 fields)
      - float pixdim[8]      -> double pixdim[8]
      - float vox_offset     -> int64_t vox_offset
      - float scl_slope      -> double scl_slope
      - float scl_inter      -> double scl_inter
      - float cal_max        -> double cal_max
      - float cal_min        -> double cal_min
      - float slice_duration -> double slice_duration
      - float toffset        -> double toffset
      - short slice_start    -> int64_t slice_start
      - short slice_end      -> int64_t slice_end
      - char slice_code      -> int32_t slice_code
      - char xyzt_units      -> int32_t xyzt_units
      - short intent_code    -> int32_t intent_code
      - short qform_code     -> int32_t qform_code
      - short sform_code     -> int32_t sform_code
      - float quatern_b,c,d  -> double quatern_b,c,d    (3 fields)
      - float srow_x,y,z[4]  -> double srow_x,y,z[4]    (3 fields)
      - char magic[4]        -> char magic[8]
      - char unused_str[15]  -> padding added at the end of the header

      - previously unused fields have been removed:
           data_type, db_name, extents, session_error, regular, glmax, glmin

      - the field ordering has been changed
-----------------------------------------------------------------------------*/

/*=================*/
#ifdef  __cplusplus
extern "C" {
#endif
/*=================*/

                        /*************************/  /************/
struct nifti_2_header { /* NIFTI-2 usage         */  /*  offset  */
                        /*************************/  /************/
  int   sizeof_hdr;        /*   0 */
  char  magic[8];        /*   4 */
  short datatype;          /*  12 */
  short bitpix;            /*  14 */
  long long dim[8];        /*  16 */
  double intent_p1;        /*  80 */
  double intent_p2;        /*  88 */
  double intent_p3;        /*  96 */
  double pixdim[8];        /* 104 */
  long long vox_offset;    /* 168 */
  double scl_slope;        /* 176 */
  double scl_inter;        /* 184 */
  double cal_max;          /* 192 */
  double cal_min;          /* 200 */
  double slice_duration;   /* 208 */
  double toffset;          /* 216 */
  long long slice_start;   /* 224 */
  long long slice_end;     /* 232 */
  char descrip[80];        /* 240 */
  char aux_file[24];       /* 320 */
  int qform_code;          /* 344 */
  int sform_code;          /* 348 */
  double quatern_b;        /* 352 */
  double quatern_c;        /* 360 */
  double quatern_d;        /* 368 */
  double qoffset_x;        /* 376 */
  double qoffset_y;        /* 384 */
  double qoffset_z;        /* 392 */
  double srow_x[4];      /* 400 */
  double srow_y[4];      /* 432 */
  double srow_z[4];      /* 464 */
  int slice_code;          /* 496 */
  int xyzt_units;          /* 500 */
  int intent_code;         /* 504 */
  char intent_name[16];   /* 508 */
  char dim_info;           /* 524 */
  char unused_str[15];    /* 525 */
};                    /**** 540 bytes total ****/

typedef struct nifti_2_header nifti_2_header;

/*=================*/
#ifdef  __cplusplus
}
#endif
/*=================*/

#endif /* vtkNIFTIImagePrivate_h */
// VTK-HeaderTest-Exclude: vtkNIFTIImagePrivate.h