DOC,ENH describe and show customizations (#17)

gallantlab · Apr 21, 2024 · 5298ca1 · 5298ca1
1 parent 0527217
commit 5298ca1
Show file tree

Hide file tree

Showing 8 changed files with 49 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,12 @@
+# Documentation
+This folder contains some useful documentation for creating headcases.
+
+## Table of contents
+- [GallantLab Headcase Pipeline](glab_headcase_pipeline.md). This document provides a 
+brief overview of the pipeline used to create headcases for the GallantLab, and gives
+some tips on how to scan participants.
+- [Description of MeshLab Commands](meshlab_stepwise_command.md). This document provides 
+an overview of the filters applied with MeshLab before carving out the head model from
+the headcase.
+- [Headcase Customizations](customizations.md). This document shows the possible 
+customizations that can be applied to the headcases.
diff --git a/docs/customizations.md b/docs/customizations.md
@@ -0,0 +1,37 @@
+# Headcase customizations
+
+Several customizations files are provided in the `stls` directory. These files are used
+to remove extra material from the headcases after the head model has been carved out.
+The shapes contained in the customization file will be removed from the headcase.
+If you have issues with the fit of the headcase, or if you want to further customize the
+headcases, you can generate a similar customization file and pass it to the pipeline
+with the argument `--customizations-file`.
+
+## Available customizations
+
+There are four customizations currently available.
+
+- `default_customizations_v1.stl`. This is the original file used by CaseForge. With 
+3D printed headcases, it may feel slightly too tight on the nose.
+- `default_customizations_v2.stl`. A modified version with slightly more space around
+the nose.
+- `default_customizations_v3.stl`. A modified version with even more space around the 
+nose and cheeks.
+- `default_customizations_v4.stl`. Similar to the previous version, but with the bottom
+part of the front headcase removed to provide more comfort for some participants.
+
+### `default_customizations_v1.stl`
+
+![V1 customization](example_customizations/customizations_v1.png)
+
+### `default_customizations_v2.stl`
+
+![V2 customization](example_customizations/customizations_v2.png)
+
+### `default_customizations_v3.stl`
+
+![V3 customization](example_customizations/customizations_v3.png)
+
+### `default_customizations_v4.stl`
+
+![V4 customization](example_customizations/customizations_v4.png)
diff --git a/docs/example_customizations/customizations_v1.png b/docs/example_customizations/customizations_v1.png
diff --git a/docs/example_customizations/customizations_v2.png b/docs/example_customizations/customizations_v2.png
diff --git a/docs/example_customizations/customizations_v3.png b/docs/example_customizations/customizations_v3.png
diff --git a/docs/example_customizations/customizations_v4.png b/docs/example_customizations/customizations_v4.png
diff --git a/stls/default_customizations_v3.stl b/stls/default_customizations_v3.stl
diff --git a/stls/default_customizations_v4.stl b/stls/default_customizations_v4.stl