Skip to content

Commit

Permalink
Merge branch 'release/1.6.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
pbchase committed Aug 17, 2020
2 parents 09bd08a + 45ffad6 commit b3d3cf4
Show file tree
Hide file tree
Showing 9 changed files with 87 additions and 18 deletions.
8 changes: 8 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# AUTHORS

Andy Martin <github.com/123andy> intialized the image map plugin/hook.

The Image Map module would not be possible without the generous contributions of code, testing, and ideas from the CTS-IT developers, the REDCap Team, and Mike Conlon, Ph.D.

We specifically want to thank our developers Marly Gotti www.marlygotti.com , Kyle Chesney [email protected], James Pence [email protected], and Philip Chase [email protected] for their contributions to the project. Taryn Stoffs [email protected] and Jerri Johnston [email protected] provided valuable input into the design and testing of the Image Map module.

8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@ All notable changes to the Imagemap module will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).


## [1.6.0] - 2020-08-17
### Added
- Reduce mbody image size by 50% (willsvankumc)
- Adds Authors File and ReadMe adjustment (James Pence)
- Adds PI-RADS V2.1 (Geoffroey-Allen Franklin)
- Adds DO-Touch.NET OMT bodymap (Geoffroey-Allen Franklin)


## [1.5.0] - 2020-07-06
### Added
- Add 66 Swollen 68 Tender Joint Count Map (tom.lynch)
Expand Down
File renamed without changes.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# REDCap module: Image Map


[![DOI](https://zenodo.org/badge/115049747.svg)](https://zenodo.org/badge/latestdoi/115049747)

This REDCap module replaces an input, radio, or checkbox field with an image that users can interact with to select one or more options. Specific applications include a body map (with over 70 body regions), a smile scale from 1-7 with facial expressions, three representations of teeth and teeth surfaces, among others. See below for a complete list of current imagemaps. Future versions will allow admins and users to add additional maps via the module configuration. The module is tied to questions via the `@IMAGEMAP` action tag and the name of one of the pre-defined image maps. e.g. `@IMAGEMAP=PAINMAP_FEMALE`.
This REDCap module replaces an input, radio, or checkbox field with an image that users can interact with to select one or more options. Specific applications include a body map (with over 70 body regions), a smile scale from 1-7 with facial expressions, three representations of teeth and teeth surfaces, among others. See below for a complete list of current imagemaps. The module is tied to questions via the `@IMAGEMAP` action tag and the name of one of the pre-defined image maps. e.g. `@IMAGEMAP=PAINMAP_FEMALE`.


## Prerequisites
Expand Down Expand Up @@ -62,7 +63,12 @@ Representation of a generic female body.

**`PI-RADS`**

![TEETH](./img/pirads.png)
![PIRADS](./img/pirads.png)


**`PI-RADS_V2-1`**

![PI-RADS_V2-1](./img/pirads_v2.1.png)


**`RHEUMATOID_MAN`**
Expand Down Expand Up @@ -113,6 +119,7 @@ To display one of the images above in a survey or data entry form, add a new fie
@IMAGEMAP=TEETH_SURFACE
@IMAGEMAP=TEETH
@IMAGEMAP=PIRADS
@IMAGEMAP=PI-RADS_V2-1
@IMAGEMAP=RHEUMATOID_MAN
@IMAGEMAP=VA_CHART
@IMAGEMAP=MBODY
Expand All @@ -133,10 +140,11 @@ This project includes an [Example Instrument](docs/Instrument\ Example.zip) that
## Acknowledgements & Copyright
* The original body was devised by Dr. Ming-Chih J Kao and Professor Sean Mackey at Stanford University as part of [CHOIR](choir.stanford.edu). Use of the 'bodymap' images requires that the CHOIR attribution remains intact.
* The imagemap plugin/hook was written at Stanford by Andrew Martin and converted to an external module in collaboration with CTS-IT - University of Florida.
* The 5-face pain image and map was included by Lewisa2.
* The odontogram maps were contributed by Bas de Veer and collaborators at the ITHS and Christy McKinney at the University of Washington and Seattle Children’s Research Institute.
* The PIRADS images were contributed by Dr. Richard Fan from Stanford University.
* The PIRADS images were contributed by Dr. Richard Fan from Stanford University. Geoffroey-Allen Franklin [email protected] provided the new image and mapping for Pirads v2.1.
* Rheumatoid Man was contributed by Dr. Blaine Vlantis of the University of Cape Town.
* VA Chart image appears in the paper ["Deep Affect Prediction in-the-Wild: Aff-Wild Database and Challenge, Deep Architectures, and Beyond"](https://link.springer.com/article/10.1007/s11263-019-01158-4) by Kollias, D., Tzirakis, P., Nicolaou, M.A. et al. For image usage, refer to [Springer's copyright information](https://link.springer.com/article/10.1007/s11263-019-01158-4#copyrightInformation).
* The Michigan Body Map (MBODY) image was created by the Division of Pain Research Anesthesiology of the University of Michigan. Please refer to their [website](https://medicine.umich.edu/dept/pain-research/clinical-research/michigan-body-map-mbm) for copyright information.
* The DO-Touch.NET body map was created by Jamie Carroll using the international standard for osteopathic manipulative medicine (OMM) research established by DO-Touch.NET. Use of this image map requires the attributions to remain in place. [website](https://www.do-touch.net).
* The DO-Touch.NET body map was created by Jamie Carroll using the international standard for osteopathic manipulative medicine (OMM) research established by DO-Touch.NET. Use of this image map requires the attributions to remain in place. [website](https://www.do-touch.net). Jane Coe Johnson [email protected] assisted Geoffroey-Allen Franklin [email protected] updating information about the DO-Touch.NET image maps.
* The 66 Swollen / 68 Tender Joint Map was contributed by Dr Tom Lynch from the Institute of Bone and Joint Research, University of Sydney. The image was adopted with permission from Dr Alexis Ogdie-Beatty and first published in this article from the OMERACT group: [website](http://www.jrheum.org/content/early/2019/05/24/jrheum.181089).
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.5.0
1.6.0
29 changes: 16 additions & 13 deletions config.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,6 @@
"redcap_every_page_top"
],
"authors": [
{
"name": "Marly Cormar",
"email": "[email protected]",
"institution": "University of Florida - CTSI"
},
{
"name": "Tiago Bember",
"email": "[email protected]",
"institution": "University of Florida - CTSI"
},
{
"name": "Andy Martin",
"email": "[email protected]",
Expand Down Expand Up @@ -106,7 +96,7 @@
"alt": "Smile Scale",
"desc": "A smile scale from Happy (1) to Sad (7)",
"options": "1,2,3,4,5,6,7",
"data_dict_default":"1,1|2,2|3,3|4,4|5,5|6,6|7,7",
"data_dict_default": "1,1|2,2|3,3|4,4|5,5|6,6|7,7",
"image": "img/smile_scale.png",
"width": 602,
"height": 147,
Expand Down Expand Up @@ -167,6 +157,19 @@
"data_dict_default": "1, 1 | 2, 2 | 3, 3 | 4, 4 | 5, 5 | 6, 6 | 7, 7 | 8, 8 | 9, 9 | 10, 10 | 11, 11 | 12, 12 | 13, 13 | 14, 14 | 15, 15 | 16, 16 | 17, 17 | 18, 18 | 19, 19 | 20, 20 | 21, 21 | 22, 22 | 23, 23 | 24, 24 | 25, 25 | 26, 26 | 27, 27 | 28, 28 | 29, 29 | 30, 30",
"fillColor": "00aa00"
},
"PI-RADS_V2-1": {
"name": "pi-rads_v2-1",
"alt": "PI-RADS v2.1",
"desc": "Prostate imaging - reporting and data system version 2.1 (2019)",
"image": "img/pirads_v2.1.png",
"width": "513",
"height": "631",
"map": "maps/pirads_v2.1.html",
"hideInput": true,
"options": "1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41",
"data_dict_default": "1, Right seminal vesicles | 2, Left seminal vesicles | 3, Right anterior fibromuscular stroma base | 4, Left anterior fibromuscular stroma base | 5, Right anterior peripheral zone base | 6, Left anterior peripheral zone base | 7, Right anterior transition zone base | 8, Left anterior transition zone base | 9, Right lateral posterior peripheral zone base | 10, Left lateral posterior peripheral zone base | 11, Right posterior reansition zone base | 12, Left posterior transition zone base | 13, Right centeral zone base | 14, Left central zone base | 15, Right medial posterior peripheral zone base | 16, Left medial posterior peripheral zone base | 17, Right anterior fibromuscular stroma mid | 18, Left anterior fibromuscular stroma mid | 19, Right anterior peripheral zone mid | 20, Left anterior peripheral zone mid | 21, Right anterior transition zone mid | 22, Left anterior transition zone mid | 23, Right lateral posterior peripheral zone mid | 24, Left lateral posterior peripheral zone mid | 25, Right posterior transition zone mid | 26, Left posterior transition zone mid | 27, Right medial posterior peripheral zone mid | 28, Left medial posterior peripheral zone mid | 29, Right anterior fibromuscular stroma apex | 30, Left anterior fibromuscular stroma apex | 31, Right anterior peripheral zone apex | 32, Left anterior peripheral zone apex | 33, Right anterior transition zone apex | 34, Left anterior transition zone apex | 35, Right lateral posterior peripheral zone apex | 36, Left lateral posterior peripheral zone apex | 37, Right medial posterior peripheral zone apex | 38, Left medial posterior peripheral zone apex | 39, Right posterior transtion zone apex | 40, Left posterior transtion zone apex | 41, External urethral sphincter",
"fillColor": "00aa00"
},
"BEES": {
"name": "improved_pain_scale",
"alt": "Improved Pain Scale",
Expand Down Expand Up @@ -211,8 +214,8 @@
"alt": "Michigan Body Map",
"desc": "Michigan Body Map (MBM) reflects body areas where chronic pain may be experienced.",
"image": "img/mbody.png",
"width": 1152,
"height": 856,
"width": 576,
"height": 428,
"map": "maps/mbody.html",
"hideInput": true,
"options": "0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35",
Expand Down
Binary file modified docs/Instrument Example.zip
Binary file not shown.
Binary file added img/pirads_v2.1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 42 additions & 0 deletions maps/pirads_v2.1.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<!--- PI-Rads_v2.1 --->
<area data-key="1" title="Right seminal vesicles" href="" target="" alt="" shape="poly" coords="400,27,402,27,405,30,404,32,402,35,400,39,399,40,397,42,393,42,389,48,380,58,376,62,374,62,371,65,369,68,364,69,360,70,358,74,355,76,352,76,349,81,344,84,341,85,337,85,331,84,323,80,318,72,320,64,319,60,323,53,324,50,329,44,332,43,337,37,344,33,350,32,353,34,354,30,358,27,365,26,370,28,373,27,377,27,387,27,391,29" />
<area data-key="2" title="Left seminal vesicles" href="" target="" alt="" shape="poly" coords="418,27,416,30,414,32,417,36,418,39,422,42,429,43,431,48,437,54,441,57,444,56,444,59,448,62,454,64,459,66,464,67,464,70,468,73,473,74,477,77,478,78,482,80,490,80,492,79,496,78,501,77,505,71,505,64,503,55,500,47,495,44,488,44,485,38,478,33,473,31,470,32,468,34,467,31,465,29,461,27,453,26,451,28,449,28,447,27,438,26,434,27,430,29,425,27,422,27" />
<area data-key="3" title="Right anterior fibromuscular stroma base" href="" target="" alt="" shape="poly" coords="409,143,410,121,411,114,411,107,388,110,361,119,346,133,339,143,343,144,347,148,349,155,355,142,362,129,367,126,377,120,382,118,389,119,396,123,402,128,405,134" />
<area data-key="4" title="Left anterior fibromuscular stroma base" href="" target="" alt="" shape="poly" coords="411,106,412,113,414,118,415,126,415,142,416,144,419,138,424,129,428,124,435,120,441,119,450,121,457,125,463,131,469,139,474,147,477,158,482,145,485,143,488,143,481,133,471,123,455,114,433,108" />
<area data-key="5" title="Right anterior peripheral zone base" href="" target="" alt="" shape="poly" coords="338,143,335,149,332,156,328,170,326,181,325,189,326,192,360,181,349,155,347,150,345,146,342,144" />
<area data-key="6" title="Left anterior peripheral zone base" href="" target="" alt="" shape="poly" coords="487,143,491,149,496,160,499,169,502,177,503,188,503,192,470,181,477,159,481,149,482,145,485,144" />
<area data-key="7" title="Right anterior transition zone base" href="" target="" alt="" shape="poly" coords="360,180,413,181,412,172,410,170,409,165,409,155,409,142,404,133,401,127,392,121,385,119,382,118,363,129,359,135,349,155" />
<area data-key="8" title="Left anterior transition zone base" href="" target="" alt="" shape="poly" coords="413,181,469,180,477,158,473,147,469,140,464,133,460,129,456,125,449,122,442,120,435,120,429,124,426,126,420,138,416,144,415,170,413,172" />
<area data-key="9" title="Right lateral posterior peripheral zone base" href="" target="" alt="" shape="poly" coords="325,192,360,182,380,239,371,239,361,236,348,231,340,226,332,218,328,209,325,201" />
<area data-key="10" title="Left lateral posterior peripheral zone base" href="" target="" alt="" shape="poly" coords="452,238,470,182,504,192,502,202,497,216,490,224,484,229,471,235,460,238" />
<area data-key="11" title="Right posterior reansition zone base" href="" target="" alt="" shape="poly" coords="412,181,412,197,380,197,371,196,364,192,360,182" />
<area data-key="12" title="Left posterior transition zone base" href="" target="" alt="" shape="poly" coords="468,182,412,182,413,197,452,196,459,195,464,194" />
<area data-key="13" title="Right centeral zone base" href="" target="" alt="" shape="poly" coords="412,197,412,239,407,238,398,235,389,229,378,218,369,204,365,193,372,197,380,197,410,198" />
<area data-key="14" title="Left central zone base" href="" target="" alt="" shape="poly" coords="413,198,413,240,422,239,433,234,443,226,454,216,459,205,465,194,451,197,413,197" />
<area data-key="15" title="Right medial posterior peripheral zone base" href="" target="" alt="" shape="poly" coords="411,240,398,236,387,228,378,220,369,205,380,238,392,240" />
<area data-key="16" title="Left medial posterior peripheral zone base" href="" target="" alt="" shape="poly" coords="413,240,445,240,451,237,464,197,461,201,455,216,450,221,439,230,434,234,426,238,422,239" />
<area data-key="17" title="Right anterior fibromuscular stroma mid" href="" target="" alt="" shape="poly" coords="411,324,412,284,404,283,394,286,378,292,367,299,371,300,372,307,382,301,394,298,401,300,407,307,407,308" />
<area data-key="18" title="Left anterior fibromuscular stroma mid" href="" target="" alt="" shape="poly" coords="413,284,414,323,415,323,418,313,422,305,431,300,440,300,446,301,452,305,452,299,455,297,449,294,441,290,432,286,419,284" />
<area data-key="19" title="Right anterior peripheral zone mid" href="" target="" alt="" shape="poly" coords="366,299,370,300,371,307,365,315,360,323,357,328,356,334,356,342,357,352,334,352,335,342,340,331,345,320,356,309" />
<area data-key="20" title="Left anterior peripheral zone mid" href="" target="" alt="" shape="poly" coords="456,298,453,299,452,305,456,309,461,314,464,318,467,324,468,329,470,339,470,348,469,352,490,352,489,343,485,331,477,319,469,309,458,299" />
<area data-key="21" title="Right anterior transition zone mid" href="" target="" alt="" shape="poly" coords="410,335,410,323,406,307,400,301,394,299,383,301,371,308,365,316,357,329,356,343,358,351,407,352,411,340,410,338" />
<area data-key="22" title="Left anterior transition zone mid" href="" target="" alt="" shape="poly" coords="415,324,422,306,431,301,443,302,453,307,463,318,468,334,469,346,468,351,419,352,416,342,415,326" />
<area data-key="23" title="Right lateral posterior peripheral zone mid" href="" target="" alt="" shape="poly" coords="334,353,358,353,375,411,366,407,358,404,347,396,339,383,335,365" />
<area data-key="24" title="Left lateral posterior peripheral zone mid" href="" target="" alt="" shape="poly" coords="451,408,468,353,490,353,489,363,487,372,485,382,481,388,473,398,465,404,458,407" />
<area data-key="25" title="Right posterior transition zone mid" href="" target="" alt="" shape="poly" coords="406,352,359,352,363,367,368,373,378,377,388,375,398,368,402,362" />
<area data-key="26" title="Left posterior transition zone mid" href="" target="" alt="" shape="poly" coords="419,353,467,352,464,364,458,371,451,376,443,376,435,374,427,368" />
<area data-key="27" title="Right medial posterior peripheral zone mid" href="" target="" alt="" shape="poly" coords="363,368,376,411,393,413,412,414,412,376,408,375,404,372,404,366,399,370,398,369,388,376,377,378,367,373" />
<area data-key="28" title="Left medial posterior peripheral zone mid" href="" target="" alt="" shape="poly" coords="413,414,413,377,418,374,421,371,421,368,420,366,425,369,427,368,431,372,436,375,443,377,451,377,458,372,464,366,450,410,437,412,430,413,420,414" />
<area data-key="29" title="Right anterior fibromuscular stroma apex" href="" target="" alt="" shape="poly" coords="412,452,413,493,411,493,408,483,403,478,399,477,391,480,391,474,391,469,388,464,382,462,380,463,388,458,396,454" />
<area data-key="30" title="Left anterior fibromuscular stroma apex" href="" target="" alt="" shape="poly" coords="413,492,414,453,424,454,431,456,438,460,443,463,438,463,436,467,434,473,434,477,436,482,435,482,430,478,425,476,419,478,417,481,416,492" />
<area data-key="31" title="Right anterior peripheral zone apex" href="" target="" alt="" shape="poly" coords="380,463,388,465,390,469,390,480,386,486,383,492,354,501,357,492,363,479,377,466" />
<area data-key="32" title="Left anterior peripheral zone apex" href="" target="" alt="" shape="poly" coords="445,464,438,463,436,469,435,476,438,483,441,492,470,502,466,489,459,477" />
<area data-key="33" title="Right anterior transition zone apex" href="" target="" alt="" shape="poly" coords="385,491,410,492,408,484,404,479,399,477,391,480,387,485" />
<area data-key="34" title="Left anterior transition zone apex" href="" target="" alt="" shape="poly" coords="416,492,440,492,436,484,429,479,425,477,420,479,418,481,417,485" />
<area data-key="35" title="Right lateral posterior peripheral zone apex" href="" target="" alt="" shape="poly" coords="353,502,368,498,386,555,386,556,378,556,373,556,367,552,362,545,358,539,356,532,353,522" />
<area data-key="36" title="Left lateral posterior peripheral zone apex" href="" target="" alt="" shape="poly" coords="457,498,471,503,472,510,471,519,470,530,466,538,463,545,458,551,450,556,446,556,440,556,439,556" />
<area data-key="37" title="Right medial posterior peripheral zone apex" href="" target="" alt="" shape="poly" coords="369,497,384,493,382,500,382,509,387,517,392,522,401,527,408,527,412,521,412,552,406,552,398,553,392,555,387,555" />
<area data-key="38" title="Left medial posterior peripheral zone apex" href="" target="" alt="" shape="poly" coords="412,521,414,552,421,551,428,553,438,553,457,498,441,493,444,500,443,510,440,516,432,523,425,526,421,528,418,528" />
<area data-key="39" title="Right posterior transtion zone apex" href="" target="" alt="" shape="poly" coords="384,492,409,492,411,500,410,509,407,515,402,519,396,520,391,520,385,515,382,509" />
<area data-key="40" title="Left posterior transtion zone apex" href="" target="" alt="" shape="poly" coords="415,493,414,501,416,508,418,513,421,517,430,520,437,518,442,512,443,501,442,496,439,492" />
<area data-key="41" title="External urethral sphincter" href="" target="" alt="" shape="poly" coords="414,586,408,586,405,591,404,595,406,598,408,601,414,602,420,600,422,595,421,589" />

0 comments on commit b3d3cf4

Please sign in to comment.