@@ -33,23 +33,25 @@ <h1 class="page-title">Source: annotation.js</h1>
3333
3434const _attrs = Symbol('attrs')
3535
36- /** An annotation group.
36+ /**
37+ * Annotation Group.
38+ *
39+ * Describes an item of the Annotation Group Sequence of a DICOM Microscopy Bulk
40+ * Simple Annotations instance.
3741 *
3842 * @class
3943 * @memberof annotation
4044 */
4145class AnnotationGroup {
4246 /**
43- * Create a new Annotation Group object.
44- *
45- * @param {Object} options - Options for construction of Annotation Group
46- * @param {string} options.uid - Unique tracking identifier
47+ * @param {Object} options - Options
48+ * @param {string} options.uid - Annotation Group UID
4749 * @param {number} options.number - Annotation Group Number (one-based index value)
4850 * @param {string} options.label - Annotation Group Label
4951 * @param {string} options.algorithmName - Annotation Group Algorithm Name
50- * @param {object } options.algorithmType - Annotation Group Algorithm Type
51- * @param {object } options.propertyCategory - Annotation Property Category Code
52- * @param {object } options.propertyType - Annotation Property Type Code
52+ * @param {Object } options.algorithmType - Annotation Group Algorithm Type
53+ * @param {Object } options.propertyCategory - Annotation Property Category Code
54+ * @param {Object } options.propertyType - Annotation Property Type Code
5355 * @param {string} options.studyInstanceUID - Study Instance UID of Annotation instances
5456 * @param {string} options.seriesInstanceUID - Series Instance UID of Annotation instances
5557 * @param {string[]} options.sopInstanceUIDs - SOP Instance UIDs of Annotation instances
@@ -117,83 +119,94 @@ <h1 class="page-title">Source: annotation.js</h1>
117119 throw new Error('SOP Instance UIDs are required.')
118120 }
119121 this[_attrs].sopInstanceUIDs = sopInstanceUIDs
122+ Object.freeze(this)
120123 }
121124
122- /** Get Annotation Group UID
125+ /**
126+ * Annotation Group UID
123127 *
124- * @returns { string} Annotation Group UID
128+ * @type string
125129 */
126130 get uid () {
127131 return this[_attrs].uid
128132 }
129133
130- /** Get Annotation Group Number.
134+ /**
135+ * Annotation Group Number.
131136 *
132- * @returns { number} Annotation Group Number
137+ * @type number
133138 */
134139 get number () {
135140 return this[_attrs].number
136141 }
137142
138- /** Get Annotation Group Label
143+ /**
144+ * Annotation Group Label
139145 *
140- * @returns { string} Annotation Group Label
146+ * @type string
141147 */
142148 get label () {
143149 return this[_attrs].label
144150 }
145151
146- /** Get Segment Algorithm Name
152+ /**
153+ * Annotation Group Algorithm Identification
147154 *
148- * @returns { string} Segment Algorithm Name
155+ * @type string
149156 */
150157 get algorithmName () {
151158 return this[_attrs].algorithmName
152159 }
153160
154- /** Get Annotation Group Generation Type
161+ /**
162+ * Annotation Group Generation Type
155163 *
156- * @returns {object} Annotation Group Generation Type
164+ * @type Object
157165 */
158166 get algorithmType () {
159167 return this[_attrs].algorithmType
160168 }
161169
162- /** Get Annotation Property Category
170+ /**
171+ * Annotation Property Category
163172 *
164- * @returns {object} Annotation Property Category
173+ * @type Object
165174 */
166175 get propertyCategory () {
167176 return this[_attrs].propertyCategory
168177 }
169178
170- /** Get Annotation Property Type
179+ /**
180+ * Annotation Property Type
171181 *
172- * @returns {object} Annotation Property Type
182+ * @type Object
173183 */
174184 get propertyType () {
175185 return this[_attrs].propertyType
176186 }
177187
178- /** Get Study Instance UID of Microscopy Bulk Simple Annotations objects.
188+ /**
189+ * Study Instance UID of DICOM Microscopy Bulk Simple Annotations objects.
179190 *
180- * @returns { string} Study Instance UID
191+ * @type string
181192 */
182193 get studyInstanceUID () {
183194 return this[_attrs].studyInstanceUID
184195 }
185196
186- /** Get Series Instance UID of Microscopy Bulk Simple Annotations objects.
197+ /**
198+ * Series Instance UID of DICOM Microscopy Bulk Simple Annotations objects.
187199 *
188- * @returns { string} Series Instance UID
200+ * @type string
189201 */
190202 get seriesInstanceUID () {
191203 return this[_attrs].seriesInstanceUID
192204 }
193205
194- /** Get SOP Instance UIDs of Microscopy Bulk Simple Annotations objects.
206+ /**
207+ * SOP Instance UIDs of DICOM Microscopy Bulk Simple Annotations objects.
195208 *
196- * @returns { string[]} SOP Instance UIDs
209+ * @type string[]
197210 */
198211 get sopInstanceUIDs () {
199212 return this[_attrs].sopInstanceUIDs
@@ -203,10 +216,10 @@ <h1 class="page-title">Source: annotation.js</h1>
203216/**
204217 * Fetch graphic data (point coordinates) of an annotation group.
205218 *
206- * @param {object } options
207- * @param {object } options.metadataItem - Metadata of Annotation Group Sequence item
208- * @param {object } options.bulkdataItem - Bulkdata of Annotation Group Sequence item
209- * @param {object } options.client - DICOMweb client
219+ * @param {Object } options
220+ * @param {Object } options.metadataItem - Metadata of Annotation Group Sequence item
221+ * @param {Object } options.bulkdataItem - Bulkdata of Annotation Group Sequence item
222+ * @param {Object } options.client - DICOMweb client
210223 *
211224 * @returns {Promise<TypedArray> } Graphic data
212225 *
@@ -753,13 +766,13 @@ <h1 class="page-title">Source: annotation.js</h1>
753766</ div >
754767
755768< nav >
756- < h2 > < a href ="index.html "> Home</ a > </ h2 > < h3 > Namespaces</ h3 > < ul > < li > < a href ="annotation.html "> annotation</ a > </ li > < li > < a href ="api.html "> api</ a > </ li > < li > < a href ="color.html "> color</ a > </ li > < li > < a href ="events.html "> events</ a > </ li > < li > < a href ="mapping.html "> mapping</ a > </ li > < li > < a href ="metadata.html "> metadata</ a > </ li > < li > < a href ="opticalPath.html "> opticalPath</ a > </ li > < li > < a href ="roi.html "> roi</ a > </ li > < li > < a href ="scoord3d.html "> scoord3d</ a > </ li > < li > < a href ="segment.html "> segment</ a > </ li > < li > < a href ="utils.html "> utils</ a > </ li > < li > < a href ="viewer.html "> viewer</ a > </ li > </ ul > < h3 > Classes</ h3 > < ul > < li > < a href ="annotation.AnnotationGroup.html "> AnnotationGroup</ a > </ li > < li > < a href ="color.PaletteColorLookupTable.html "> PaletteColorLookupTable</ a > </ li > < li > < a href ="mapping.ParameterMapping.html "> ParameterMapping</ a > </ li > < li > < a href ="mapping.Transformation.html "> Transformation</ a > </ li > < li > < a href ="metadata.Comprehensive3DSR.html "> Comprehensive3DSR</ a > </ li > < li > < a href ="metadata.MicroscopyBulkSimpleAnnotations.html "> MicroscopyBulkSimpleAnnotations</ a > </ li > < li > < a href ="metadata.ParametricMap.html "> ParametricMap</ a > </ li > < li > < a href ="metadata.Segmentation.html "> Segmentation</ a > </ li > < li > < a href ="metadata.VLWholeSlideMicroscopyImage.html "> VLWholeSlideMicroscopyImage</ a > </ li > < li > < a href ="opticalPath.OpticalPath.html "> OpticalPath</ a > </ li > < li > < a href ="roi.ROI.html "> ROI</ a > </ li > < li > < a href ="scoord3d.Ellipse.html "> Ellipse</ a > </ li > < li > < a href ="scoord3d.Ellipsoid.html "> Ellipsoid</ a > </ li > < li > < a href ="scoord3d.Multipoint.html "> Multipoint</ a > </ li > < li > < a href ="scoord3d.Point.html "> Point</ a > </ li > < li > < a href ="scoord3d.Polygon.html "> Polygon</ a > </ li > < li > < a href ="scoord3d.Polyline.html "> Polyline</ a > </ li > < li > < a href ="segment.Segment.html "> Segment</ a > </ li > < li > < a href ="viewer.LabelImageViewer.html "> LabelImageViewer</ a > </ li > < li > < a href ="viewer.OverviewImageViewer.html "> OverviewImageViewer</ a > </ li > < li > < a href ="viewer.VolumeImageViewer.html "> VolumeImageViewer</ a > </ li > </ ul >
769+ < h2 > < a href ="index.html "> Home</ a > </ h2 > < h3 > Namespaces</ h3 > < ul > < li > < a href ="annotation.html "> annotation</ a > </ li > < li > < a href ="api.html "> api</ a > </ li > < li > < a href ="color.html "> color</ a > </ li > < li > < a href ="events.html "> events</ a > </ li > < li > < a href ="mapping.html "> mapping</ a > </ li > < li > < a href ="metadata.html "> metadata</ a > </ li > < li > < a href ="opticalPath.html "> opticalPath</ a > </ li > < li > < a href ="roi.html "> roi</ a > </ li > < li > < a href ="scoord3d.html "> scoord3d</ a > </ li > < li > < a href ="segment.html "> segment</ a > </ li > < li > < a href ="utils.html "> utils</ a > </ li > < li > < a href ="viewer.html "> viewer</ a > </ li > </ ul > < h3 > Classes</ h3 > < ul > < li > < a href ="annotation.AnnotationGroup.html "> AnnotationGroup</ a > </ li > < li > < a href ="color.PaletteColorLookupTable.html "> PaletteColorLookupTable</ a > </ li > < li > < a href ="mapping.ParameterMapping.html "> ParameterMapping</ a > </ li > < li > < a href ="mapping.Transformation.html "> Transformation</ a > </ li > < li > < a href ="metadata.Comprehensive3DSR.html "> Comprehensive3DSR</ a > </ li > < li > < a href ="metadata.MicroscopyBulkSimpleAnnotations.html "> MicroscopyBulkSimpleAnnotations</ a > </ li > < li > < a href ="metadata.ParametricMap.html "> ParametricMap</ a > </ li > < li > < a href ="metadata.Segmentation.html "> Segmentation</ a > </ li > < li > < a href ="metadata.SOPClass.html "> SOPClass</ a > </ li > < li > < a href ="metadata.VLWholeSlideMicroscopyImage.html "> VLWholeSlideMicroscopyImage</ a > </ li > < li > < a href ="opticalPath.OpticalPath.html "> OpticalPath</ a > </ li > < li > < a href ="roi.ROI.html "> ROI</ a > </ li > < li > < a href ="scoord3d.Ellipse.html "> Ellipse</ a > </ li > < li > < a href ="scoord3d.Ellipsoid.html "> Ellipsoid</ a > </ li > < li > < a href ="scoord3d.Multipoint.html "> Multipoint</ a > </ li > < li > < a href ="scoord3d.Point.html "> Point</ a > </ li > < li > < a href ="scoord3d.Polygon.html "> Polygon</ a > </ li > < li > < a href ="scoord3d.Polyline.html "> Polyline</ a > </ li > < li > < a href ="scoord3d.Scoord3D.html "> Scoord3D</ a > </ li > < li > < a href ="segment.Segment.html "> Segment</ a > </ li > < li > < a href ="viewer.LabelImageViewer.html "> LabelImageViewer</ a > </ li > < li > < a href ="viewer.OverviewImageViewer.html "> OverviewImageViewer</ a > </ li > < li > < a href ="viewer.VolumeImageViewer.html "> VolumeImageViewer</ a > </ li > </ ul >
757770</ nav >
758771
759772< br class ="clear ">
760773
761774< footer >
762- Documentation generated by < a href ="https://github.com/jsdoc/jsdoc "> JSDoc 3.6.10</ a > on Sat Mar 12 2022 11:29:56 GMT-0500 (Eastern Standard Time)
775+ Documentation generated by < a href ="https://github.com/jsdoc/jsdoc "> JSDoc 3.6.10</ a > on Sat Mar 12 2022 12:50:08 GMT-0500 (Eastern Standard Time)
763776</ footer >
764777
765778< script > prettyPrint ( ) ; </ script >
0 commit comments