Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Close #511, replaced convert_to_boxes with geometry_type #514

Merged
merged 4 commits into from
Oct 16, 2023
Merged

Close #511, replaced convert_to_boxes with geometry_type #514

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
58b64f8
Replaced convert_to_boxes with geometry_type
JSpencerPittman Oct 15, 2023
2529c65
Fixed grammer issue in docstring
JSpencerPittman Oct 15, 2023
7aa4f61
Added clarity and security for new geometry_type parameter
JSpencerPittman Oct 15, 2023
78c6ec5
Complies with style tests and improved docsting consistency
JSpencerPittman Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions deepforest/utilities.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,24 +245,37 @@ def xml_to_annotations(xml_path):
def shapefile_to_annotations(shapefile,
rgb,
buffer_size=0.5,
convert_to_boxes=False,
geometry_type="bbox",
savedir="."):
"""
Convert a shapefile of annotations into annotations csv file for DeepForest training and evaluation

Geometry Handling:
The geometry_type is the form of the objects in the given shapefile. It can be "bbox" or "point".
If geometry_type is set to "bbox" (default) then the bounding boxes in the shapefile will be used as is and transferred over
to the annotations file. If the geometry_type is "point" then a bounding box will be created for each
point that is centered on the point location and has an apothem equal to buffer_size, resulting in a bounding box with dimensions of 2
times the value of buffer_size.

Args:
shapefile: Path to a shapefile on disk. If a label column is present, it will be used, else all labels are assumed to be "Tree"
rgb: Path to the RGB image on disk
savedir: Directory to save csv files
buffer_size: size of point to box expansion in map units of the target object, meters for projected data, pixels for unprojected data. The buffer_size is added to each side of the x,y point to create the box.
convert_to_boxes (False): If True, convert the point objects in the shapefile into bounding boxes with size 'buffer_size'.
geometry_type (bbox): Specifies the spatial representation used in the shapefile; can be "bbox" or "point"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's drop the (bbox) here for consistency. We should probably do a general docstring consistency cleanup here, but the old (False) isn't consistent with any of the major styles so let's just drop it here since we're changing it.

Returns:
results: a pandas dataframe
"""

# Verify the geometry_type is valid
if geometry_type not in ["bbox", "point"]:
raise ValueError(f"Invalid argument for 'geometry_type'. Expected 'point' or 'bbox'.")

# Read shapefile
gdf = gpd.read_file(shapefile)

# define in image coordinates and buffer to create a box
if convert_to_boxes:
if geometry_type == "point":
gdf["geometry"] = [
shapely.geometry.Point(x, y)
for x, y in zip(gdf.geometry.x.astype(float), gdf.geometry.y.astype(float))
Expand Down
4 changes: 2 additions & 2 deletions tests/test_utilities.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ def test_shapefile_to_annotations_convert_to_boxes(tmpdir):
gdf = gpd.GeoDataFrame(df, geometry="geometry")
gdf.to_file("{}/annotations.shp".format(tmpdir))
image_path = get_data("OSBS_029.tif")
shp = utilities.shapefile_to_annotations(shapefile="{}/annotations.shp".format(tmpdir), rgb=image_path, savedir=tmpdir, convert_to_boxes=True)
shp = utilities.shapefile_to_annotations(shapefile="{}/annotations.shp".format(tmpdir), rgb=image_path, savedir=tmpdir, geometry_type="point")
assert shp.shape[0] == 2

def test_shapefile_to_annotations(tmpdir):
Expand All @@ -70,7 +70,7 @@ def test_shapefile_to_annotations(tmpdir):

gdf.to_file("{}/annotations.shp".format(tmpdir))
image_path = get_data("OSBS_029.tif")
shp = utilities.shapefile_to_annotations(shapefile="{}/annotations.shp".format(tmpdir), rgb=image_path, savedir=tmpdir, convert_to_boxes=False)
shp = utilities.shapefile_to_annotations(shapefile="{}/annotations.shp".format(tmpdir), rgb=image_path, savedir=tmpdir, geometry_type="bbox")
assert shp.shape[0] == 2

def test_boxes_to_shapefile_projected(m):
Expand Down