Description
Mark frames complete when their full span lies within the recording, count complete and valid-complete frames, and return share over completeFrames when positive, otherwise zero with defined=false.
Voice and airflow research records use sample rates, frame windows, cycle boundaries, event clocks, unit conversions, and laterality labels. A data-support fraction or signed difference has a specific convention and denominator. These calculations operate on supplied records rather than an audio, respiratory, or vestibular examination.
Mark frames complete when their full span lies within the recording, count complete and valid-complete frames, and return share over completeFrames when positive, otherwise zero with defined=false.
When to use this tool
Use Voice Frame Support Share when you need this sample, frame, cycle, timing, airflow, or laterality component for supplied research records.
How to use the tool and how it works
- Enter frameStarts, frameDuration, recordingStart, recordingEnd, valid. Keep parallel arrays aligned. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read frames, completeFrames, validCompleteFrames, share, defined. Inspect defined before interpreting the associated values.
Require aligned frameStarts and valid flags, positive frameDuration, and recordingEnd>=recordingStart. Mark frames complete when their full span lies within the recording, count complete and valid-complete frames, and return share over completeFrames when positive, otherwise zero with defined=false.1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| frameStarts | Frame Starts | Required. Array of finite number; maximum items 256. |
| frameDuration | Frame Duration | Required. Finite number; strictly above 0. |
| recordingStart | Recording Start | Required. Finite number. |
| recordingEnd | Recording End | Required. Finite number. |
| valid | Valid | Required. Array of boolean; maximum items 256. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| frames | Frames | Required. Safe integer. |
| completeFrames | Complete Frames | Required. Safe integer. |
| validCompleteFrames | Valid Complete Frames | Required. Safe integer. |
| share | Dimensionless share under the stated denominator; not a percent numeral. | Required. Finite number. |
| defined | Whether the associated denominator or quantity is defined; read before using a zero placeholder. | Required. Boolean. |
{
"input": {
"frameStarts": [
0,
1,
2
],
"frameDuration": 1,
"recordingStart": 0,
"recordingEnd": 2,
"valid": [
true,
false,
true
]
},
"output": {
"frames": 3,
"completeFrames": 2,
"validCompleteFrames": 1,
"share": 0.5,
"defined": true
}
}Limitations and assumptions
- Time coordinates need one unit. Duplicate or overlapping frames count separately; partial frames do not enter the denominator and no audio is inspected or clinically interpreted.
- Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.
- Numeric calculations use binary floating point unless exact decimal-integer arithmetic is explicitly stated. No hidden measurement tolerance or decimal rounding is added; nonfinite or out-of-contract results are rejected. Signed zero is exported as zero.
Alternative or Complementary methods
Use calibrated acquisition and a documented signal-analysis or assessment protocol when a local conversion is insufficient. Verify sample rate, frame boundaries, clock corrections, and record annotations.
References
Similar or alternative tools
- Research Voice Frame Hop
Compute supplied research frame hop and first-to-last start span, excluding unspecified frame duration.
- Voice Cycle Boundary Phase Token
Partition supplied periodic voice-trace sample indices with explicit exact-boundary ownership.