SCALE Y VALUES BASED ON THEIR X-LOCATION¶
Applies a spatially-varying (linearly interpolated) scale factor to the y-values of a curve over a specified x-range, with optional midpoint control, an additive-offset mode, and a cap on the scaled output. Use this worker when you need to taper, ramp, or window a signal’s amplitude between two x-locations rather than applying a single global scale.
When to use¶
Classification: process.
Tagged: cap, curve, linear, offset, scale, scale-factor, taper, transform.
Inputs¶
| Label | ID | Type | Default | Required | Description |
|---|---|---|---|---|---|
| Curve To Be Scaled | curvetobescaled | vector | — | Input curve (x-y vector) whose y-values will be scaled; accepts a single curve or the first curve of a CurveGroup. | |
| X-Start | x-start | scalar | 0.0 | X-axis position at which the linearly ramping scale factor begins; default 0.0 (same units as the curve’s x-axis). | |
| X End | x_end | scalar | 0.0 | X-axis position at which the linearly ramping scale factor ends; default 0.0 (same units as the curve’s x-axis — set greater than X-Start to define a meaningful range). | |
| Y-Start SF | y-start_s_f | scalar | 1.0 | Scale factor applied to y-values at X-Start; default 1.0 (dimensionless multiplier — set to values other than 1.0 to amplify or attenuate). | |
| Y End SF | y_end_s_f | scalar | 1.0 | Scale factor applied to y-values at X-End; default 1.0 (dimensionless multiplier — the SF is linearly interpolated between Y-Start SF and Y-End SF across the x-range). | |
| Cap value | cap_end | scalar | 10000.0 | Upper bound applied to the scaled y-values; if any scaled value exceeds this limit it is clamped to it — default 10000.0 (same units as the curve’s y-axis). | |
| Use Offset | use_offset | list | — | When set to ‘yes’, applies the scale factor as an additive offset rather than a multiplicative factor; default ‘no’. | |
| X Mid | xmid | scalar | 0.0 | Optional midpoint x-location used to define a piecewise-linear (three-segment) SF ramp instead of a simple two-point ramp; leave unset for linear two-point scaling. | |
| Y Mid | ymid | scalar | 0.0 | Scale factor at the optional midpoint x-location (xmid); only used when xmid is provided. | |
| Scale Curve | scale_curve | vector | — | Optional external curve that directly supplies the scale-factor profile as a function of x, overriding the linear ramp defined by the SF parameters. |
Outputs¶
| Label | ID | Type | Description |
|---|---|---|---|
| curve_scaley_linear_output_1 | curve_scaley_linear_output_1 | vector | Resulting curve with y-values scaled according to the linearly interpolated (or externally supplied) scale-factor profile, capped at cap_end. |
Disciplines¶
- data.curve.transform
Runnable example¶
A runnable example is registered for this worker. Open the example workflow on the d3VIEW canvas: /api/workflow/example?id=curve_scaley_linear
Auto-generated from transformation schema. Worker id: curve_scaley_linear. Schema hash: 88ef9fe10961. Hand-curated docs in workerexamples/ override this page when present.