ZVALTRNS

Transfer z-values


EnvironmentsPYTHON :: EASI :: MODELER
Batch ModeYes
Quick linksDescription :: Parameters :: Parameter descriptions :: Details

Back to top

Description


Transfers the z-values of an input vector segment from a shape to its attribute, or from an attribute to its shape. If you have a z-value as an attribute for a shape on an Unstructured, Line, Point, Whole Polygon, or Topological Line vector layer, you can transfer that value to the shape's vertices. Conversely, you can also convert the Z-values from the shape's vertices into an attribute.
Back to top

Parameters


Name Type Length Value range
Input: Input vector segment * Vector port 1 - 1  
Output: Output vector segment Vector port 0 - 1  
Transfer Direction String 0 - 1 SHPTOATTR | ATTRTOSHP
Default: SHPTOATTR
Destination Field String 0 - 1  
Type String 0 - 1 Default: INTEGER
Z-value aggregation String 0 - 1 Default: MEAN
Z-value Field String 0 - 1  
Use current selection Boolean 0 - 1  
Report String 0 - 192 See parameter description

* Required parameter
Back to top

Parameter descriptions

Input: Input vector segment

Specifies the vector segment to process.

Output: Output vector segment

Optionally specifies the output vector segment to receive the transferred result. If the specified output segment does not already exist, a new segment is created.

Transfer Direction

Specifies whether the z-value is transferred from the shape to the attribute, or from the attribute to shape vertices.

Options are:

Destination Field

Specifies the name of the destination field to receive the z-value from the shape vertices.

The field can be any existing numeric field or a non-existing field which will be created.

This parameter is used only when the transfer direction (ZTRNSDIR) is set to 'Shape to attribute' (SHPTOATTR).

Type

Specifies the data type to apply if a new field is created for the destination field.

Supported data types are:

This parameter is used only when a new destination field is created (ZTRNSFLD="newfieldname"). If the destination field already exists, the data type of the existing field is maintained.

Z-value aggregation

Specifies the method used to combine z-values of shapes.

Available options are:

Z-value Field

Specifies the numeric attribute field to supply the z-value to update the shape vertices.

This parameter is used only when the transfer direction (ZTRNSDIR) is 'Attribute to shape' (ATTRTOSHP).

Use current selection

Specifies whether to use the current selection to apply the transfer.

Report

Specifies where to direct the generated report.

Available options are:

Back to top

Details

ZVALTRANS is used to transfer the z-value of an input vector segment from a shape to its attribute, or from an attribute to its shape.

If the transfer direction is "shape to attribute", the z-value of a shape's vertices is transferred to an existing attribute field or to a new attribute field. If the function creates a new field, the user must specify the data type of this new field.

The available data types are:

If the specified field exists, the transfer type (ZTRNSTYP) parameter is not used; instead, the z-value is converted to the data type of the existing field.

Z-values are written to the destination field in the data type defined by that field. For example, if the z-value is a real and the destination field is defined as an integer, the z-value is truncated to an integer.

Where the shape has variable z-values for its vertices, the z-value aggregation sets the method for determining what z-value will be transferred to the shapes attribute. Each shape 'destination field' can only store one value for the z-value. Aggregation options are:

If the transfer direction is from 'Attribute to shape', the attribute field must exist in the input vectorlayers attribute table. The field must be a numeric data type.

ZVALTRNS does not deal with an input layer of Topo Area or Table.

© PCI Geomatics Enterprises, Inc.®, 2026. All rights reserved.