Skip to content

Commit

Permalink
Merge branch 'release/1.13.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
pbchase committed Jun 11, 2024
2 parents cdb1934 + e86aa7e commit d848165
Show file tree
Hide file tree
Showing 12 changed files with 6,871 additions and 363 deletions.
8 changes: 4 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Change Log
All notable changes to the Imagemap module will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

# imagemap 1.13.0 (released 2024-06-11)
- Add Grids Body Map (@schatto1, @saipavan10-git, @pbchase, #76, #77)
- Rename instrument example files (@pbchase, #77)
- Remove Andy Martin from config.json (@ChemiKyle)

## [1.12.0] - 2024-02-20
### Added
Expand Down
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1597,6 +1597,18 @@ This is a body rendering developed at Stanford for a specific project -- no attr
Image provided by Yunfeng Dai.
![LADDER](./img/ladder_image.png)

**`GRIDS_BODY_MAP_FRONT`**

This is a map showing the anterior view of a human body, where the area inside the outline is split into 10 pixel by 10 pixel selectable grids. This allows for high fidelity selection of granular areas within the body. Use of "text box fields" within REDCap are encouraged for this map, due to the sheer number of "options".

![GRIDS_BODY_MAP_FRONT](./img/antpainimage1000px.png)

**`GRIDS_BODY_MAP_BACK`**

This is a map showing the posterior view of a human body, where the area inside the outline is split into 10 pixel by 10 pixel selectable grids. This allows for high fidelity selection of granular areas within the body. Use of "text box fields" within REDCap are encouraged for this map, due to the sheer number of "options".

![GRIDS_BODY_MAP_BACK](./img/postpainimage1000px.png)

## Usage
To display one of the images above in a survey or data entry form, add a new field of type **Text Box** and include one of the following options in the **Action Tags / Field Annotation (optional)** field:

Expand All @@ -1623,14 +1635,16 @@ To display one of the images above in a survey or data entry form, add a new fie
@IMAGEMAP=SZMN_SIDE
@IMAGEMAP=DERM_PHOTO_BODY
@IMAGEMAP=LADDER
@IMAGEMAP=GRIDS_BODY_MAP_FRONT
@IMAGEMAP=GRIDS_BODY_MAP_BACK
```

Each region of an image is associated with a key, for example, the "Ankle (front-left)" of the female body diagram is linked to the key "f34". To find a particular key for a body part, please refer to the HTML files (map files) located in the folder `maps`. After selecting multiple body parts, the field containing the action tag `@IMAGEMAP` will have as a value a string of comma-separated keys, e.g. "f36,f17,f18,f21". Similarly, if using the faces diagram, the field containing the action tag (e.g. `@IMAGEMAP=SMILE_SCALE`) will have the value corresponding to the face clicked.


## Testing instrument

This project includes an [Example Instrument](docs/Instrument\ Example.zip) that includes each of these image maps. It demonstrates different methods of using these image maps; which is suitable for testing or demonstration purposes.
This project includes an [Example Instrument](docs/all_maps_Instrument_Example.zip) that includes each of these image maps. It demonstrates different methods of using these image maps; which is suitable for testing or demonstration purposes. Some image maps are also available in their own `*_Instrument_Example.zip` in the [docs](docs/) folder.


## Acknowledgements & Copyright
Expand All @@ -1652,4 +1666,5 @@ This project includes an [Example Instrument](docs/Instrument\ Example.zip) that
* 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).
* The FR_REGION was contributed by Hugo Potier of University Hospital of Nîmes. The image source come from [data.gouv.fr](http://data.gouv.fr).
* Fibromyalgia self-report image appears in the article ["Fibromyalgia: A Clinical Review"](https://jamanetwork.com/journals/jama/fullarticle/1860480) by Daniel J. Clauw and is provided by Thomas Van Doorn and Dr. Andrea Nicol. Copyright 2014 American Medical Association. All rights reserved.
* The Grids Body Map (both front and back) were developed and contributed by Sumon Chattopadhyay and the BMIC team at the University of Utah.
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.12.0
1.13.0
35 changes: 27 additions & 8 deletions config.json

Large diffs are not rendered by default.

Binary file removed docs/Instrument Example.zip
Binary file not shown.
Binary file added docs/all_maps_Instrument_Example.zip
Binary file not shown.
710 changes: 361 additions & 349 deletions docs/example_project.xml

Large diffs are not rendered by default.

Binary file added docs/grids_body_maps_Instrument_Example.zip
Binary file not shown.
Binary file added img/antpainimage1000px.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/postpainimage1000px.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3,383 changes: 3,383 additions & 0 deletions maps/grids_body_map_back.html

Large diffs are not rendered by default.

3,079 changes: 3,079 additions & 0 deletions maps/grids_body_map_front.html

Large diffs are not rendered by default.

0 comments on commit d848165

Please sign in to comment.