Skip to content

Commit

Permalink
Update links
Browse files Browse the repository at this point in the history
  • Loading branch information
rbrundritt committed Sep 21, 2022
1 parent 7f5973d commit 9ad3a6d
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

This is a lightweight web-interface for creating and sharing vector labels (lines or polygons) over satellite/aerial imagery scenes. This project includes the following tools:

- [Project builder](src/projectBuilder.html) - Allows you to specify an area of interest, select the imagery layers that can be used for reference, break the area up into chuncks and generate tasks files that can be assigned to those who will be doing the labeling. For more details, see the [Project builder documentation](docs/Project-builder.md).
- [Project builder](https://microsoft.github.io/satellite-imagery-labeling-tool/src/projectBuilder.html) - Allows you to specify an area of interest, select the imagery layers that can be used for reference, break the area up into chuncks and generate tasks files that can be assigned to those who will be doing the labeling. For more details, see the [Project builder documentation](docs/Project-builder.md).
- Easily break up an area of interest into smaller subsets that can be assigned to individuals via a task file.
- [Labeler](src/labeler.html) - Loads a task file for an labeling project (annotation). For more details, see the [Labeler documentation](docs/Labeler.md).
- [Labeler](https://microsoft.github.io/satellite-imagery-labeling-tool/src/labeler.html) - Loads a task file for an labeling project (annotation). For more details, see the [Labeler documentation](docs/Labeler.md).
- Automatically caches data in local browser storage (does not leave your machine) to help prevent data lose from accidental browser refresh or closer. Makes it easy to come back later and continue where you left off. Supports multiple labeling projects by seperating the data by the projects task name. [Learn more](docs/Labeler.md#auto-save-feature).
- Import existing data from local geospatial files. Supports: GeoJSON, GeoJSONL, KML, KMZ, GeoRSS, GPX, GML, CSV (comma, tab, or pipe delimited).
- Easily import existing data from Open Street Maps via the [Overpass turbo API](https://overpass-turbo.eu). Avoids loading in any data for areas that already have drawn features.
- [Project viewer](src/projectViewer.html) - View and merge the results from the project. See stats and easily identify which areas have little to no labels. For more details, see the [Project viewer documentation](docs/Project-viewer.md).
- [Project viewer](https://microsoft.github.io/satellite-imagery-labeling-tool/src/projectViewer.html) - View and merge the results from the project. See stats and easily identify which areas have little to no labels. For more details, see the [Project viewer documentation](docs/Project-viewer.md).

Also see the [Documentation](docs/README.md) and the [Spatial imagery ML Jupyter notebook example](example/).

Expand Down
2 changes: 1 addition & 1 deletion docs/Labeler.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The labeler tool is the primary tool that those who will be reviewing the imager

## Labeler quickstart

1. Open the [labeling tool](../src/labeler.html). Note that your project adminstrator may have provided an link that will open up your specific task or may point to a forked version of this tool.
1. Open the [labeling tool](https://microsoft.github.io/satellite-imagery-labeling-tool/src/labeler.html). Note that your project adminstrator may have provided an link that will open up your specific task or may point to a forked version of this tool.
2. Load a labeling project task file - If the URL to the labeler contains something like `?taskUrl=[some text]` the labeler will automatically attempt to load in the project task file. If you have a task file locally, you can open it by going to `Import data -> Local task file` and selecting the local task file. Once loaded the map will zoom into the assigned area and display a yellow dashed outline of the area you are expected to label the imagery within. Instructions from the project administrator may appear and provide some guidance on what data to capture.
3. Use the drawing tools in the top right corner to draw features on the map. Be sure to select the classification of the data below using the panel below the drawing tools. See [Drawing tools documentation](https://learn.microsoft.com/azure/azure-maps/drawing-tools-interactions-keyboard-shortcuts) for details on all the different ways to draw features on the map.
4. When you are done, press the `Save` button on the left side panel, and select the desired output format. The default name and `GeoJSON` file format is often the best option and will allow your project administrator to easily combine your data with a larger data set. Imported data may include a lot of additional metadata/properties on each shape, the `Minimize exported properties` option will remove these by default. See the [Result file format](#result-file-format) section for more details on the output data schema.
Expand Down
2 changes: 1 addition & 1 deletion docs/Project-builder.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The project builder is the tool used by a project administrator to define a labe

## Project Builder quickstart

1. Open the [project builder tool](../src/projectBuilder.html). Note that if you have forked this project you URL will be different.
1. Open the [project builder tool](https://microsoft.github.io/satellite-imagery-labeling-tool/src/projectBuilder.html). Note that if you have forked this project you URL will be different.
2. There are 5 steps to complete. If you have an existing project saved that you want to open and edit, use the "Open existing project" button that appears in the first step.
3. In step one, define the high level information for the project.
- Project name - Required. Specifies the name of the project. This is displayed in the top left corner of the labeler tool when the user loads one of the generated task files. You will not be able to move to the next step until this has been specified.
Expand Down
2 changes: 1 addition & 1 deletion docs/Project-viewer.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The project viewer is the tool used by a project administrator to view and merge
## Project Viewer quickstart

1. If you haven't already, collect the output files created by the labeler for each task and put them into the `results` folder of the output of the project builder. Zip the project builder folder.
2. Open the [project viewer tool](../src/projectViewer.html). Note that if you have forked this project you URL will be different.
2. Open the [project viewer tool](https://microsoft.github.io/satellite-imagery-labeling-tool/src/projectViewer.html). Note that if you have forked this project you URL will be different.
3. Load your project into the viewer by using the "Load existing project" button in the left side panel. Select your zipped project folder that contains the task results in the results folder. When loaded stats for the project will appear in the left side panel. The map will display all the task areas, colored based on the number of labeled features in each area. Red areas indicate that few, if any features, have been labeled in that task area.
4. Use the dropdown in the left side panel to view the invidiual features colored by primary or secondary class.
5. Click the "Merge and export results" button to merge and export the results. The output file is a GeoJSON file containing a feature collection of all the drawn features. Each feature will have details in its properties; at a minium the primary and secondary class, `source`, and `task_name`, the same as the [Result file format](Labeler.md#result-file-format) from the labeler.
10 changes: 5 additions & 5 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,11 @@ <h2>End user tools</h2>

<h2>Documentation</h2>
<ul>
<li><a href="docs/Labeler.md" target="_blank">Labeler tool</a></li>
<li><a href="docs/Project-builder.md" target="_blank">Project builder</a></li>
<li><a href="docs/Project-viewer.md" target="_blank">Project viewer</a></li>
<li><a href="docs/Layers.md" target="_blank">Imagery layers</a></li>
<li><a href="docs/GeoTiffs.md" target="_blank">Using GeoTIFFs as layers</a></li>
<li><a href="https://github.com/microsoft/satellite-imagery-labeling-tool/blob/main/docs/Labeler.md" target="_blank">Labeler tool</a></li>
<li><a href="https://github.com/microsoft/satellite-imagery-labeling-tool/blob/main/docs/Project-builder.md" target="_blank">Project builder</a></li>
<li><a href="https://github.com/microsoft/satellite-imagery-labeling-tool/blob/main/docs/Project-viewer.md" target="_blank">Project viewer</a></li>
<li><a href="https://github.com/microsoft/satellite-imagery-labeling-tool/blob/main/docs/Layers.md" target="_blank">Imagery layers</a></li>
<li><a href="https://github.com/microsoft/satellite-imagery-labeling-tool/blob/main/docs/GeoTiffs.md" target="_blank">Using GeoTIFFs as layers</a></li>
</ul>
</div>

Expand Down

0 comments on commit 9ad3a6d

Please sign in to comment.