next up previous contents
Next: miget_dimension_units/miset_dimension_units Up: DIMENSION FUNCTIONS (39) Previous: miget_dimension_start/miset_dimension_start   Contents

miget_dimension_starts/miset_dimension_starts

NAME

miget_dimension_starts, miset_dimension_starts - get or set the start
values

SYNOPSIS

#include <minc2.h>

int miget_dimension_starts ( const midimhandle_t        dimensions[],
                             mivoxel_order_t            voxel_order,
                             int                        array_length,
                             double                     starts[]);
      
int miset_dimension_starts ( const midimhandle_t        dimensions[],
                             mivoxel_order_t            voxel_order,
                             int                        array_length,
                             const                      double starts[]);

DESCRIPTION

These functions get or set the start value for an array of
regularly-sampled dimensions.  The start value defines the origin of
that dimension.  While it is legal to call these functions for an
irregularly-sampled dimension, the values will be ignored.

If not explicitly set, the start value defaults to zero.

RETURN VALUE

These functions return the number of start values copied to or from
the starts[] array, or MI_ERROR on failure.



Robert VINCENT 2005-03-09