.. _auto_curve_get_offset_by_slip:

*GET OFFSET DUE TO SLIP*
========================

Detects the slip-induced offset (or dominant slope) of a curve by segmenting it, fitting piecewise linear regions, and identifying the region that matches a target slope. Use this worker to correct for initial slip or seating artefacts in material test curves (e.g., load-displacement or stress-strain data) before downstream analysis.

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

Classification: **process**.

Tagged: ``curve``, ``digitize``, ``load_displacement``, ``material_test``, ``offset``, ``piecewise_linear``, ``r2``, ``segment_fit``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Curve To Be Offset
     - curvetobeoffset
     - vector
     - —
     - 
     - Input curve (e.g., load-displacement or stress-strain) for which the slip offset is to be detected; typically a 2-column X/Y vector in test-data units.
   * - Num Dig
     - num_dig
     - integer
     - 1000
     - 
     - Number of points used to re-digitize (resample) the curve before fitting; default 1000 — increase for high-resolution curves, decrease to speed up processing.
   * - Segment Length Ratio
     - segment_length_ratio
     - integer
     - 0.1
     - 
     - Fraction of the total digitized points used as the window length for each piecewise linear segment fit; default 0.1 (10 %) — smaller values detect shorter linear regions.
   * - Min R2
     - r2_limit
     - integer
     - 0.95
     - 
     - Minimum R² coefficient of determination for a segment to be accepted as a valid linear region; default 0.95 — raise toward 1.0 to require tighter fits.
   * - Merge Ratio
     - merge_ratio
     - integer
     - 0.025
     - 
     - Relative slope tolerance for merging adjacent accepted segments into a single region; default 0.025 (2.5 %) — increase to merge segments with more dissimilar slopes.
   * - Return Type
     - return_type
     - scalar
     - offset
     - 
     - Selects whether the worker returns the x-axis 'offset' (slip distance) or the dominant 'slope' of the identified linear region; default is 'offset'.
   * - Target Slope
     - target_slope
     - float
     - 210
     - 
     - Expected slope value (in curve Y/X units, e.g., GPa or N/mm) used to identify the correct linear region; default 210 (steel elastic modulus in GPa) — set to the material's known stiffness.
   * - Target Percentage
     - target_percentage
     - float
     - 0.05
     - 
     - Slope within this tolerance will be considered

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - curve_get_offset_by_slip_output_1
     - curve_get_offset_by_slip_output_1
     - scalar
     - Scalar value representing either the detected slip offset (x-axis shift in curve units) or the dominant slope of the identified linear region, depending on the selected return_type.

Disciplines
-----------

- data.curve.transform
- engineering.material.characterization

Runnable example
----------------

A runnable example is registered for this worker. Open the example workflow on the d3VIEW canvas: `/api/workflow/example?id=curve_get_offset_by_slip <https://www.d3view.com/api/workflow/example?id=curve_get_offset_by_slip>`_

.. raw:: html

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