.. _auto_curves_scaley_linear:

*SCALE Y VALUES BASED ON THEIR X-LOCATION*
==========================================

Applies a position-dependent (linear) scale factor to the y-values of one or more curves, ramping the scale factor from a user-defined start value to an end value across a specified x-range. Use this worker when you need to taper, amplify, or cap curve amplitudes as a linear function of x-location — for example, corridor shaping or load-ramp adjustments.

When to use
-----------

Classification: **process**.

Tagged: ``cap``, ``curve-transform``, ``linear-ramp``, ``offset``, ``scale``, ``scale-factor``, ``x-range``, ``y-scale``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Curve To Be Scaled
     - curvestobescaled
     - vector
     - —
     - 
     - One or more input curves whose y-values will be scaled; accepts a vector (curve group) — leave empty if curves are piped from an upstream worker.
   * - X-Start
     - x-start
     - scalar
     - 0.0
     - 
     - X-axis value at which the linear scaling ramp begins; default 0.0 (same units as the curve x-axis).
   * - X End
     - x_end
     - scalar
     - 0.0
     - 
     - X-axis value at which the linear scaling ramp ends; default 0.0 — set this to a value greater than X-Start to define a meaningful ramp window.
   * - Y-Start SF
     - y-start_s_f
     - scalar
     - 1.0
     - 
     - Scale factor applied to y-values at X-Start; default 1.0 (no scaling at the ramp start).
   * - Y End SF
     - y_end_s_f
     - scalar
     - 1.0
     - 
     - Scale factor applied to y-values at X-End; default 1.0 (no scaling at the ramp end) — set different from Y-Start SF to create a non-trivial ramp.
   * - Cap value to this number
     - cap_y
     - scalar
     - 10000
     - 
     - Upper bound applied to all scaled y-values after the ramp is applied; any scaled value exceeding this limit is clamped to it — default 10000 (effectively no cap for most engineering curves).
   * - Use Offset
     - use_offset
     - list
     - —
     - 
     - Select 'Yes' to add an offset instead of (or in addition to) multiplication when applying the scale factor; default 'No' (pure multiplicative scaling).
   * - X Mid
     - xmid
     - scalar
     - 0.0
     - 
     - X of mid point. Only used if non-zero
   * - Y Mid
     - ymid
     - scalar
     - 0.0
     - 
     - Y of mid point. Only used if non-zero
   * - Scale Curve
     - scale_curve
     - vector
     - —
     - 
     - A curve can be provided. If provided, the start,mid,end points will be ignored

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - curves_scaley_linear_output_1
     - curves_scaley_linear_output_1
     - vector
     - Transformed curve group with y-values linearly scaled (and optionally capped) according to the specified x-range and scale-factor ramp.

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=curves_scaley_linear <https://www.d3view.com/api/workflow/example?id=curves_scaley_linear>`_

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>transformation</code> schema. Worker id: <code>curves_scaley_linear</code>. Schema hash: <code>b70ad1030c22</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>