Rename bbox -> bounds (#2199)

* Rename bbox -> geo_bbox

* Rename to bounds

* Undo rename in data.py

tests/datamodules/test_geo.py

@@ -32,7 +32,7 @@ def __init__(
 
     def __getitem__(self, query: BoundingBox) -> dict[str, Any]:
         image = torch.arange(3 * 2 * 2).view(3, 2, 2)
-        return {'image': image, 'crs': CRS.from_epsg(4326), 'bbox': query}
+        return {'image': image, 'crs': CRS.from_epsg(4326), 'bounds': query}
 
     def plot(self, *args: Any, **kwargs: Any) -> Figure:
         return plt.figure()

torchgeo/datamodules/geo.py

@@ -353,7 +353,7 @@ def transfer_batch_to_device(
         """
         # Non-Tensor values cannot be moved to a device
         del batch['crs']
-        del batch['bbox']
+        del batch['bounds']
 
         batch = super().transfer_batch_to_device(batch, device, dataloader_idx)
         return batch

torchgeo/datasets/agrifieldnet.py

@@ -221,7 +221,7 @@ def __getitem__(self, query: BoundingBox) -> dict[str, Any]:
 
         sample = {
             'crs': self.crs,
-            'bbox': query,
+            'bounds': query,
             'image': image.float(),
             'mask': mask.long(),
         }

torchgeo/datasets/chesapeake.py

@@ -607,7 +607,7 @@ def __getitem__(self, query: BoundingBox) -> dict[str, Any]:
         hits = self.index.intersection(tuple(query), objects=True)
         filepaths = cast(list[dict[str, str]], [hit.object for hit in hits])
 
-        sample = {'image': [], 'mask': [], 'crs': self.crs, 'bbox': query}
+        sample = {'image': [], 'mask': [], 'crs': self.crs, 'bounds': query}
 
         if len(filepaths) == 0:
             raise IndexError(

torchgeo/datasets/eddmaps.py

@@ -100,6 +100,6 @@ def __getitem__(self, query: BoundingBox) -> dict[str, Any]:
                 f'query: {query} not found in index with bounds: {self.bounds}'
             )
 
-        sample = {'crs': self.crs, 'bbox': bboxes}
+        sample = {'crs': self.crs, 'bounds': bboxes}
 
         return sample

torchgeo/datasets/enviroatlas.py

@@ -347,7 +347,7 @@ def __getitem__(self, query: BoundingBox) -> dict[str, Any]:
         hits = self.index.intersection(tuple(query), objects=True)
         filepaths = cast(list[dict[str, str]], [hit.object for hit in hits])
 
-        sample = {'image': [], 'mask': [], 'crs': self.crs, 'bbox': query}
+        sample = {'image': [], 'mask': [], 'crs': self.crs, 'bounds': query}
 
         if len(filepaths) == 0:
             raise IndexError(

torchgeo/datasets/gbif.py

@@ -137,6 +137,6 @@ def __getitem__(self, query: BoundingBox) -> dict[str, Any]:
                 f'query: {query} not found in index with bounds: {self.bounds}'
             )
 
-        sample = {'crs': self.crs, 'bbox': bboxes}
+        sample = {'crs': self.crs, 'bounds': bboxes}
 
         return sample

torchgeo/datasets/geo.py

@@ -546,7 +546,7 @@ def __getitem__(self, query: BoundingBox) -> dict[str, Any]:
         else:
             data = self._merge_files(filepaths, query, self.band_indexes)
 
-        sample = {'crs': self.crs, 'bbox': query}
+        sample = {'crs': self.crs, 'bounds': query}
 
         data = data.to(self.dtype)
         if self.is_image:
@@ -776,7 +776,7 @@ def __getitem__(self, query: BoundingBox) -> dict[str, Any]:
         masks = array_to_tensor(masks)
 
         masks = masks.to(self.dtype)
-        sample = {'mask': masks, 'crs': self.crs, 'bbox': query}
+        sample = {'mask': masks, 'crs': self.crs, 'bounds': query}
 
         if self.transforms is not None:
             sample = self.transforms(sample)

torchgeo/datasets/globbiomass.py

@@ -207,7 +207,7 @@ def __getitem__(self, query: BoundingBox) -> dict[str, Any]:
 
         mask = torch.cat((mask, std_err_mask), dim=0)
 
-        sample = {'mask': mask, 'crs': self.crs, 'bbox': query}
+        sample = {'mask': mask, 'crs': self.crs, 'bounds': query}
 
         if self.transforms is not None:
             sample = self.transforms(sample)

torchgeo/datasets/inaturalist.py

@@ -107,6 +107,6 @@ def __getitem__(self, query: BoundingBox) -> dict[str, Any]:
                 f'query: {query} not found in index with bounds: {self.bounds}'
             )
 
-        sample = {'crs': self.crs, 'bbox': bboxes}
+        sample = {'crs': self.crs, 'bounds': bboxes}
 
         return sample

torchgeo/datasets/landcoverai.py

@@ -268,7 +268,7 @@ def __getitem__(self, query: BoundingBox) -> dict[str, Any]:
         mask = self._merge_files(mask_filepaths, query, self.band_indexes)
         sample = {
             'crs': self.crs,
-            'bbox': query,
+            'bounds': query,
             'image': img.float(),
             'mask': mask.long(),
         }

torchgeo/datasets/openbuildings.py

@@ -328,7 +328,7 @@ def __getitem__(self, query: BoundingBox) -> dict[str, Any]:
         else:
             masks = torch.zeros(size=(1, round(height), round(width)))
 
-        sample = {'mask': masks, 'crs': self.crs, 'bbox': query}
+        sample = {'mask': masks, 'crs': self.crs, 'bounds': query}
 
         if self.transforms is not None:
             sample = self.transforms(sample)

torchgeo/datasets/south_africa_crop_type.py

@@ -228,7 +228,7 @@ def __getitem__(self, query: BoundingBox) -> dict[str, Any]:
 
         sample = {
             'crs': self.crs,
-            'bbox': query,
+            'bounds': query,
             'image': image.float(),
             'mask': mask.long(),
         }