Skip to content

Commit 8af5b3a

Browse files
committed
Update documentation
1 parent ab7216e commit 8af5b3a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+1136
-295
lines changed

docs/annotation.AnnotationGroup.html

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,7 @@ <h6>Properties</h6>
402402

403403
<dt class="tag-source">Source:</dt>
404404
<dd class="tag-source"><ul class="dummy"><li>
405-
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line17">line 17</a>
405+
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line14">line 14</a>
406406
</li></ul></dd>
407407

408408

@@ -506,7 +506,7 @@ <h5>Type:</h5>
506506

507507
<dt class="tag-source">Source:</dt>
508508
<dd class="tag-source"><ul class="dummy"><li>
509-
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line129">line 129</a>
509+
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line126">line 126</a>
510510
</li></ul></dd>
511511

512512

@@ -578,7 +578,7 @@ <h5>Type:</h5>
578578

579579
<dt class="tag-source">Source:</dt>
580580
<dd class="tag-source"><ul class="dummy"><li>
581-
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line138">line 138</a>
581+
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line135">line 135</a>
582582
</li></ul></dd>
583583

584584

@@ -650,7 +650,7 @@ <h5>Type:</h5>
650650

651651
<dt class="tag-source">Source:</dt>
652652
<dd class="tag-source"><ul class="dummy"><li>
653-
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line120">line 120</a>
653+
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line117">line 117</a>
654654
</li></ul></dd>
655655

656656

@@ -722,7 +722,7 @@ <h5>Type:</h5>
722722

723723
<dt class="tag-source">Source:</dt>
724724
<dd class="tag-source"><ul class="dummy"><li>
725-
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line111">line 111</a>
725+
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line108">line 108</a>
726726
</li></ul></dd>
727727

728728

@@ -794,7 +794,7 @@ <h5>Type:</h5>
794794

795795
<dt class="tag-source">Source:</dt>
796796
<dd class="tag-source"><ul class="dummy"><li>
797-
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line147">line 147</a>
797+
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line144">line 144</a>
798798
</li></ul></dd>
799799

800800

@@ -866,7 +866,7 @@ <h5>Type:</h5>
866866

867867
<dt class="tag-source">Source:</dt>
868868
<dd class="tag-source"><ul class="dummy"><li>
869-
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line156">line 156</a>
869+
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line153">line 153</a>
870870
</li></ul></dd>
871871

872872

@@ -938,7 +938,7 @@ <h5>Type:</h5>
938938

939939
<dt class="tag-source">Source:</dt>
940940
<dd class="tag-source"><ul class="dummy"><li>
941-
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line174">line 174</a>
941+
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line171">line 171</a>
942942
</li></ul></dd>
943943

944944

@@ -1010,7 +1010,7 @@ <h5>Type:</h5>
10101010

10111011
<dt class="tag-source">Source:</dt>
10121012
<dd class="tag-source"><ul class="dummy"><li>
1013-
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line183">line 183</a>
1013+
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line180">line 180</a>
10141014
</li></ul></dd>
10151015

10161016

@@ -1082,7 +1082,7 @@ <h5>Type:</h5>
10821082

10831083
<dt class="tag-source">Source:</dt>
10841084
<dd class="tag-source"><ul class="dummy"><li>
1085-
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line165">line 165</a>
1085+
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line162">line 162</a>
10861086
</li></ul></dd>
10871087

10881088

@@ -1154,7 +1154,7 @@ <h5>Type:</h5>
11541154

11551155
<dt class="tag-source">Source:</dt>
11561156
<dd class="tag-source"><ul class="dummy"><li>
1157-
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line102">line 102</a>
1157+
<a href="annotation.js.html">annotation.js</a>, <a href="annotation.js.html#line99">line 99</a>
11581158
</li></ul></dd>
11591159

11601160

@@ -1194,7 +1194,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="annota
11941194
<br class="clear">
11951195

11961196
<footer>
1197-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 05 2022 22:09:47 GMT-0400 (Eastern Daylight Time)
1197+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 12 2022 22:55:18 GMT-0400 (Eastern Daylight Time)
11981198
</footer>
11991199

12001200
<script> prettyPrint(); </script>

docs/annotation.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="annota
131131
<br class="clear">
132132

133133
<footer>
134-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 05 2022 22:09:47 GMT-0400 (Eastern Daylight Time)
134+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 12 2022 22:55:18 GMT-0400 (Eastern Daylight Time)
135135
</footer>
136136

137137
<script> prettyPrint(); </script>

docs/annotation.js.html

Lines changed: 72 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,7 @@ <h1 class="page-title">Source: annotation.js</h1>
2626

2727
<section>
2828
<article>
29-
<pre class="prettyprint source linenums"><code>import {
30-
_fetchBulkdata,
31-
getContentItemNameCodedConcept
32-
} from './utils.js'
29+
<pre class="prettyprint source linenums"><code>import { _fetchBulkdata } from './utils.js'
3330

3431
const _attrs = Symbol('attrs')
3532

@@ -242,11 +239,13 @@ <h1 class="page-title">Source: annotation.js</h1>
242239
)
243240
} else {
244241
if ('PointCoordinatesData' in bulkdataItem) {
242+
console.info(`fetch point coordinate data of annotation group "${uid}"`)
245243
return await _fetchBulkdata({
246244
client,
247245
reference: bulkdataItem.PointCoordinatesData
248246
})
249247
} else if ('DoublePointCoordinatesData' in bulkdataItem) {
248+
console.info(`fetch point coordinate data of annotation group "${uid}"`)
250249
return await _fetchBulkdata({
251250
client,
252251
reference: bulkdataItem.DoublePointCoordinatesData
@@ -294,6 +293,7 @@ <h1 class="page-title">Source: annotation.js</h1>
294293
}
295294
} else {
296295
if ('LongPrimitivePointIndexList' in bulkdataItem) {
296+
console.info(`fetch point index list of annotation group "${uid}"`)
297297
return await _fetchBulkdata({
298298
client,
299299
reference: bulkdataItem.LongPrimitivePointIndexList
@@ -352,6 +352,11 @@ <h1 class="page-title">Source: annotation.js</h1>
352352
measurementBulkdataItem.MeasurementValuesSequence[0]
353353
)
354354
if ('FloatingPointValues' in valuesBulkdataItem) {
355+
const nameItem = measurementMetadataItem.ConceptNameCodeSequence[0]
356+
const name = nameItem.CodeMeaning
357+
console.info(
358+
`fetch measurement values for measurement #${index} "${name}"`
359+
)
355360
return await _fetchBulkdata({
356361
client,
357362
reference: valuesBulkdataItem.FloatingPointValues
@@ -408,6 +413,11 @@ <h1 class="page-title">Source: annotation.js</h1>
408413
.MeasurementValuesSequence[0]
409414
)
410415
if ('AnnotationIndexList' in valuesBulkdataItem) {
416+
const nameItem = measurementMetadataItem.ConceptNameCodeSequence[0]
417+
const name = nameItem.CodeMeaning
418+
console.info(
419+
`fetch measurement indices for measurement #${index} "${name}"`
420+
)
411421
return await _fetchBulkdata({
412422
client,
413423
reference: valuesBulkdataItem.AnnotationIndexList
@@ -420,7 +430,7 @@ <h1 class="page-title">Source: annotation.js</h1>
420430
}
421431

422432
/**
423-
* Fetch measurements of an annotation group.
433+
* Fetch all measurements of an annotation group.
424434
*
425435
* @param {object} options
426436
* @param {object} options.metadataItem - Metadata of Annotation Group Sequence item
@@ -440,7 +450,8 @@ <h1 class="page-title">Source: annotation.js</h1>
440450
if (metadataItem.MeasurementsSequence !== undefined) {
441451
for (let i = 0; i &lt; metadataItem.MeasurementsSequence.length; i++) {
442452
const item = metadataItem.MeasurementsSequence[i]
443-
const name = getContentItemNameCodedConcept(item)
453+
const name = item.ConceptNameCodeSequence[0]
454+
const unit = item.MeasurementUnitsCodeSequence[0]
444455
const values = await _fetchMeasurementValues({
445456
metadataItem,
446457
bulkdataItem,
@@ -455,6 +466,7 @@ <h1 class="page-title">Source: annotation.js</h1>
455466
})
456467
measurements.push({
457468
name,
469+
unit,
458470
values,
459471
indices
460472
})
@@ -463,6 +475,58 @@ <h1 class="page-title">Source: annotation.js</h1>
463475
return measurements
464476
}
465477

478+
/**
479+
* Fetch an individual measurement of an annotation group.
480+
*
481+
* @param {object} options
482+
* @param {object} options.metadataItem - Metadata of Annotation Group Sequence item
483+
* @param {object} options.bulkdataItem - Bulkdata of Annotation Group Sequence item
484+
* @param {object} options.index - Index of the Measurements Sequence item
485+
* @param {object} options.client - DICOMweb client
486+
*
487+
* @returns {Promise&lt;Array&lt;object>>} Name, values, and indices of measurements
488+
*
489+
* @private
490+
*/
491+
async function _fetchMeasurement ({
492+
metadataItem,
493+
bulkdataItem,
494+
index,
495+
client
496+
}) {
497+
if (metadataItem.MeasurementsSequence == null) {
498+
throw new Error(
499+
'Measurements Sequence element is not contained in metadata.'
500+
)
501+
}
502+
if (metadataItem.MeasurementsSequence.length === 0) {
503+
throw new Error(
504+
'Measurements Sequence element in empty.'
505+
)
506+
}
507+
const item = metadataItem.MeasurementsSequence[index]
508+
if (item == null) {
509+
throw new Error(
510+
`Measurements Sequence does not contain an item #${index}.`
511+
)
512+
}
513+
const name = item.ConceptNameCodeSequence[0]
514+
const unit = item.MeasurementUnitsCodeSequence[0]
515+
const values = await _fetchMeasurementValues({
516+
metadataItem,
517+
bulkdataItem,
518+
index,
519+
client
520+
})
521+
const indices = await _fetchMeasurementIndices({
522+
metadataItem,
523+
bulkdataItem,
524+
index,
525+
client
526+
})
527+
return { name, unit, values, indices }
528+
}
529+
466530
/**
467531
* Get dimensionality of coordinates.
468532
*
@@ -753,6 +817,7 @@ <h1 class="page-title">Source: annotation.js</h1>
753817
_fetchGraphicData,
754818
_fetchGraphicIndex,
755819
_fetchMeasurements,
820+
_fetchMeasurement,
756821
_getCentroid,
757822
_getCommonZCoordinate,
758823
_getCoordinateDimensionality
@@ -773,7 +838,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="annota
773838
<br class="clear">
774839

775840
<footer>
776-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 05 2022 22:09:47 GMT-0400 (Eastern Daylight Time)
841+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 12 2022 22:55:18 GMT-0400 (Eastern Daylight Time)
777842
</footer>
778843

779844
<script> prettyPrint(); </script>

docs/annotations__AnnotationManager.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="annota
230230
<br class="clear">
231231

232232
<footer>
233-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 05 2022 22:09:47 GMT-0400 (Eastern Daylight Time)
233+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 12 2022 22:55:18 GMT-0400 (Eastern Daylight Time)
234234
</footer>
235235

236236
<script> prettyPrint(); </script>

docs/annotations_markups__MarkupManager.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -567,7 +567,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="annota
567567
<br class="clear">
568568

569569
<footer>
570-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 05 2022 22:09:47 GMT-0400 (Eastern Daylight Time)
570+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 12 2022 22:55:18 GMT-0400 (Eastern Daylight Time)
571571
</footer>
572572

573573
<script> prettyPrint(); </script>

docs/api.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="annota
125125
<br class="clear">
126126

127127
<footer>
128-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 05 2022 22:09:47 GMT-0400 (Eastern Daylight Time)
128+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 12 2022 22:55:18 GMT-0400 (Eastern Daylight Time)
129129
</footer>
130130

131131
<script> prettyPrint(); </script>

docs/color.PaletteColorLookupTable.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -707,7 +707,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="annota
707707
<br class="clear">
708708

709709
<footer>
710-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 05 2022 22:09:47 GMT-0400 (Eastern Daylight Time)
710+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 12 2022 22:55:18 GMT-0400 (Eastern Daylight Time)
711711
</footer>
712712

713713
<script> prettyPrint(); </script>

docs/color.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -662,7 +662,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="annota
662662
<br class="clear">
663663

664664
<footer>
665-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 05 2022 22:09:47 GMT-0400 (Eastern Daylight Time)
665+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 12 2022 22:55:18 GMT-0400 (Eastern Daylight Time)
666666
</footer>
667667

668668
<script> prettyPrint(); </script>

docs/color.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -462,7 +462,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="annota
462462
<br class="clear">
463463

464464
<footer>
465-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 05 2022 22:09:47 GMT-0400 (Eastern Daylight Time)
465+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 12 2022 22:55:18 GMT-0400 (Eastern Daylight Time)
466466
</footer>
467467

468468
<script> prettyPrint(); </script>

docs/dicom-microscopy-viewer.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="annota
238238
<br class="clear">
239239

240240
<footer>
241-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 05 2022 22:09:47 GMT-0400 (Eastern Daylight Time)
241+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 12 2022 22:55:18 GMT-0400 (Eastern Daylight Time)
242242
</footer>
243243

244244
<script> prettyPrint(); </script>

0 commit comments

Comments
 (0)