Skip to content

Commit

Permalink
Improved formatting of function description and intended use
Browse files Browse the repository at this point in the history
  • Loading branch information
Benjamin Grier committed Oct 14, 2024
1 parent b19e25d commit 065d762
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions src/site_assessment/common_functions.jl
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,11 @@ end
search_buffer::Union{Int64,Float64}=20000.0
)::Float64
Identifies the closest edge to the target `pixel`/'`geom_buff`.
Identifies the closest edge to the target `pixel`/'`geom_buff`. The angle required to rotate
geom_buff to match this reef edge is calculated. This angle is the angle relative to the
default `geom_buff` horizontal orientation. Therefore, if returned angle = 45 degrees,
`rot_geom(geom_buff, 45)` will rotate `geom_buff` by 45 degrees to match the identified reef
edge.
# Arguments
- `pixel` : Target point at the center of the search polygon.
Expand All @@ -169,10 +173,7 @@ Identifies the closest edge to the target `pixel`/'`geom_buff`.
- `search_buffer` : Distance to search from pixel to find closest reef.
# Returns
Angle of rotation required to match reef edge line. This angle is the angle relative to the
default `geom_buff` horizontal orientation. Therefore, if returned angle = 45 degrees,
`rot_geom(geom_buff, 45)` will rotate `geom_buff` by 45 degrees to match the identified reef
edge.
Rotation angle required to match reef edge when used in `rotate_geom(geom_buff, rot_angle)`.
"""
function initial_search_rotation(
pixel::GeometryBasics.Point{2,Float64},
Expand Down

0 comments on commit 065d762

Please sign in to comment.