From 4c81f918653af9d19ee9d75be7d3e9e3d919d786 Mon Sep 17 00:00:00 2001 From: Simon Nilsson Date: Mon, 9 Sep 2024 12:15:49 -0400 Subject: [PATCH 1/2] Create predefined_roi_sized_gui.md --- misc/predefined_roi_sized_gui.md | 54 ++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 misc/predefined_roi_sized_gui.md diff --git a/misc/predefined_roi_sized_gui.md b/misc/predefined_roi_sized_gui.md new file mode 100644 index 000000000..cbc7fc2ff --- /dev/null +++ b/misc/predefined_roi_sized_gui.md @@ -0,0 +1,54 @@ +### DRAW SHAPES OF USER-DEFINED METRIC SIZES + +First, open the `File (ROI)` drop-down menu at the head of the `Region of interest` window and click the `Draw ROIs of pre-defined sizes` option. + +![predefined_sizes_1](https://github.com/user-attachments/assets/d57d09ee-a909-4ad4-a025-6e54ab00c35a) + +Once clicked, you should see the following pop-up opening allowing you to draw a range of different shapes with specified sizes. If you need a shape-type that is missing, consider letting us know through [Gitter](https://app.gitter.im/#/room/#SimBA-Resource_community:gitter.im) or by opening en issue on [GithHub](https://github.com/sgoldenlab/simba/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=). + +![predefined_sizes_2](https://github.com/user-attachments/assets/c76037f3-f15c-430f-b552-fd945c15862b) + +In the `SETTINGS` frame, fill in the name of your ROI, and choose its color, thickness, and ear tag size. + +#### DRAW A RECTANGLE OF SET SIZE + +To draw a RECTANGLE of set size, fill in its metric width and height in millimeter and click ``ADD RECTANGLE`` as in the video below: + +[predefined_sizes_rectangle.webm](https://github.com/user-attachments/assets/f669e54a-c8d7-4e2c-b2a9-bb39dd483b3f) + +#### DRAW A CIRCLE OF A SPECIFIC RADIUS + +To draw a CIRCLE with a specific radius, fill in its metric radius in millimeter and click ``ADD CIRCLE`` as in the video below: + +[predefined_sizes_circle.webm](https://github.com/user-attachments/assets/9c745aa3-20bf-49fb-8e65-90144ac7e3c7) + +#### DRAW A HEXAGON SPECIFIC RADIUS + +To draw a HEXAGON with a specific radius, fill in its metric radius in millimeter and click ``ADD HEXAGON`` as in the video below: + +[predefined_sizes_hexagon.webm](https://github.com/user-attachments/assets/eda60da0-693f-414e-95c5-51a7fc5a033c) + +#### DRAW A HALF CIRCLE POINTING NORTH + +To draw a HALF CIRCLE with a specific radius with its chunky part pointing UP, fill in its metric radius in millimeter, choose `NORTH` in the `direction drop-down menu`, and click ``ADD HALF CIRCLE`` as in the video below: + +[predefined_sizes_half_circle_north.webm](https://github.com/user-attachments/assets/d0323574-f163-4038-bfcd-b8f2e4595d0c) + +#### DRAW A HALF CIRCLE POINTING WEST + +To draw a HALF CIRCLE with a specific radius with its chunky part pointing LEFT, fill in its metric radius in millimeter, choose `WEST` in the `direction drop-down menu`, and click ``ADD HALF CIRCLE`` as in the video below: + +[predefined_sizes_half_circle_west.webm](https://github.com/user-attachments/assets/3127e41f-ca83-4617-8ed8-7d9b6ece4079) + + + + + + + + + + + + + From ef2620a9ec79e3bf985840cf742ead3e5116219d Mon Sep 17 00:00:00 2001 From: Simon Nilsson Date: Mon, 9 Sep 2024 12:17:34 -0400 Subject: [PATCH 2/2] Add files via upload --- docs/predefined_roi_sizes_gui.md | 41 ++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 docs/predefined_roi_sizes_gui.md diff --git a/docs/predefined_roi_sizes_gui.md b/docs/predefined_roi_sizes_gui.md new file mode 100644 index 000000000..04f60a412 --- /dev/null +++ b/docs/predefined_roi_sizes_gui.md @@ -0,0 +1,41 @@ +### DRAW SHAPES OF USER-DEFINED METRIC SIZES + +First, open the `File (ROI)` drop-down menu at the head of the `Region of interest` window and click the `Draw ROIs of pre-defined sizes` option. + +![predefined_sizes_1](https://github.com/user-attachments/assets/d57d09ee-a909-4ad4-a025-6e54ab00c35a) + +Once clicked, you should see the following pop-up opening allowing you to draw a range of different shapes with specified sizes. If you need a shape-type that is missing, consider letting us know through [Gitter](https://app.gitter.im/#/room/#SimBA-Resource_community:gitter.im) or by opening en issue on [GithHub](https://github.com/sgoldenlab/simba/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=). + +![predefined_sizes_2](https://github.com/user-attachments/assets/c76037f3-f15c-430f-b552-fd945c15862b) + +In the `SETTINGS` frame, fill in the name of your ROI, and choose its color, thickness, and ear tag size. + +#### DRAW A RECTANGLE OF SET SIZE + +To draw a RECTANGLE of set size, fill in its metric width and height in millimeter and click ``ADD RECTANGLE`` as in the video below: + +[predefined_sizes_rectangle.webm](https://github.com/user-attachments/assets/f669e54a-c8d7-4e2c-b2a9-bb39dd483b3f) + +#### DRAW A CIRCLE OF A SPECIFIC RADIUS + +To draw a CIRCLE with a specific radius, fill in its metric radius in millimeter and click ``ADD CIRCLE`` as in the video below: + +[predefined_sizes_circle.webm](https://github.com/user-attachments/assets/9c745aa3-20bf-49fb-8e65-90144ac7e3c7) + +#### DRAW A HEXAGON SPECIFIC RADIUS + +To draw a HEXAGON with a specific radius, fill in its metric radius in millimeter and click ``ADD HEXAGON`` as in the video below: + +[predefined_sizes_hexagon.webm](https://github.com/user-attachments/assets/eda60da0-693f-414e-95c5-51a7fc5a033c) + +#### DRAW A HALF CIRCLE POINTING NORTH + +To draw a HALF CIRCLE with a specific radius with its chunky part pointing UP, fill in its metric radius in millimeter, choose `NORTH` in the `direction drop-down menu`, and click ``ADD HALF CIRCLE`` as in the video below: + +[predefined_sizes_half_circle_north.webm](https://github.com/user-attachments/assets/d0323574-f163-4038-bfcd-b8f2e4595d0c) + +#### DRAW A HALF CIRCLE POINTING WEST + +To draw a HALF CIRCLE with a specific radius with its chunky part pointing LEFT, fill in its metric radius in millimeter, choose `WEST` in the `direction drop-down menu`, and click ``ADD HALF CIRCLE`` as in the video below: + +[predefined_sizes_half_circle_west.webm](https://github.com/user-attachments/assets/3127e41f-ca83-4617-8ed8-7d9b6ece4079) \ No newline at end of file