IARRAY(3)

PACKAGE
iarray - Routines to manipulate Intelligent Arrays

PURPOSE
These routines provide a simple interface to the recursive, heirarchical data structure supported in Karma, when only n-dimensional data is to be represented.

LIBRARY
karma

LINK WITH
-lkarma

FUNCTIONS

iarray_contour
    Extract contours from a 2-dimensional Intelligent Array.

iarray_get_image_from_multi
    Get an image from a Karma data structure.

iarray_get_movie_from_multi
    Get a movie from a Karma data structure.

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

iarray_read_nD
    Read in a Karma arrayfile and yield an "Intelligent Array".

iarray_write
    Write an "Intelligent Array" in the Karma data format.

iarray_create
    Create an Intelligent Array.

iarray_create2
    Create an Intelligent Array.

iarray_get_from_multi_array
    Create an Intelligent Array from a Karma data structure.

iarray_create_from_array_desc
    Create an Intelligent Array from a preallocated nD array.

iarray_dealloc
    Deallocate an Intelligent Array.

iarray_dealloc2
    Deallocate an Intelligent Array.

iarray_put_named_value
    Attach a data value to an Intelligent Array.

iarray_put_named_string
    Attach a string to an Intelligent Array.

iarray_get_named_value
    Get attached data from an Intelligent Array.

iarray_get_named_string
    Get attached string from an Intelligent Array.

iarray_get_sub_array_2D
    Create a 2-dimensional alias Intelligent Array.

iarray_get_2D_slice_from_3D
    Create a 2-dimensional Intelligent Array alias from a slice.

iarray_get_sub_array_3D
    Create a 3-dimensional alias Intelligent Array.

iarray_get_3D_slice_from_4D
    Create a 3-dimensional Intelligent Array alias from a slice.

iarray_remap_torus
    Remap Intelligent Array into a torus.

iarray_dim_length
    Get length of a dimension in an Intelligent Array.

iarray_dim_name
    Get dimension name in an Intelligent Array.

iarray_set_world_coords
    Set the world co-ordinates of an Intelligent Array dimension.

iarray_get_world_coords
    Get the world co-ordinates of an Intelligent Array dimension.

iarray_get_dim_desc
    Get a dimension descriptor from an Intelligent Array.

iarray_get_restrictions
    Get restriction information.

iarray_is_full_array
    Test if iarray is the same size as the underlying array.

iarray_compare_sizes
    Compare if two Intelligent Arrays are the same size.

iarray_copy_data
    Copy data between Intelligent Arrays.

iarray_clear
    Clear (set to zero) an Intelligent Array.

iarray_fill
    Fill an Intelligent Array with a single value.

iarray_min_max
    Determine the minimum and maximum value of an Intelligent Array.

iarray_scale_and_offset
    Scale and offset an Intelligent Array.

iarray_clip_scale_and_offset
    Clip, scale and offset an Intelligent Array.

iarray_add_and_scale
    Add Intelligent Arrays and scale.

iarray_add_and_scale2
    Add Intelligent Arrays and scale.

iarray_sub_and_scale
    Subtract Intelligent Arrays and scale.

iarray_multiply_divide
    Multiply or divide Intelligent Arrays and scale.

iarray_compute_histogram
    Compute a histogram of an "Intelligent Array".

iarray_sum
    Determine the sum of an Intelligent Array.

iarray_matrix_multiply
    Perform a matrix multiply.

iarray_dim_index
    This routine will find the index of a named dimension.

iarray_get_data_scaling
    Get the scale and offset for data in an Intelligent Array.

iarray_set_data_scaling
    Set the scale and offset for data in an Intelligent Array.

iarray_get_data_range
    Get the range of data in an Intelligent Array.

iarray_set_data_range
    Set the range of data in an Intelligent Array.

iarray_format_value
    Format a data value into a string.

iarray_create_from_template
    Create an Intelligent Array from a template array.

iarray_create_from_template2
    Create an Intelligent Array from a template array.

iarray_get_coordinate
    Get a co-ordinate along a dimension.

iarray_set_dim_name
    Change the name of a dimension of an Intelligent Array.

iarray_append_history_string
    Add a history string to an Intelligent Array.

iarray_copy_named_element
    Copy a named element from one Intelligent Array to another.

iarray_get_fits_axis
    Get the FITS axis number of a dimension.

iarray_create_and_setup
    Create an Intelligent Array and setup.

iarray_get_associated_wcs_astro
    Get the KwcsAstro object associated with an Intelligent Array.

iarray_set_value_name
    Change the data name of an Intelligent Array.

iarray_find_centroid
    Find the centroid inside an ellipse.

iarray_copy_attached
    Copy attached data from one Intelligent Array to another.

iarray_compare_grids_2D
    Compare if two image slices have the same world co-ordinate grid.

iarray_get_beam_correction
    Get the beam correction for an area in an array.

iarray_register_data_change
    Notify data for Intelligent Array has changed.

iarray_get_values
    Convert Intelligent Array data to double precision complex values

iarray_moment_compute
    Compute the 0th and 1st moments along the Z axis of a cube.

iarray_moment_create
    Create 2-D arrays to contain computed moment maps.

iarray_write_mono_ps
    Write an Intelligent Array as monochrome PostScript.

iarray_write_pseudocolour_ps
    Write an Intelligent Array as PseudoColour PostScript.

iarray_write_rgb_ps
    Write an Intelligent Array as TrueColour PostScript.

iarray_regrid_2D
    Regrid an array by iterating over the output array.

iarray_regrid_3D
    Regrid an array by iterating over the output array.

iarray_scroll
    Scroll an Intelligent Array.

iarray_rect_to_polar
    Transform an image from rectangular to polar co-ordinates.

iarray_transform_3D
    Transform an array by iterating over the input array.

iarray_untransform_3D
    Transform an array by iterating over the output array.

iarray_create_1D
    Create a 1-dimensional Intelligent Array.

iarray_create_2D
    Create a 2-dimensional Intelligent Array.

iarray_create_3D
    Create a 3-dimensional Intelligent Array.

iarray_create_4D
    Create a 4-dimensional Intelligent Array.

iarray_create_shm
    Create an n-dimensional Intelligent Array in shared memory.

iarray_put_double
    Attach a double precision data value to an Intelligent Array.

iarray_put_float
    Attach a float data value to an Intelligent Array.

iarray_put_int
    Attach an integer data value to an Intelligent Array.

iarray_get_double
    Get attached double float from an Intelligent Array.

iarray_get_float
    Get attached float from an Intelligent Array.

iarray_get_int
    Get attached integer from an Intelligent Array.

iarray_fill_double
    Fill an Intelligent Array with a double precision float value.

iarray_fill_float
    Fill an Intelligent Array with a single float value.

iarray_fill_int
    Fill an Intelligent Array with a single integer value.

iarray_min_max_float
    Determine the minimum and maximum value of an Intelligent Array.

iarray_min_max_int
    Determine the minimum and maximum value of an Intelligent Array.

iarray_scale_and_offset_float
    Scale and offset an Intelligent Array.

iarray_scale_and_offset_int
    Scale and offset an Intelligent Array.

iarray_num_dim
    Get number of dimensions in an Intelligent Array.

iarray_type
    Get type of data in an Intelligent Array.

iarray_value_name
    Get name of data in an Intelligent Array.

iarray_register_destroy_func
    Register destroy function for an Intelligent Array.

iarray_multi_array
    Get the multi_array for an Intelligent Array.

iarray_multi_index
    Get the index of the Intelligent Array within the multi_array.

iarray_array_desc
    Get the array_desc for an Intelligent Array.

iarray_arrayp
    Get the array_pointer for an Intelligent Array.

iarray_register_data_change_func
    Register data change function for an Intelligent Array.

iarray_PROTO_destroy_func
    Register destruction of an Intelligent Array.

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/