IARRAY_GET_ND_FROM_MULTI(3)

EXPERIMENTAL_FUNC
iarray_get_nD_from_multi - Get a n-dimensional array from a Karma data structure.

SYNOPSIS
#include <karma_iarray.h>

flag iarray_get_nD_from_multi

(multi_array *multi_desc, CONST char *name, unsigned int num_dim, iarray *pseudo, iarray *red, iarray *green, iarray *blue, unsigned int *cmap_index)

DESCRIPTION
This routine will find an array embedded in a Karma data structure. The array may be single-channel (PseudoColour) or it may be a TrueColour array (red, green and blue components).

multi_desc
    The Karma data structure.

name
    The name of the general data structure. This may be NULL.

pseudo
    If a single-channel movie is found, the corresponding Intelligent Array is written here. If no single-channel movie is found, NULL is written here.

num_dim
    The number of dimensions the array must have. Passing 0 will cause the programme to abort.

red If a TrueColour array is found, the red component Intelligent Array is written here. If no TrueColour array is found, NULL is written here.

green
    If a TrueColour array is found, the green component Intelligent Array is written here. If no TrueColour array is found, NULL is written here.

blue
    If a TrueColour array is found, the blue component Intelligent Array is written here. If no TrueColour array is found, NULL is written here.

cmap_index
    If the array found is a single-channel array and the data structure has an associated RGBcolourmap, the index to the colourmap structure is written here. If no colourmap is found, the value written here is set to the number of general data structures in multi_desc.

RETURN VALUE
TRUE on succes, else FALSE.

Multi-threading Level
Unsafe.

AUTHOR
Richard Gooch (rgooch@atnf.csiro.au)

AVAILABLITY
The Karma Distribution is available for anonymous ftp from: ftp://ftp.atnf.csiro.au/pub/software/karma/ ftp://wuarchive.wustl.edu/graphics/graphics/packages/karma/ ftp://ftp.pwr.wroc.pl/pub/karma/ The Karma Home Page is: http://www.atnf.csiro.au/karma/