DATAMANIP (kdatamanip) functions


LIBRARY ROUTINE

lkorient - reorient object to new dimensions

LIBRARY CALL

int lkorient (
   kobject src_obj,
   int     *src2dst_map,
   kobject dst_obj)

INPUT

OUTPUT

RETURN VALUE

TRUE (1) on success, FALSE (0) on failure

DESCRIPTION

The following is the library routine that performs data reorientation with respect to the 5 polymorphic dimensions, width, height, depth, time, and elements. The routine takes an input data object and a mapping, defined by the src2dst_map array, which specifies how each dimension in the old object will be mapped to the new object. More than one dimension from the input object can be mapped to the same dimension in the output object.

The src2dst_map array is a set of five integers that can have one of the following values: KORIENT_WIDTH KORIENT_HEIGHT KORIENT_DEPTH KORIENT_TIME KORIENT_ELEMENTS

src2dst_map[0] defines where the WIDTH dimension of the source object will be mapped to in the destination object. src2dst_map[1] defines where the HEIGHT dimension of the source object will be mapped to in the destination object. src2dst_map[2] defines where the DEPTH dimension of the source object will be mapped to in the destination object. src2dst_map[3] defines where the TIME dimension of the source object will be mapped to in the destination object. src2dst_map[4] defines where the ELEMENTS dimension of the source object will be mapped to in the destination object.

If the source object has map data, the map data cannot have depth, time, or elements dimensions of greater than one. The map width and height dimensions can be any size.

If the source object has rectilinear or curvilinear location or time data, lkorient will fail. If the source object has uniform location data, lkorient will continue, but the location data will not be modified to reflect the reorientation.

If the object has mask data, it will be reoriented along with the value data.

lkorient will fail if the source object does not contain value data.

ADDITIONAL INFORMATION

none

EXAMPLES

none

SIDE EFFECTS

none

RESTRICTIONS

none

MODIFICATION

none

FILES

$DATAMANIP/objects/library/kdatamanip/src/lkorient.c

SEE ALSO

kdatamanip(3)

COPYRIGHT

Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.