Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AnjaCramer committed May 22, 2023
1 parent 2240238 commit 259436d
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,31 @@
# 3D-EdgeAngle Generator (3dea-gen)

The scripts provided here are used to automatically create cross-sections on a 3D model with previously manually defined curve(s) (digitalisation of the edge, e.g. active edge of a lithic). Furthermore, with different approaches, the edge angles are automatically calculated on the cross-sections, which allows an analysis of the edge. The results are csv files for each profile containing the edge angle values of the different approaches.
These scripts are part of the project 3D-EdgeAngle – A semi-automated 3D digital method to quantify stone tool edge angle and design.
The scripts provided here are used to automatically create cross-sections on a 3D model with previously manually defined curve(s) (digitalisation of the edge, e.g. active edge of a lithic). Furthermore, with different measuring procedures, the edge angles are automatically calculated on the cross-sections, which allows an analysis of the edge. The results are csv files for each section containing the edge angle values of the different measuring procedures. These scripts are part of the project 3D-EdgeAngle – A semi-automated 3D digital method to systematically quantify stone tool edge angle and design.

Contributors: [![ORCID ID](http://info.orcid.org/wp-content/uploads/2019/11/orcid_16x16.png)](http://orcid.org/0000-0002-5232-1944) Anja Cramer, [![ORCID ID](http://info.orcid.org/wp-content/uploads/2019/11/orcid_16x16.png)](http://orcid.org/0000-0003-2175-9908) Guido Heinz, [![ORCID ID](https://info.orcid.org/wp-content/uploads/2019/11/orcid_16x16.png)](http://orcid.org/0000-0002-2193-7340) Lisa Schunk

## software

The scripts were created for the software **GOM Insprect Professional 2016**. The scripts must be executed within this software environment. A detailed description of the methods used can be found here (not yet published): [![DOI](https://zenodo.org/badge/DOI/10.5281/xxx.svg)](https://doi.org/10.5281/zenodo.xxx)
The scripts were created with the Python Interface for the software GOM Insprect Professional 2016. The scripts must be executed within this software environment. A detailed description of the method used can be found on Protocols.io: [![DOI](https://zenodo.org/badge/DOI/10.5281/xxx.svg)](https://doi.org/10.5281/zenodo.xxx)

## data

To use the scripts you need a 3D model in stl-file format and a digitized edge on the 3D model in iges-file format.
To use the scripts, you need a 3D model in stl-file format and a digitalised edge on the 3D model in iges-file format.

You can download a sample dataset with the results of the scripts here (not yet published): [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7360011.svg)](https://doi.org/10.5281/zenodo.7360011)
You can download a sample dataset with the results of the scripts here: [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7360011.svg)](https://doi.org/10.5281/zenodo.7360011)

## python scripts

For the naming of the data specifications have been made, which are defined in the scripts by "regular expressions" (regex). These defaults can be adjusted. The variables for this are defined in the scripts with "pattern_".
For the naming of the data, specifications have been made, which are defined in the scripts by "regular expressions" (regex). These defaults can be adjusted. The variables for this are defined in the scripts with "pattern_".

**gom2016_3dea_1_reference_curve.py**

Creates a thinned and smoothed reference curve from the curve of the digitised edge. This is the basis for the cross profiles.
Creates a thinned and smoothed reference curve from the curve of the digitalised edge. This is the basis for the cross-sections.

**gom2016_3dea_2_sections_SEC_NUM.py**

Calculates cross-sections based on the reference curve and the 3D model.
The number of cross sections can be specified here. The distance between them is distributed evenly over the reference curve.
The number of cross sections can be specified here. The distance between them is distributed evenly along the reference curve.

**gom2016_3dea_2_sections_SEC_DIST.py**

Expand All @@ -39,5 +38,5 @@ Projects the cross-sections into a 2D plane and saves profiles as iges-file and

**gom2016_3dea_4_compute_edge_angles.py**

Calculates angles on the cross sections in three different approaches. Angles are calculated at regular intervals from the digitized edge. All calculated angles are saved in a csv-file.
Calculates angles on the cross sections based on three different measuring procedures. Angles are calculated at regular intervals from the digitalised edge. All calculated angles are saved in a csv-file.

0 comments on commit 259436d

Please sign in to comment.