DATAMANIP commands


PROGRAM NAME

ksetdattr - Modify Data Object Attributes

DESCRIPTION

The Set Data Attribute operator allows the user to modify a subset of the Input (i) data object attributes, and store the result to the Output (o). The following data attributes can be modified by this program.

Data Object Mask Attributes:

Present Masked Data Values As... This attribute has two possible settings: Actual Value and Substitute Value. When datamanip processing routines operate on value data that has a corresponding validity mask, processing speed is increased by not checking the mask value for each point to gate the operation based on that value. Rather, all value data, valid or invalid, is processed, and the mask, after any necessary modifications, is transferred to the output. For certain operations, data marked as invalid may cause mathematical or range errors. Setting the Present Masked Data Values attribute to Substitute Value allows alternate values (real, imaginary pair) to be substituted in place of the invalid data for the operation. Setting the attribute to Actual Value will allow the processing routines to operate on the invalid data values.

Substitution Value for Masked Data If Present Masked Data Values is set to Substitute Value, the values used in the substitution, Real Substitution Value and Imaginary Substitution Value can be explicitly set. If they are not set, the default value is (1,0).

Data Convolution Kernel Attributes:

Kernel Origin Coordinates This attribute allows you to specify a hot spot in the data set that is interpreted as the center point of a 5 dimensional convolution kernel. When setting this attribute, you must specify the coordinate of the kernel origin which is a 5-tuple comprised of (w,h,d,t,e).

Data Object Uniform Location Data Attributes:

Begin The Location Begin attribute specifies the explicit coordinate of the data set that represents the implicit origin of the data model. When set, explicit uniform location data will be created on the data object. If explicit rectilinear or curvilinear location data already exists on the input, it will be destroyed. Warning - if the begin for any dimension is set using this program, the begin for all dimensions must be set (or the default value of 0 will be applied to unspecified dimensions).

End The Location End attribute specifies the explicit coordinate of the data set that represents the implicit end of the data model. When set, explicit uniform location data will be created on the data object. If explicit rectilinear or curvilinear location data already exists on the input, it will be destroyed. Warning - if the end for any dimension is set using this program, the end for all dimensions must be set (or the default value of 0 will be applied to unspecified dimensions).

Data Object Sub-Object Position The Sub-Object Position attribute is the offset of the current data object in a parent object. Typically, the value of this attribute will be (0,0,0,0,0), but if this object was extracted from a "parent object", via kextract or other means, then this attribute will indicate the position in the parent object from which this region was extracted. Programs like kinsert can use this attribute to reinsert the subobject in the parent object. Warning - if the sub-object position for any dimension is set using this program, the sub-object position for all dimensions must be set (or the default value of 0 will be applied to unspecified dimensions).

Data Object Point Size The Point Size attribute indicates the physical dimension in world coordinates of points in the data object. Unless explicitly set, the data object Point Size is (1,1,1,1,1). Warning - if the point size for any dimension is set using this program, the size for all dimensions must be set (or the default value of 1 will be applied to unspecified dimensions).

Color Attributes: The Colorspace and Has Alpha attributes can be modified for color interpretation and visualization. For more information on these attributes and their settings, see the help page for Change Colorspace operator (kman icolorspace), and refer to Programming Services, Volume II, Chapter 4, Color Services.

Other attributes that require modification of the data as well as the attribute value, such as data type and size, are better set using other programs such as the conversion operators (kconvert, kscale, etc.), and the resize operators (kresample, kextract, etc.).

REQUIRED ARGUMENTS

-i
type: infile
desc: First Input data object
-o
type: outfile
desc: Resulting output data object

OPTIONAL ARGUMENTS

-maskpres
type: list
desc: Set the KPDS_MASKED_VALUE_PRESENTATION attribute
default: 0 "Actual Value"
-wkernel
type: integer
desc: integer
default: 0
bounds: no range checking
-tkernel
type: integer
desc: integer
default: 0
bounds: no range checking
-hkernel
type: integer
desc: integer
default: 0
bounds: no range checking
-ekernel
type: integer
desc: integer
default: 0
bounds: no range checking
-dkernel
type: integer
desc: integer
default: 0
bounds: no range checking
-xbegin
type: double
desc: Explicit Location Begin for width dimension
default: 0
bounds: no range checking
-xend
type: double
desc: Explicit Location End for width dimension
default: 1
bounds: no range checking
-ybegin
type: double
desc: Explicit Location Begin for height dimension
default: 0
bounds: no range checking
-yend
type: double
desc: Explicit Location End for height dimension
default: 1
bounds: no range checking
-zbegin
type: double
desc: Explicit Location Begin for depth dimension
default: 0
bounds: no range checking
-zend
type: double
desc: Explicit Location End for depth dimension
default: 1
bounds: no range checking
-wpos
type: integer
desc: Sub-object width position with respect to parent object
default: 0
bounds: no range checking
-wpsize
type: double
desc: World coordinate point size in width dimension
default: 1
bounds: value > 0.0
-hpos
type: integer
desc: Sub-object height position with respect to parent object
default: 0
bounds: no range checking
-hpsize
type: double
desc: World coordinate point size in height dimension
default: 1
bounds: value > 0.0
-dpos
type: integer
desc: Sub-object depth position with respect to parent object
default: 0
bounds: no range checking
-dpsize
type: double
desc: World coordinate point size in depth dimension
default: 1
bounds: value > 0.0
-tpos
type: integer
desc: Sub-object time position with respect to parent object
default: 0
bounds: no range checking
-tpsize
type: double
desc: World coordinate point size in time dimension
default: 1
bounds: value > 0.0
-epos
type: integer
desc: Sub-object elements position with respect to parent object
default: 0
bounds: no range checking
-epsize
type: double
desc: World coordinate point size in elements dimension
default: 1
bounds: value > 0.0
-cspace
type: list
desc: Set the KCOLOR_COLORSPACE attribute
default: 3 "CMY"
-alpha
type: list
desc: Set the KCOLOR_HAS_ALPHA attribute
default: 0 "FALSE"

Group; specify AT LEAST ONE of:

-rmasksub
type: double
desc: Set the real component of the KPDS_MASK_SUBSTITUTE_VALUE attribute
default: 0
bounds: no range checking
AND/OR
-imasksub
type: double
desc: Set the imaginary component of the KPDS_MASK_SUBSTITUTE_VALUE attribute
default: 0
bounds: no range checking

EXAMPLES

SEE ALSO

RESTRICTIONS

REFERENCES

COPYRIGHT

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