Samplers: Add PointGeoSampler

[ak3ra]

This PR attempts to implement a PointGeo Sampler.
The PointGeoSampler takes in an Image dataset and a dataset containing (lat/lon) points (eg GBIF, INaturalist), finds the intersection of the two datasets and returns a sample bounding box of the image dataset which contains the lat/lon coordinates.

See #723 for design discussion

[microsoft-github-policy-service]

@ak3ra please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

1. Definitions.
   “Code” means the computer software code, whether in human-readable or machine-executable form,
   that is delivered by You to Microsoft under this Agreement.
   “Project” means any of the projects owned or managed by Microsoft and offered under a license
   approved by the Open Source Initiative (www.opensource.org).
   “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
   Project, including but not limited to communication on electronic mailing lists, source code control
   systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
   discussing and improving that Project, but excluding communication that is conspicuously marked or
   otherwise designated in writing by You as “Not a Submission.”
   “Submission” means the Code and any other copyrightable material Submitted by You, including any
   associated comments and documentation.
2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
   Project. This Agreement covers any and all Submissions that You, now or in the future (except as
   described in Section 4 below), Submit to any Project.
3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
   Should You wish to Submit materials that are not Your original work, You may Submit them separately
   to the Project if You (a) retain all copyright and license information that was in the materials as You
   received them, (b) in the description accompanying Your Submission, include the phrase “Submission
   containing materials of a third party:” followed by the names of the third party and any licenses or other
   restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
   guidelines concerning Submissions.
4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
   for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
   Submission is made in the course of Your work for an employer or Your employer has intellectual
   property rights in Your Submission by contract or applicable law, You must secure permission from Your
   employer to make the Submission before signing this Agreement. In that case, the term “You” in this
   Agreement will refer to You and the employer collectively. If You change employers in the future and
   desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
   and secure permission from the new employer before Submitting those Submissions.
5. Licenses.

• Copyright License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
  Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
  the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
  parties.
• Patent License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
  Your patent claims that are necessarily infringed by the Submission or the combination of the
  Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
  import or otherwise dispose of the Submission alone or with the Project.
• Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
  No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
  granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
   licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
   have disclosed under Section 3). You represent that You have secured permission from Your employer to
   make the Submission in cases where Your Submission is made in the course of Your work for Your
   employer or Your employer has intellectual property rights in Your Submission by contract or applicable
   law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
   have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
   You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
   REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
   EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
   PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
   NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
7. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
   You later become aware that would make Your representations in this Agreement inaccurate in any
   respect.
8. Information about Submissions. You agree that contributions to Projects and information about
   contributions may be maintained indefinitely and disclosed publicly, including Your name and other
   information that You submit with Your Submission.
9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
   the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
   Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
   exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
   defenses of lack of personal jurisdiction and forum non-conveniens.
10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

[isaaccorley]

@ak3ra Thanks for the contribution! Here's a link to the contributing docs which can give some guidance for fixing the failing github actions. You'll need to run black and isort from the root of the repo which will format the code. Then you'll need to run flake8 and pydocstyle and fix any errors that pop up.

[adamjstewart]

@ak3ra I might find some time to work on this this week. Do you mind if I push commits directly to your PR branch?

[ak3ra]

Thanks @isaaccorley I will follow the guidelines !

@adamjstewart, I don't mind at all. Looking forward to having this feature :)

[adamjstewart]

@ak3ra and I met over zoom, discussed some of these changes.

I may have changed my mind on the best way to design this halfway through reviewing, get through the end before making too many changes lol. Let me know if any of this isn't clear. I'll let you keep hacking on this for a while and I'm happy to step in and try implementing things myself if you want.

Once we get this working properly, we can worry about testing and code style.

[adamjstewart]

I think you can remove this import, it isn't used

[adamjstewart]

This should have:

.. versionadded:: 0.4

at the end to document that it only exists in TorchGeo 0.4+

[adamjstewart]

I'm not sure if image_dataset is the best name, since it could also be used for vector labels. Maybe tile_dataset or scene_dataset. But maybe those aren't clear either. Not sure.

Let's call points point_dataset instead.

[adamjstewart]

You'll need to add a size parameter to control how large the returned bounding boxes are

[adamjstewart]

Suggested change

	for hit in self.image_dataset.index.intersection(tuple(self.points.index.bounds),objects=True):
	for hit in self.index.intersection(tuple(self.points.index.bounds),objects=True):

This will use the self.index created via GeoDataset.__index__ which will take into account the roi parameter.

Also, I don't think you want to take the intersection of image_dataset and the points bounding box. Basically, we want a list of points that intersect with an image. Take a look at torchgeo.datasets.geo.IntersectionDataset._merge_dataset_indices. I think we want something like that, although we only need a single for loop (loop over all points). For each point, if it intersects with the image dataset, then add it to the list of hits. So maybe something like this:

for point in point_dataset.index.intersection(point_dataset.index.bounds, objects=True):
    if list(self.index.intersection(point.bounds)):
        self.hits.append(point)

[adamjstewart]

Instead of returning the entire bounding box of the hit, we'll want to return a smaller patch of size self.size. You can use get_random_bounding_box (used above in RandomGeoSampler) to do this. First, start with the point (hit) you want to sample. Then, create a bounding box that is +/- self.size in both directions.

If you want to get really technical, we should also be careful of points that are on the edge of an image. In that case, we should technically only sample from the part of the bounding box that is within an image. I'm not sure what the best way to handle that would be. An idea would be to ignore what I said above about self.hits only being a list of points and instead:

1. Convert point_dataset to an rtree index where each bounding box is now (point +/- self.size) in every direction
2. Compute the intersection dataset of both: dataset = image_dataset & new_point_dataset
3. Sample like we normally do in RandomGeoSampler

What do you think about that approach? I think it's actually simpler and more robust.

[ak3ra]

@adamjstewart it looks like the next week and a half is going to be a little too busy for me to focus on this fully,
Would you mind taking over? And I will be more than happy to test the functionality and write a tutorial/documentation of it.

[adamjstewart]

I got buried in prelim and conference prep, so I also haven't gotten a chance to work on this.

[adamjstewart]

@ak3ra is this PR still a work in progress? Not sure if it's still relevant to your research or not.