/usr/include/minc2.h is in libminc-dev 2.2.00-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 | /** \file minc2.h
* \brief MINC 2.0 public constants, types, and definitions.
*/
#ifndef _MINC2_H_ /* Avoid multiple inclusions */
#define _MINC2_H_ 1
#ifdef __cplusplus
extern "C" { /* Hey, Mr. Compiler - this is "C" code! */
#endif /* __cplusplus defined */
/************************************************************************
* CONSTANTS
************************************************************************/
#ifndef MI_NOERROR
/** Generic return code for successful operations. */
#define MI_NOERROR 0
#endif /* MI_NOERROR not defined */
#ifndef MI_ERROR
/** Generic return code for operations which fail for any reason. */
#define MI_ERROR (-1)
#endif /* MI_ERROR not defined */
#define MI_NATIVE "native____"
#define MI_TALAIRACH "talairach_"
#define MI_CALLOSAL "callosal__"
#ifndef TRUE
#define TRUE 1
#endif /* TRUE */
#ifndef FALSE
#define FALSE 0
#endif /* FALSE */
/** World spatial coordinates should always have this structure.
*/
#define MI2_3D 3
#define MI2_X 0
#define MI2_Y 1
#define MI2_Z 2
/** Dimension attribute values.
*/
#define MI_DIMATTR_ALL 0
#define MI_DIMATTR_REGULARLY_SAMPLED 0x1
#define MI_DIMATTR_NOT_REGULARLY_SAMPLED 0x2
/** Maximum length of a standard string.
*/
#define MI2_CHAR_LENGTH 128
/** Maximum number of dimensions a variable can have.
*/
#define MI2_MAX_VAR_DIMS 100
#define MI2_CHUNK_SIZE 32 /* Length of chunk, per dimension */
#define MI2_DEFAULT_ZLIB_LEVEL 4
#define MI2_MAX_ZLIB_LEVEL 9
#define MI2_MAX_PATH 128
#define MI2_MAX_RESOLUTION_GROUP 16
#define MI2_OPEN_READ 0x0001
#define MI2_OPEN_RDWR 0x0002
#define MI_VERSION_2_0 "MINC Version 2.0"
/************************************************************************
* ENUMS, STRUCTS, and TYPEDEFS
************************************************************************/
/* These structure declarations exist to allow the following typedefs to
* work. Since the details of these structures are not meant to be public,
* the actual structure definitions are in minc2_private.h
*/
struct mivolprops;
struct midimension;
struct mivolume;
/** \typedef mivolumeprops_t
* Opaque pointer to volume properties.
*/
typedef struct mivolprops *mivolumeprops_t;
/** \typedef midimhandle_t
* Opaque pointer to a MINC dimension object.
*/
typedef struct midimension *midimhandle_t;
/** \typedef mihandle_t
* The mihandle_t is an opaque type that represents a MINC file object.
*/
typedef struct mivolume *mihandle_t;
typedef void *milisthandle_t;
/**
* This typedef used to represent the type of an individual voxel <b>as
* stored</b> by MINC 2.0. If a volume is
*/
typedef enum {
MI_TYPE_BYTE = 1, /**< 8-bit signed integer */
MI_TYPE_SHORT = 3, /**< 16-bit signed integer */
MI_TYPE_INT = 4, /**< 32-bit signed integer */
MI_TYPE_FLOAT = 5, /**< 32-bit floating point */
MI_TYPE_DOUBLE = 6, /**< 64-bit floating point */
MI_TYPE_STRING = 7, /**< ASCII string */
MI_TYPE_UBYTE = 100, /**< 8-bit unsigned integer */
MI_TYPE_USHORT = 101, /**< 16-bit unsigned integer */
MI_TYPE_UINT = 102, /**< 32-bit unsigned integer */
MI_TYPE_SCOMPLEX = 1000, /**< 16-bit signed integer complex */
MI_TYPE_ICOMPLEX = 1001, /**< 32-bit signed integer complex */
MI_TYPE_FCOMPLEX = 1002, /**< 32-bit floating point complex */
MI_TYPE_DCOMPLEX = 1003, /**< 64-bit floating point complex */
MI_TYPE_UNKNOWN = -1 /**< when the type is a record */
} mitype_t;
/**
* This typedef is used to represent the class of the MINC file.
*
* The class specifies the data's interpretation rather than its
* storage format. For example, a floating point class implies
* that the data may be stored as integers but must nonetheless be
* scaled into a "real" range before any mathematical operations
* are performed. A label class implies that the values of a voxel
* should be considered to represent a symbol, and therefore many
* operations on the voxels would be considered meaningless.
*/
typedef enum {
MI_CLASS_REAL = 0, /**< Floating point (default) */
MI_CLASS_INT = 1, /**< Integer */
MI_CLASS_LABEL = 2, /**< Enumerated (named data values) */
MI_CLASS_COMPLEX = 3, /**< Complex (real/imaginary) values */
MI_CLASS_UNIFORM_RECORD = 4, /**< Aggregate datatypes consisting of multiple values of the same underlying type. */
MI_CLASS_NON_UNIFORM_RECORD = 5 /**< Aggregate datatypes consisting of multiple values of potentially differing types (not yet implemented). */
} miclass_t;
/** Dimensions be members of one of several classes. The "MI_DIMCLASS_ANY"
* value is never actually assigned to a dimension. It is used in the
* programming interface to specify that an operation should apply to
* all dimensions regardless of class.
*/
typedef enum {
MI_DIMCLASS_ANY = 0, /**< Don't care (or unknown) */
MI_DIMCLASS_SPATIAL = 1, /**< Spatial dimensions (x, y, z) */
MI_DIMCLASS_TIME = 2, /**< Time dimension */
MI_DIMCLASS_SFREQUENCY = 3, /**< Spatial frequency dimensions */
MI_DIMCLASS_TFREQUENCY = 4, /**< Temporal frequency dimensions */
MI_DIMCLASS_USER = 5, /**< Arbitrary user-defined dimension */
MI_DIMCLASS_RECORD = 6 /**< Record as dimension */
} midimclass_t;
/** Dimension order refers to the idea that data can be structured in
* a variety of ways with respect to the dimensions. For example, a typical
* 3D scan could be structured as a transverse (ZYX) or sagittal (XZY) image.
* Since it may be convenient to write code which expects a particular
* dimension order, a user can specify an alternative ordering by using
* miset_apparent_dimension_order(). This will cause most functions
* to return data as if the file was in the apparent, rather than the
* file (native) order.
*/
typedef enum {
MI_DIMORDER_FILE = 0,
MI_DIMORDER_APPARENT = 1
} miorder_t;
/** Voxel order can be either file (native), or apparent, as set by
* the function miset_dimension_apparent_voxel_order().
*/
typedef enum {
MI_ORDER_FILE = 0, /**< File order */
MI_ORDER_APPARENT = 1 /**< Apparent (user) order */
} mivoxel_order_t;
/**
* Voxel flipping can be specified to either follow the file's native
* order, the opposite of the file's order, or it can be tied to the
* value of the dimension's step attribute. A value of MI_NEGATIVE
* implies that the voxel order should be rearranged such that the step
* attribute is negative, a value of MI_POSITIVE implies the opposite.
*/
typedef enum {
MI_FILE_ORDER = 0, /**< no flip */
MI_COUNTER_FILE_ORDER = 1, /**< flip */
MI_POSITIVE = 2, /**< force step value to be positive */
MI_NEGATIVE = 3 /**< force step value to be negative */
} miflipping_t;
/** Compression type
*/
typedef enum {
MI_COMPRESS_NONE = 0, /**< No compression */
MI_COMPRESS_ZLIB = 1 /**< GZIP compression */
} micompression_t;
typedef int miboolean_t;
typedef unsigned int midimattr_t;
typedef unsigned long misize_t;
/** 16-bit integer complex voxel.
*/
typedef struct {
short real; /**< Real part */
short imag; /**< Imaginary part */
} miscomplex_t;
/** 32-bit integer complex voxel.
*/
typedef struct {
int real; /**< Real part */
int imag; /**< Imaginary part */
} miicomplex_t;
/** 32-bit floating point complex voxel.
*/
typedef struct {
float real; /**< Real part */
float imag; /**< Imaginary part */
} mifcomplex_t;
/** 64-bit floating point complex voxel.
*/
typedef struct {
double real; /**< Real part */
double imag; /**< Imaginary part */
} midcomplex_t;
/************************************************************************
* FUNCTION DECLARATIONS
************************************************************************/
/* ATTRIBUTE/GROUP FUNCTIONS */
extern int milist_start(mihandle_t vol, const char *path, int flags,
milisthandle_t *handle);
extern int milist_attr_next(mihandle_t vol, milisthandle_t handle,
char *path, int maxpath,
char *name, int maxname);
extern int milist_finish(milisthandle_t handle);
extern int milist_grp_next(milisthandle_t handle, char *path, int maxpath);
extern int micreate_group(mihandle_t vol, const char *path, const char *name);
extern int midelete_attr(mihandle_t vol, const char *path, const char *name);
extern int midelete_group(mihandle_t vol, const char *path, const char *name);
extern int miget_attr_length(mihandle_t vol, const char *path,
const char *name, int *length);
extern int miget_attr_type(mihandle_t vol, const char *path, const char *name,
mitype_t *data_type);
extern int micopy_attr(mihandle_t vol, const char *path, mihandle_t new_vol);
extern int miget_attr_values(mihandle_t vol, mitype_t data_type,
const char *path, const char *name,
int length, void *values);
extern int miset_attr_values(mihandle_t vol, mitype_t data_type,
const char *path, const char *name, int length,
const void *values);
extern int miadd_history_attr(mihandle_t vol, int length, const void *values);
/* FREE FUNCTIONS */
extern int mifree_name(char *name_ptr);
extern int mifree_names(char **name_pptr);
/* DATA TYPE/SPACE FUNCTIONS */
extern int miget_data_class(mihandle_t vol, miclass_t *volume_class);
extern int miget_data_type(mihandle_t vol, mitype_t *volume_data_type);
extern int miget_data_type_size(mihandle_t vol, misize_t *voxel_size);
extern int miget_space_name(mihandle_t vol, char **name);
extern int miset_space_name(mihandle_t vol, const char *name);
/* DIMENSION FUNCTIONS */
extern int miget_volume_from_dimension(midimhandle_t dimension, mihandle_t *volume);
extern int micopy_dimension(midimhandle_t dim_ptr, midimhandle_t *new_dim_ptr);
extern int micreate_dimension(const char *name, midimclass_t dimclass, midimattr_t attr,
unsigned int length, midimhandle_t *new_dim_ptr);
extern int mifree_dimension_handle(midimhandle_t dim_ptr);
extern int miget_volume_dimensions(mihandle_t volume, midimclass_t dimclass, midimattr_t attr,
miorder_t order, int array_length,
midimhandle_t dimensions[]);
extern int miset_apparent_dimension_order(mihandle_t volume, int array_length, midimhandle_t dimensions[]);
extern int miset_apparent_dimension_order_by_name(mihandle_t volume, int array_length, char **names);
extern int miset_apparent_record_dimension_flag(mihandle_t volume, int record_flag);
extern int miget_dimension_apparent_voxel_order(midimhandle_t dimension, miflipping_t *file_order,
miflipping_t *sign);
extern int miset_dimension_apparent_voxel_order(midimhandle_t dimension, miflipping_t flipping_order);
extern int miget_dimension_class(midimhandle_t dimension, midimclass_t *dimclass);
extern int miset_dimension_class(midimhandle_t dimension, midimclass_t dimclass);
extern int miget_dimension_cosines(midimhandle_t dimension,
double direction_cosines[3]);
extern int miset_dimension_cosines(midimhandle_t dimension,
const double direction_cosines[3]);
extern int miset_dimension_description(midimhandle_t dimension, const char *comments);
extern int miget_dimension_description(midimhandle_t dimension, char **comments_ptr);
extern int miget_dimension_name(midimhandle_t dimension, char **name_ptr);
extern int miset_dimension_name(midimhandle_t dimension, const char *name);
extern int miget_dimension_offsets(midimhandle_t dimension, unsigned long array_length,
unsigned long start_position, double offsets[]);
extern int miset_dimension_offsets(midimhandle_t dimension, unsigned long array_length,
unsigned long start_position, const double offsets[]);
extern int miget_dimension_sampling_flag(midimhandle_t dimension, miboolean_t *sampling_flag);
extern int miset_dimension_sampling_flag(midimhandle_t dimension, miboolean_t sampling_flag);
extern int miget_dimension_separation(midimhandle_t dimension,
mivoxel_order_t voxel_order,
double *separation_ptr);
extern int miset_dimension_separation(midimhandle_t dimension,
double separation);
extern int miget_dimension_separations(const midimhandle_t dimensions[],
mivoxel_order_t voxel_order,
int array_length,
double separations[]);
extern int miset_dimension_separations(const midimhandle_t dimensions[], int array_length,
const double separations[]);
extern int miget_dimension_size(midimhandle_t dimension, unsigned int *size_ptr);
extern int miset_dimension_size(midimhandle_t dimension, unsigned int size);
extern int miget_dimension_sizes(const midimhandle_t dimensions[], int array_length,
unsigned int sizes[]);
extern int miget_dimension_start(midimhandle_t dimension,
mivoxel_order_t voxel_order,
double *start_ptr);
extern int miset_dimension_start(midimhandle_t dimension, double start_ptr);
extern int miget_dimension_starts(const midimhandle_t dimensions[], mivoxel_order_t voxel_order,
int array_length, double starts[]);
extern int miset_dimension_starts(const midimhandle_t dimensions[], int array_length,
const double starts[]);
extern int miget_dimension_units(midimhandle_t dimension, char **units_ptr);
extern int miset_dimension_units(midimhandle_t dimension, const char *units);
extern int miget_dimension_width(midimhandle_t dimension, double *width_ptr);
extern int miset_dimension_width(midimhandle_t dimension, double width_ptr);
extern int miget_dimension_widths(midimhandle_t dimension, mivoxel_order_t voxel_order,
unsigned long array_length, unsigned long start_position,
double widths[]);
extern int miset_dimension_widths(midimhandle_t dimension, unsigned long array_length,
unsigned long start_position, const double widths[]);
/* VOLUME FUNCTIONS */
extern int micreate_volume(const char *filename, int number_of_dimensions,
midimhandle_t dimensions[],
mitype_t volume_type,
miclass_t volume_class,
mivolumeprops_t create_props,
mihandle_t *volume);
extern int micreate_volume_image(mihandle_t volume);
extern int miget_volume_dimension_count(mihandle_t volume, midimclass_t dimclass,
midimattr_t attr, int *number_of_dimensions);
extern int miget_volume_voxel_count(mihandle_t volume, int *number_of_voxels);
extern int miopen_volume(const char *filename, int mode, mihandle_t *volume);
extern int miclose_volume(mihandle_t volume);
extern int miget_slice_scaling_flag(mihandle_t volume,
miboolean_t *slice_scaling_flag);
extern int miset_slice_scaling_flag(mihandle_t volume,
miboolean_t slice_scaling_flag);
/* VOLUME PROPERTIES FUNCTIONS */
extern int minew_volume_props(mivolumeprops_t *props);
extern int mifree_volume_props(mivolumeprops_t props);
extern int miget_volume_props(mihandle_t vol, mivolumeprops_t *props);
extern int miset_props_multi_resolution(mivolumeprops_t props, miboolean_t enable_flag,
int depth);
extern int miget_props_multi_resolution(mivolumeprops_t props, miboolean_t *enable_flag,
int *depth);
extern int miselect_resolution(mihandle_t volume, int depth);
extern int miflush_from_resolution(mihandle_t volume, int depth);
extern int miset_props_compression_type(mivolumeprops_t props, micompression_t compression_type);
extern int miget_props_compression_type(mivolumeprops_t props, micompression_t *compression_type);
extern int miset_props_zlib_compression(mivolumeprops_t props, int zlib_level);
extern int miget_props_zlib_compression(mivolumeprops_t props, int *zlib_level);
extern int miset_props_blocking(mivolumeprops_t props, int edge_count, const int *edge_lengths);
extern int miget_props_blocking(mivolumeprops_t props, int *edge_count, int *edge_lengths,
int max_lengths);
extern int miset_props_record(mivolumeprops_t props, long record_length, char *record_name);
extern int miset_props_template(mivolumeprops_t props, int template_flag);
/* SLICE/VOLUME SCALE FUNCTIONS */
extern int miget_slice_max(mihandle_t volume,
const unsigned long start_positions[],
int array_length, double *slice_max);
extern int miset_slice_max(mihandle_t volume,
const unsigned long start_positions[],
int array_length, double slice_max);
extern int miget_slice_min(mihandle_t volume,
const unsigned long start_positions[],
int array_length, double *slice_min);
extern int miset_slice_min(mihandle_t volume,
const unsigned long start_positions[],
int array_length, double slice_min);
extern int miget_slice_range(mihandle_t volume,
const unsigned long start_positions[],
int array_length, double *slice_max,
double *slice_min);
extern int miset_slice_range(mihandle_t volume,
const unsigned long start_positions[],
int array_length, double slice_max,
double slice_min);
extern int miget_volume_max(mihandle_t volume, double *slice_max);
extern int miset_volume_max(mihandle_t volume, double slice_max);
extern int miget_volume_min(mihandle_t volume, double *slice_min);
extern int miset_volume_min(mihandle_t volume, double slice_min);
extern int miget_volume_range(mihandle_t volume, double *slice_max,
double *slice_min);
extern int miset_volume_range(mihandle_t volume, double slice_max,
double slice_min);
/* HYPERSLAB FUNCTIONS */
extern int miget_hyperslab_size(mitype_t volume_data_type, int n_dimensions,
const unsigned long count[],
misize_t *size_ptr);
extern int miget_hyperslab_normalized(mihandle_t volume,
mitype_t buffer_data_type,
const unsigned long start[],
const unsigned long count[],
double min,
double max,
void *buffer);
extern int miget_hyperslab_with_icv(mihandle_t volume,
int icv,
mitype_t buffer_data_type,
const unsigned long start[],
const unsigned long count[],
void *buffer);
extern int miset_hyperslab_with_icv(mihandle_t volume,
int icv,
mitype_t buffer_data_type,
const unsigned long start[],
const unsigned long count[],
void *buffer);
extern int miget_real_value_hyperslab(mihandle_t volume,
mitype_t buffer_data_type,
const unsigned long start[],
const unsigned long count[],
void *buffer);
extern int miset_real_value_hyperslab(mihandle_t volume,
mitype_t buffer_data_type,
const unsigned long start[],
const unsigned long count[],
void *buffer);
extern int miget_voxel_value_hyperslab(mihandle_t volume,
mitype_t buffer_data_type,
const unsigned long start[],
const unsigned long count[],
void *buffer);
extern int miset_voxel_value_hyperslab(mihandle_t volume,
mitype_t buffer_data_type,
const unsigned long start[],
const unsigned long count[],
void *buffer);
/* CONVERT FUNCTIONS */
extern int miconvert_real_to_voxel(mihandle_t volume,
const unsigned long coords[],
int ncoords,
double real_value,
double *voxel_value_ptr);
extern int miconvert_voxel_to_real(mihandle_t volume,
const unsigned long coords[],
int ncoords,
double voxel_value,
double *real_value_ptr);
extern int miconvert_voxel_to_world(mihandle_t volume,
const double voxel[],
double world[]);
extern int miconvert_world_to_voxel(mihandle_t volume,
const double world[],
double voxel[]);
extern int miget_real_value(mihandle_t volume,
const unsigned long coords[],
int ndims,
double *value_ptr);
extern int miset_real_value(mihandle_t volume,
const unsigned long coords[],
int ndims,
double value);
extern int miget_voxel_value(mihandle_t volume,
const unsigned long coords[],
int ndims,
double *voxel_ptr);
extern int miset_voxel_value(mihandle_t volume,
const unsigned long coords[],
int ndims,
double voxel);
extern int miget_volume_real_range(mihandle_t volume, double real_range[2]);
extern int miset_world_origin(mihandle_t volume, double origin[MI2_3D]);
/* VALID functions */
extern int miget_volume_valid_max(mihandle_t volume, double *valid_max);
extern int miset_volume_valid_max(mihandle_t volume, double valid_max);
extern int miget_volume_valid_min(mihandle_t volume, double *valid_min);
extern int miset_volume_valid_min(mihandle_t volume, double valid_min);
extern int miget_volume_valid_range(mihandle_t volume,
double *valid_max, double *valid_min);
extern int miset_volume_valid_range(mihandle_t volume,
double valid_max, double valid_min);
/* RECORD functions */
extern int miget_record_name(mihandle_t volume, char **name);
extern int miget_record_length(mihandle_t volume, int *length);
extern int miget_record_field_name(mihandle_t volume, int index, char **name);
extern int miset_record_field_name(mihandle_t volume, int index,
const char *name);
/* LABEL functions */
extern int midefine_label(mihandle_t volume, int value, const char *name);
extern int miget_label_name(mihandle_t volume, int value, char **name);
extern int miget_label_value(mihandle_t volume, const char *name, int *value);
extern int miget_number_of_defined_labels(mihandle_t volume, int *number_of_labels);
extern int miget_label_value_by_index(mihandle_t volume, int idx, int *value);
#ifdef __cplusplus
}
#endif /* __cplusplus defined */
#endif /* _MINC2_H_ */
|