next up previous contents
Next: FREE FUNCTIONS (2) Up: DIMENSION FUNCTIONS (39) Previous: miget_dimension_width/miset_dimension_width   Contents

miget_dimension_widths/miset_dimension_widths

NAME

miget_dimension_widths, miset_dimension_widths - get or set the full-width
half-maximum values for points along a MINC dimension

SYNOPSIS

#include <minc2.h>

int miget_dimension_widths ( midimhandle_t      dimension, 
                             mivoxel_order_t    voxel_order,
                             unsigned long      array_length, 
                             unsigned long      start_position,
                             double             widths[]);

int miset_dimension_widths ( midimhandle_t      dimension, 
                             mivoxel_order_t    voxel_order,
                             unsigned long      array_length, 
                             unsigned long      start_position,
                             const double       widths[]);

DESCRIPTION

These functions get or set the dimension widths, that is, the
full-width half-maximum values of each sampled point along the
dimension.

The caller may retrieve up to "array_length" values, starting at the
integer index "start_position".  Thus an arbitrary contiguous subset
of the dimension's widths may be retrieved or stored.  An error is
returned if the "start_position" exceeds the total size of the
dimension.  If the value of "start_position" is legal, but the sum of
"start_position" and "array_length" exceeds the size of the dimension,
the function will get or set widths up to the size of the dimension.
Any extra positions in the widths[] array will be ignored.

It is explicitly legal to call this function for a regularly sampled
dimension.  The result will be a list of constant width values.
However, it is not possible to set widths on a regularly sampled
dimension.

RETURN VALUE

Returns the number of offset values read or written , or MI_ERROR if
an error is detected.

SEE ALSO

miget_dimension_width, miset_dimension_width



Robert VINCENT 2005-03-09