COMPUTES CURVE MATCH WITH PHYSIAL TEST¶
Computes the curve-match distance between every simulation or test in a study and a selected physical-test reference curve. Supported metrics include Euclidean distance, Fréchet, and Dynamic Time Warping (DTW); results are stored as a new response on each study member. Use this worker to quantify sim-vs-test correlation across an entire study in one step.
When to use¶
Tagged: correlation, curve_match, dtw, euclidean, frechet, physical_test, sim_vs_test, study.
Inputs¶
| Label | ID | Type | Default | Required | Description |
|---|---|---|---|---|---|
| IOTS | study_id | remote_lookup | — | ✓ | Platform ID of the study whose simulations/tests will each be compared against the physical-test reference curve; resolved via the /api/user/studies remote lookup. |
| IOTP | physicaltest_id | remote_lookup | — | ✓ | Platform ID of the physical test that provides the reference (baseline) curve for the match computation; resolved via the /api/user/physicaltests remote lookup. |
| Baseline Response Name | response_name | text | — | ✓ | Name of the existing response (channel) on the physical test to use as the baseline curve for the distance calculation. |
| New Response Name | new_response_name | text | — | ✓ | Name under which the computed curve-match score will be saved as a new response on each study member. |
| Match Type | match_type | list | — | ✓ | Distance metric to use: ‘euclidean-distance’ for L2 norm, ‘frechet’ for Fréchet distance, or ‘dtw’ for Dynamic Time Warping. |
| XMIN | xmin | text | -1e20 | ✓ | Lower x-axis bound for the comparison window (same units as the curve x-axis); defaults to -1e20 (no lower clipping). |
| XMax | xmax | text | 1e20 | ✓ | Upper x-axis bound for the comparison window (same units as the curve x-axis); defaults to 1e20 (no upper clipping). |
| NODP | ndig | text | 1e20 | ✓ | Number of digitized (resampled) points used when aligning the two curves before computing the distance; defaults to 1e20 (use all available points). |
| Normalize | normalize | text | yes | ✓ | Whether to normalize both curves to [0, 1] before computing the distance metric (‘yes’ recommended when curves have different amplitudes; default ‘yes’). |
| Auto Save | auto_save | text | yes | ✓ | Whether to automatically persist the computed match score as a new response in the platform (‘yes’ to save immediately; default ‘yes’). |
Outputs¶
| Label | ID | Type | Description |
|---|---|---|---|
| Study Id | study_id | integer | Integer platform ID of the study that was processed, passed through for downstream chaining. |
| Errors | errors | dataset | Dataset listing any study members for which the curve-match computation failed, including error messages; empty if all comparisons succeeded. |
| Pt Response | pt_response | vector | Vector representation of the physical-test reference curve (baseline response) used in the match, returned for audit and downstream use. |
Disciplines¶
- cae.postprocessing.response
- data.correlation
- data.curve.pair
- data.dataset.ingest
Auto-generated from platform schema. Worker id: study_compute_curve_match_with_physicaltest. Schema hash: fd2c8745a9fb. Hand-curated docs in workerexamples/ override this page when present.