Field operations

Typed feature metadata used by the design catalogue. Discover the connected service’s catalogue operation before composing a document; deployment availability and input combinations are validated there. These are feature IDs, not separate HTTP routes.

Combine fields

Operation: field.combine. Feature version: 1.

Outputs: result (field).

Input

Type

Required

Default

Bounds / choices

a

field

Yes

Required input

b

field

Yes

Required input

operation

enum

No

"add"

choices: add, multiply, minimum, maximum

Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.

Constant field

Operation: field.constant. Feature version: 1.

Outputs: result (field).

Input

Type

Required

Default

Bounds / choices

value

number

No

1

Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.

Coordinate field

Operation: field.coordinate. Feature version: 1.

Outputs: result (field).

Input

Type

Required

Default

Bounds / choices

axis

enum

No

"z"

choices: x, y, z

origin

length

No

0

scale

length

No

1

minimum: 1e-06

Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.

Distance to body

Operation: field.distance. Feature version: 1.

Outputs: result (field).

Input

Type

Required

Default

Bounds / choices

body

body

Yes

Required input

Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.

Evaluate field at point

Operation: field.evaluate. Feature version: 1.

Outputs: result (number).

Input

Type

Required

Default

Bounds / choices

field

field

Yes

Required input

point

vector

No

[0, 0, 0]

Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.

Evaluate field gradient

Operation: field.gradient. Feature version: 1.

Outputs: result (gradient).

Input

Type

Required

Default

Bounds / choices

field

field

Yes

Required input

point

vector

No

[0, 0, 0]

Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.

Field-driven offset

Operation: field.offset. Feature version: 1.

Outputs: result (body).

Input

Type

Required

Default

Bounds / choices

body

body

Yes

Required input

field

field

Yes

Required input

amplitude

length

No

1

minimum: 0

Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.

Scalar point-map field

Operation: field.point_map. Feature version: 1.

Outputs: result (field).

Input

Type

Required

Default

Bounds / choices

asset

string

Yes

Required input

method

enum

No

"inverse_distance"

choices: nearest, inverse_distance

Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.

Spatial ramp

Operation: field.ramp. Feature version: 1.

Outputs: result (field).

Input

Type

Required

Default

Bounds / choices

axis

enum

No

"x"

choices: x, y, z

start

length

No

-20

end

length

No

20

low

number

No

0

high

number

No

1

Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.

Remap field range

Operation: field.remap_range. Feature version: 1.

Outputs: result (field).

Input

Type

Required

Default

Bounds / choices

field

field

Yes

Required input

input_min

number

No

0

input_max

number

No

1

output_min

number

No

0

output_max

number

No

1

continuity

enum

No

"smooth"

choices: linear, smooth, smoother

Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.

Field-driven thickness

Operation: field.thicken. Feature version: 1.

Outputs: result (body).

Input

Type

Required

Default

Bounds / choices

body

body

Yes

Required input

field

field

Yes

Required input

minimum

length

No

1

minimum: 1e-06

maximum

length

No

3

minimum: 1e-06

Lengths follow the document/typed-quantity unit contract. Inspect vector, field and dimensionless inputs by their declared purpose; do not apply a blanket unit conversion to every number. Validate references and the whole document before evaluation.