Description
Calculate sampled-duration support within a caller-declared diurnal phase.
A phase-specific sample-coverage share uses time inside the declared phase as its denominator. Availability within that phase differs from coverage of the full recording or representativeness of hormone measurements.
Calculate sampled-duration support within a caller-declared diurnal phase.
When to use this tool
Use Diurnal Sampling Exposure Share when checking duration support inside a supplied phase mask.
How to use the tool and how it works
- Enter durations, inDeclaredPhase, sampleAvailable. 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 phaseDuration, sampledPhaseDuration, share, defined. Inspect defined before interpreting the associated values.
Require equally long durations, inDeclaredPhase and sampleAvailable arrays and nonnegative durations. phaseDuration sums declared-phase records; sampledPhaseDuration also requires availability. share divides the latter by phaseDuration, or returns zero and defined = false when the denominator is zero.1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| durations | Durations | Required. Array of finite number; minimum 0; maximum items 256. |
| inDeclaredPhase | In Declared Phase | Required. Array of boolean; maximum items 256. |
| sampleAvailable | Sample Available | Required. Array of boolean; maximum items 256. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| phaseDuration | Phase Duration | Required. Finite number. |
| sampledPhaseDuration | Sampled Phase Duration | Required. Finite number. |
| share | Dimensionless selected contribution divided by the stated total; not percent. | Required. Finite number. |
| defined | Whether the stated denominator has positive support; read this before interpreting a zero placeholder. | Required. Boolean. |
{
"input": {
"durations": [
2,
3,
5
],
"inDeclaredPhase": [
true,
true,
false
],
"sampleAvailable": [
true,
false,
true
]
},
"output": {
"phaseDuration": 5,
"sampledPhaseDuration": 2,
"share": 0.4,
"defined": true
}
}Limitations and assumptions
- This measures duration support inside the supplied phase mask. It does not estimate circadian biology, assay reliability or representativeness of missing samples.
- 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. Numeric signed-zero results are exported as zero.
Alternative or Complementary methods
Inspect the sampling schedule and missingness pattern before interpreting a phase-specific sample set.
References
Similar or alternative tools
- Canal Outline Support Share
Calculate scale-supported outlined length relative to the supplied canal outline.
- Item Observation Support Share
applicableWeight sums applicable items; observedWeight additionally requires observed.