NAME
miget_dimension_separation, miset_dimension_separation - set/get the
sampling interval for a single dimension
SYNOPSIS
#include <minc2.h>
int miget_dimension_separation ( midimhandle_t dimension,
mivoxel_order_t voxel_order,
double *separation_ptr );
int miset_dimension_separation ( midimhandle_t dimension,
mivoxel_order_t voxel_order,
double separation );
DESCRIPTION
Gets or sets the constant sampling interval defined on a regularly-sampled
dimension. While it is legal to call these functions for an irregularly-
sampled dimension, the values will be ignored. The mivoxel_order_t is an
enumerated type which is defined as follows
typedef enum {
MI_FILE_ORDER = 0,
MI_APPARENT_ORDER = 1
} mivoxel_order_t;
This flag specifies whether the voxel order is original from file or
is an apparent one which can be the default (i.e., the same as the
original file) or the order that is specified by the user.
If not explicitly set, the separation will have a default value of one.
RETURN VALUE
Returns MI_NOERROR on success, or MI_ERROR on failure.
SEE ALSO
miget_dimension_separations, miset_dimension_separations