DATAMANIP commands


PROGRAM NAME

kgenloc - Generate Location Data

DESCRIPTION

kgenloc creates explicit location data in the specified destination object (-o). If an input source object is provided (-i) then any data segments in that source object will be copied to the destination object.

The explicit location data is specified by three sets of begin and end values (-xbegin, -xend), (-ybegin, -yend), (-zbegin, -zend) which together compose explicit corner markers for volume in (x,y,z) three space. The x-axis corresponds uniformly to the implicit width dimension on the polymorphic data model, with the y-axis and z-axis corresponding to implicit height, and depth dimensions, respectively.

Data is generated uniformly from those specified corner markers, however the explicitness of the generated data can be specified by the grid (-grid) option. A KUNIFORM grid will dictate that the generated data consist simply of setting the uniform corner markers on the output data set. A KRECTILINEAR grid will dictate that the generated data consist of three arrays of locations, an x-array, a y-array, and a z-array, with the data within those arrays changing uniformly over the specified (x,y,z) begin and end values. A KCURVILINEAR grid will dictate that the generated data consist of a four dimensional array of location data. Essentially, this data set is a three dimensional array of (x,y,z) points.

The size and datatype of the resulting location data segment can be specified. The size of the location segment is controlled with three parameters (-wsize, -hsize, -dsize) which correspond to the implicit width, height, and depth of the location segment. The dimension size of the destination location segment will always be three corresponding to the size of the location points (x,y,z). The data type of the location segment is controlled with a single parameter (-type).

Any size specifications will be overwritten by existing size information in the input source object. If the input source object contains any explicit location data, the size and data type of the existing location segment will be used to determine the size and data type of the destination location segment. Any explicit location data in the source object will be destroyed in favor of the newly generated data. Additionally, if the input source object contains no explicit location segment but does contain a value segment or a mask segment, the width, height, and depth size of either of those segments will be used to set the width, height, and depth size of the destination location segment.

REQUIRED ARGUMENTS

-o
type: outfile
desc: Resulting output data object

OPTIONAL ARGUMENTS

-i
type: infile
desc: First Input data object
default: {none}
-xbegin
type: double
desc: Explicit Location Begin for X dimension
default: 0
bounds: no range checking
-xend
type: double
desc: Explicit Location End for X dimension
default: 1
bounds: no range checking
-ybegin
type: double
desc: Explicit Location Begin for Y dimension
default: 0
bounds: no range checking
-yend
type: double
desc: Explicit Location End for Y dimension
default: 1
bounds: no range checking
-zbegin
type: double
desc: Explicit Location Begin for Z dimension
default: 0
bounds: no range checking
-zend
type: double
desc: Explicit Location End for Z dimension
default: 1
bounds: no range checking
-grid
type: integer toggle
desc: Grid Type to use when creating Location Data
default: 1
allowed values:
-wsize
type: integer
desc: Width of location data
default: 512
bounds: value > 0
-hsize
type: integer
desc: Height of location data
default: 512
bounds: value > 0
-dsize
type: integer
desc: Depth of location data
default: 1
bounds: value > 0
-type
type: list
desc: Data type of location data
default: 10 "float"

EXAMPLES

SEE ALSO

ksetdattr

RESTRICTIONS

The data is generated and stored as one block, so generating large location data sets are subject to the memory limitations of your machine.

REFERENCES

COPYRIGHT

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