DATAMANIP commands
PROGRAM NAME
ktranslate - Translate Data in Object
DESCRIPTION
The Translate operator, ktranslate, performs the translation of a
data object using the pad values defined by the Real and Imaginary padding
value options. The (0,0,0,0,0) point of the input data will be translated
to the position specified by the translation offset values. Values that
are translated outside of the original data space are truncated. Wrapping
is currently not supported, but will be provided in the future.
Size
The output data object will be the same as the input data size.
Pad Values
The Real Pad Value (real) specifies the pad value that will be assigned
to the real component of a complex pair, and the Imaginary Pad Value
(imag) specifies the imaginary component of the pair.
If the input data object type is not complex, the imaginary pad value
will be ignored. For input data objects that are not of type double,
the specified pad values are cast to the same type as the input data object.
Wrapping
The regions outside the original data bounds can be filled also by wrapping
data from the opposite side of the dataset by specifying the Wrap flag.
This will override the Pad Value functionality.
Mask Data & Validity Option
The validity mask corresponding to padded data will be zero if
the user specifies that padded data added by this program be marked
as invalid (valid FALSE). Likewise, if the user specifies that padded
data is valid (valid TRUE), the mask corresponding to padded data will
be non-zero. In the first case (invalid), if no mask exists in the
source object, on will be created. In the valid case, no mask will be
created. Validity mask data corresponding to the original source object
data is transferred to the destination unaltered.
Location & Time Data
If curvilinear or rectilinear time or location data
exist, it is unclear how to alter the dimensionality,
so the operation will fail. If uniform location data exist
translation occurs, but the location information is not altered in
any way.
Map Data
The translate operator does not modify map data.
Failure Modes
The input object must contain value or mask data.
Executing Translate runs the program kpad with offsets specified.
REQUIRED ARGUMENTS
- -i
-
type: infile
desc: Input data file
- -o
-
type: outfile
desc: Resulting output file
OPTIONAL ARGUMENTS
- -woff
-
type: integer
desc: Translate data in width dimension by this amount
default: 0
bounds: no range checking
- -hoff
-
type: integer
desc: Translate data in height dimension by this amount
default: 0
bounds: no range checking
- -doff
-
type: integer
desc: Translate data in depth dimension by this amount
default: 0
bounds: no range checking
- -toff
-
type: integer
desc: Translate data in time dimension by this amount
default: 0
bounds: no range checking
- -eoff
-
type: integer
desc: Translate data in elements dimension by this amount
default: 0
bounds: no range checking
- -real
-
type: double
desc: Real part of pad constant
default: 0
bounds: no range checking
- -imag
-
type: double
desc: Imaginary part of pad constant
default: 0
bounds: no range checking
- -wrap
-
type: flag
desc: fill outside data regions by WRAPPING
- -valid
-
type: boolean
desc: Identify data added by program as valid/invalid in mask
default: true
EXAMPLES
SEE ALSO
DATAMANIP::kpad
RESTRICTIONS
The translate operator will fail if the source object contains curvilinear
or rectilinear location or time data. If uniform time or location data
exist, it is transferred, but not modified.
Wrapping is not supported at this time.
REFERENCES
COPYRIGHT
Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.