VIEWIMG(3)

PACKAGE
viewimg - Routines to manipulate viewable images

PURPOSE
These routines are meant to provide a high level mechanism to create and manipulate viewable images (2-dimensional slices of Karma data structures). These viewable images utilise the world canvases available in the <-canvas-> package, hence the resulting code is device independent.

LIBRARY
karmagraphics

LINK WITH
-lkarmagraphics

FUNCTIONS

viewimg_colourbar_create
    Create a colourbar world canvas for another world canvas.

viewimg_create_drag_and_zoom_interface
    Create a drag and zoom user interface for a canvas.

viewimg_draw_edit_list
    Draw edit list into array associated with viewable image.

viewimg_draw_edit_object
    Draw edit object into array associated with viewable image.

viewimg_header_position_func
    Position event callback.

viewimg_init
    Initialise the package for a particular canvas.

viewimg_create_restr
    Create viewable image from 2D slice with restrictions.

viewimg_create
    Create viewable image from 2D slice.

viewimg_create_from_iarray
    Create a viewable image from an Intelligent Array.

viewimg_create_sequence
    Create a sequence of viewable images from a 3D slice.

viewimg_create_sequence_from_iarray
    Create a sequence of viewable images from an Intelligent Array.

viewimg_create_rgb
    Create a TrueColour viewable image.

viewimg_create_rgb2
    Create a TrueColour viewable image.

viewimg_create_rgb_sequence
    Create sequence of TrueColour viewable images from 3D slice.

viewimg_create_rgb_sequence2
    Create sequence of TrueColour viewable images from 3D slice.

viewimg_make_active
    Make viewable image active and possibly refresh.

viewimg_set_active
    Make viewable image active with controlled refresh.

viewimg_register_data_change
    Notify data for viewable image has changed.

viewimg_destroy
    Destroy viewable image.

viewimg_get_active
    Get the active ViewableImage associated with a world canvas.

viewimg_test_active
    Test if viewable image is active.

viewimg_register_position_event_func
    Register position event callback.

viewimg_register_destroy_func
    Register destroy callback.

viewimg_fill_ellipse
    Draw an ellipse into an array associated with a viewable image.

viewimg_fill_polygon
    Draw a polygon into an array associated with a viewable image.

viewimg_get_canvas_attributes
    Get the viewable image attributes for a world canvas.

viewimg_set_canvas_attributes
    Set the viewable image attributes for a world canvas.

viewimg_get_attributes
    Get the attributes for a viewable image.

viewimg_set_attributes
    Set the attributes for a viewable image.

viewimg_set_array_attributes
    Set the attributes for an array of viewable images.

viewimg_partial_refresh
    Perform a partial refresh of a canvas.

viewimg_get_worldcanvas
    Get the world canvas for a viewable image.

viewimg_statistics_position_func
    Position event callback.

viewimg_statistics_geom_func
    Process a geometry editor event on a pixel canvas.

viewimg_statistics_compute
    Compute and display statistics for a subimage.

viewimg_track_compute
    Compute track strings.

viewimg_values_position_func
    Position event callback.

viewimg_values_geom_func
    Process a geometry editor event on a pixel canvas.

viewimg_values_display
    Compute and display values for a subimage.

viewimg_PROTO_position_func
    Position event callback.

viewimg_PROTO_destroy_func
    Process a destroy event on a ViewableImage.

TABLE viewimg_CANVAS_ATTRIBUTES
List of canvas attributes for viewable images
Name Type Meaning
VIEWIMG_ATT_END End of varargs list
VIEWIMG_ATT_AUTO_X flag Enable automatic horizontal scaling
VIEWIMG_ATT_AUTO_Y flag Enable automatic vertical scaling
VIEWIMG_ATT_AUTO_V flag Enable automatic intensity scaling
VIEWIMG_ATT_INT_X flag Force integer horizontal zoom-in/zoom-out factor
VIEWIMG_ATT_INT_Y flag Force integer vertical zoom-in/zoom-out factor
VIEWIMG_ATT_MAINTAIN_ASPECT flag Maintain data image aspect ratio
VIEWIMG_ATT_ALLOW_TRUNCATION flag Allow shrunken images to be truncated
VIEWIMG_ATT_ENABLE_PANNING flag Enable panning mode
VIEWIMG_ATT_PAN_CENTRE_X flag Horizontal panning centre
VIEWIMG_ATT_PAN_CENTRE_Y flag Horizontal panning centre
VIEWIMG_ATT_PAN_CENTRE_Y flag Vertical panning centre
VIEWIMG_ATT_PAN_MAGNIFICATION unsigned int Panner magnification

TABLE viewimg_VIMAGE_ATTRIBUTES
List of attributes for viewable images
Name Get Type Set Type Meaning
VIEWIMG_VATT_END End of varargs list
VIEWIMG_VATT_TRUECOLOUR flag * Image is TrueColour
VIEWIMG_VATT_ARRAY_DESC array_desc ** The array descriptor for the image
VIEWIMG_VATT_SLICE char ** Start of the image data
VIEWIMG_VATT_HDIM unsigned int * The horizontal dimension
VIEWIMG_VATT_VDIM unsigned int * The vertical dimension
VIEWIMG_VATT_PSEUDO_INDEX unsigned int * The PseudoColour element index
VIEWIMG_VATT_RED_INDEX unsigned int * The TrueColour red element index
VIEWIMG_VATT_GREEN_INDEX unsigned int * The TrueColour green element index
VIEWIMG_VATT_BLUE_INDEX unsigned int * The TrueColour blue element index
VIEWIMG_VATT_MULTI_ARRAY multi_array ** The multi_array descriptor
VIEWIMG_VATT_DATA_SCALE double * double PsueodoColour data multiplier
VIEWIMG_VATT_DATA_OFFSET double * double PsueodoColour data offset
VIEWIMG_VATT_VALUE_MIN double * double PseudoColour minimum value override
VIEWIMG_VATT_VALUE_MAX double * double PseudoColour maximum value override

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/