Instance metadata/metadata providers overhaul (#1481)

* Instance metadata plus metadata provider overhaul.

Fix consumption of wado-uri urls

fallbacks + datatype agnosticism.

WIP DICOMify things.

fix various issues with naturalized variable naming migration.

Remove metadata provider.

Fix consumption of multiframe images and addition of CWIL metadata.

Fix strange build issues.

Fix CWIL style windowWidth to array from naturalized DICOM.

Fix PT, CT, CR and DX issues for cornerstone + DX issues for vtkjs.

Move color palette fetching down to the natuaralized JSON level.

Remove unused StudyMetadataSummary

Remove redundant dicom metadata dictionary.

Working local + json routes.

Fix SR read.

Finished first round of testing + cleaned up debugging etc.

* data => metadata for instance naturalizedJSON

* Update dcmjs version

* Correct github isssues.

* Fix erroneously replaced files.

* Danny's recommended changes.

* Instance metadata plus metadata provider overhaul.

Fix consumption of wado-uri urls

fallbacks + datatype agnosticism.

WIP DICOMify things.

fix various issues with naturalized variable naming migration.

Remove metadata provider.

Fix consumption of multiframe images and addition of CWIL metadata.

Fix strange build issues.

Fix CWIL style windowWidth to array from naturalized DICOM.

Fix PT, CT, CR and DX issues for cornerstone + DX issues for vtkjs.

Move color palette fetching down to the natuaralized JSON level.

Remove unused StudyMetadataSummary

Remove redundant dicom metadata dictionary.

Working local + json routes.

Fix SR read.

Finished first round of testing + cleaned up debugging etc.

* data => metadata for instance naturalizedJSON

* Update dcmjs version

* Correct github isssues.

* Fix erroneously replaced files.

* Danny's recommended changes.

* Update JSON CI

* Update casing of import.

* Fix jump for SR.

* Fix unit tests for measurements service

* Fix json CI test.

* fix: update yarn lock

* Fix local non-encapsulated pdf view

* CI updated to new sucess message.

Co-authored-by: Danny <danny.ri.brown@gmail.com>
This commit is contained in:
James PettsandDanny authored and GitHub committed 2020-03-09 19:03:23 +00:00
1 parent 8833731ad3
commit 1d85f7a74e
142 files changed
+5322 -8570

No files matched your search

@@ -0,0 +1,78 @@
import { api } from 'dicomweb-client';
import DICOMWeb from '../../DICOMWeb';
export default async function fetchOverlayData(instance, server) {
const OverlayDataPromises = [];
const OverlayDataTags = [];
return new Promise((resolve, reject) => {
for (let overlayGroup = 0x00; overlayGroup <= 0x1e; overlayGroup += 0x02) {
let groupStr = `60${overlayGroup.toString(16)}`;
if (groupStr.length === 3) {
groupStr = `600${overlayGroup.toString(16)}`;
}
const OverlayDataTag = `${groupStr}3000`;
if (instance[OverlayDataTag] && instance[OverlayDataTag].BulkDataURI) {
OverlayDataPromises.push(
_getOverlayData(instance[OverlayDataTag], server)
);
OverlayDataTags.push(OverlayDataTag);
}
}
if (OverlayDataPromises.length) {
Promise.all(OverlayDataPromises).then(results => {
for (let i = 0; i < results.length; i++) {
instance[OverlayDataTags[i]] = results[i];
}
resolve();
});
} else {
resolve();
}
});
}
async function _getOverlayData(tag, server) {
const { BulkDataURI } = tag;
let uri = BulkDataURI;
// TODO: Workaround for dcm4chee behind SSL-terminating proxy returning
// incorrect bulk data URIs
if (server.wadoRoot.indexOf('https') === 0 && !uri.includes('https')) {
uri = uri.replace('http', 'https');
}
const config = {
url: server.wadoRoot, //BulkDataURI is absolute, so this isn't used
headers: DICOMWeb.getAuthorizationHeader(server),
};
const dicomWeb = new api.DICOMwebClient(config);
const options = {
BulkDataURI: uri,
};
return dicomWeb
.retrieveBulkData(options)
.then(result => result[0])
.then(_unpackOverlay);
}
function _unpackOverlay(arrayBuffer) {
const bitArray = new Uint8Array(arrayBuffer);
const byteArray = new Uint8Array(8 * bitArray.length);
for (let byteIndex = 0; byteIndex < byteArray.length; byteIndex++) {
const bitIndex = byteIndex % 8;
const bitByteIndex = Math.floor(byteIndex / 8);
byteArray[byteIndex] =
1 * ((bitArray[bitByteIndex] & (1 << bitIndex)) >> bitIndex);
}
return byteArray;
}
@@ -0,0 +1,187 @@
import { api } from 'dicomweb-client';
import DICOMWeb from '../../DICOMWeb';
export default async function fetchPaletteColorLookupTableData(
instance,
server
) {
const {
PaletteColorLookupTableUID,
RedPaletteColorLookupTableDescriptor,
GreenPaletteColorLookupTableDescriptor,
BluePaletteColorLookupTableDescriptor,
RedPaletteColorLookupTableData,
GreenPaletteColorLookupTableData,
BluePaletteColorLookupTableData,
} = instance;
return new Promise((resolve, reject) => {
let entry;
if (_paletteColorCache.isValidUID(PaletteColorLookupTableUID)) {
entry = _paletteColorCache.get(PaletteColorLookupTableUID);
if (entry) {
return resolve(entry);
}
}
// no entry in cache... Fetch remote data.
const promises = [
_getPaletteColor(
server,
RedPaletteColorLookupTableData,
RedPaletteColorLookupTableDescriptor
),
_getPaletteColor(
server,
GreenPaletteColorLookupTableData,
GreenPaletteColorLookupTableDescriptor
),
_getPaletteColor(
server,
BluePaletteColorLookupTableData,
BluePaletteColorLookupTableDescriptor
),
];
Promise.all(promises).then(
([
RedPaletteColorLookupTableData,
GreenPaletteColorLookupTableData,
BluePaletteColorLookupTableData,
]) => {
// when PaletteColorLookupTableUID is present, the entry can be cached...
_paletteColorCache.add({
RedPaletteColorLookupTableData,
GreenPaletteColorLookupTableData,
BluePaletteColorLookupTableData,
PaletteColorLookupTableUID,
});
instance.RedPaletteColorLookupTableData = RedPaletteColorLookupTableData;
instance.GreenPaletteColorLookupTableData = GreenPaletteColorLookupTableData;
instance.BluePaletteColorLookupTableData = BluePaletteColorLookupTableData;
resolve();
}
);
});
}
/**
* Simple cache schema for retrieved color palettes.
*/
const _paletteColorCache = {
count: 0,
maxAge: 24 * 60 * 60 * 1000, // 24h cache?
entries: {},
isValidUID: function(PaletteColorLookupTableUID) {
return (
typeof PaletteColorLookupTableUID === 'string' &&
PaletteColorLookupTableUID.length > 0
);
},
get: function(PaletteColorLookupTableUID) {
let entry = null;
if (this.entries.hasOwnProperty(PaletteColorLookupTableUID)) {
entry = this.entries[PaletteColorLookupTableUID];
// check how the entry is...
if (Date.now() - entry.time > this.maxAge) {
// entry is too old... remove entry.
delete this.entries[PaletteColorLookupTableUID];
this.count--;
entry = null;
}
}
return entry;
},
add: function(entry) {
if (this.isValidUID(entry.uid)) {
let PaletteColorLookupTableUID = entry.uid;
if (this.entries.hasOwnProperty(PaletteColorLookupTableUID) !== true) {
this.count++; // increment cache entry count...
}
entry.time = Date.now();
this.entries[PaletteColorLookupTableUID] = entry;
// @TODO: Add logic to get rid of old entries and reduce memory usage...
}
},
};
function _getPaletteColor(server, paletteColorLookupTableData, lutDescriptor) {
const numLutEntries = lutDescriptor[0];
const bits = lutDescriptor[2];
const readUInt16 = (byteArray, position) => {
return byteArray[position] + byteArray[position + 1] * 256;
};
const arrayBufferToPaletteColorLUT = arraybuffer => {
const byteArray = new Uint8Array(arraybuffer);
const lut = [];
if (bits === 16) {
for (let i = 0; i < numLutEntries; i++) {
lut[i] = readUInt16(byteArray, i * 2);
}
} else {
for (let i = 0; i < numLutEntries; i++) {
lut[i] = byteArray[i];
}
}
return lut;
};
if (paletteColorLookupTableData.BulkDataURI) {
let uri = paletteColorLookupTableData.BulkDataURI;
// TODO: Workaround for dcm4chee behind SSL-terminating proxy returning
// incorrect bulk data URIs
if (server.wadoRoot.indexOf('https') === 0 && !uri.includes('https')) {
uri = uri.replace('http', 'https');
}
const config = {
url: server.wadoRoot, //BulkDataURI is absolute, so this isn't used
headers: DICOMWeb.getAuthorizationHeader(server),
};
const dicomWeb = new api.DICOMwebClient(config);
const options = {
BulkDataURI: uri,
};
return dicomWeb
.retrieveBulkData(options)
.then(result => result[0])
.then(arrayBufferToPaletteColorLUT);
} else if (paletteColorLookupTableData.InlineBinary) {
const inlineBinaryData = atob(paletteColorLookupTableData.InlineBinary);
const arraybuffer = _str2ab(inlineBinaryData);
return new Promise(resolve => {
resolve(arrayBufferToPaletteColorLUT(arraybuffer));
});
}
throw new Error(
'Palette Color LUT was not provided as InlineBinary or BulkDataURI'
);
}
/**
* Convert String to ArrayBuffer
*
* @param {String} str Input String
* @return {ArrayBuffer} Output converted ArrayBuffer
*/
function _str2ab(str) {
const strLen = str.length;
const bytes = new Uint8Array(strLen);
for (let i = 0; i < strLen; i++) {
bytes[i] = str.charCodeAt(i);
}
return bytes.buffer;
}
@@ -0,0 +1,27 @@
import log from '../../log';
function getFallbackTagFromInstance(tag, instance) {
if (instance[tag]) {
return instance[tag];
}
const fallbackTags = fallbackTagsMap[tag];
if (fallbackTags) {
for (let i = 0; i < fallbackTags.length; i++) {
const fallbackTag = fallbackTags[i];
if (instance[fallbackTag]) {
log.info(`metadata provider fallback tag ${tag} to ${fallbackTag}`);
return instance[fallbackTag];
}
}
}
}
const fallbackTagsMap = {
PixelSpacing: ['ImagerPixelSpacing'],
};
export { fallbackTagsMap, getFallbackTagFromInstance };