TrizTech/ohif-viewer
15
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(HP): update for sameAs attribute doc (#3383)

Browse Source 
Update HangingProtocolService doc to include example and instructions to use custom attributes included in @ohif/extension-test. Example shows usage of sameAs for frame of reference check in tmtv hanging protocol.
This commit is contained in:
dxlin 2023-05-10 15:04:49 -04:00 committed by GitHub
parent 8eaa1877fd
commit 656f9cf761
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 48 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
platform/docs/docs/platform/services/data/HangingProtocolService.md
View File

@ -310,3 +310,51 @@ viewportOptions: {
// This is the value returned if the above doesn't return anything
defaultValue: { index: 5 },
```
### Included Custom Attributes
A few custom attributes are included under @ohif/extension-test, these are namely:
*sameAs
*maxNumImageFrames
*numberOfDisplaySets
To use these included custom attributes, the extension will need to be enabled under platform/viewer/pluginConfig.json:
```javascript
{
"extensions": [
...
{
"packageName": "@ohif/extension-test",
"version": "0.0.1"
},
...
]
}
```
Furthermore, the extension will also need to be included under extensionDependencies in the desired mode (e.g. modes/tmtv/src/index.js):
```javascript
const extensionDependencies = {
'@ohif/extension-default': '^3.0.0',
'@ohif/extension-cornerstone': '^3.0.0',
'@ohif/extension-tmtv': '^3.0.0',
'@ohif/extension-test': '^0.0.1',
};
```
The below example modifies the included hanging protocol (extensions/tmtv/src/getHangingProtocolModule.js) and uses the sameAs attribute included in the @ohif/extension-test extension to check that the selected PT has the same frame of reference as the CT:
```javascript
ptDisplaySet: {
...
seriesMatchingRules: [
{
attribute: 'sameAs',
sameAttribute: 'FrameOfReferenceUID',
sameDisplaySetId: 'ctDisplaySet',
required: true,
},
...
```