Skip to content

Commit

Permalink
Spelling fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
tariqksoliman committed Apr 18, 2024
1 parent ceb5b97 commit f557a20
Show file tree
Hide file tree
Showing 12 changed files with 29 additions and 28 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ grand_parent: Configure

A remote virtual layer can be supported via various GDAL drivers. The most common is the [GDAL WMS Driver](https://gdal.org/drivers/raster/wms.html). This allows MMGIS to treat remote datasets as if they were local.

## GDAL XML Desciption File Template
## GDAL XML Description File Template

Here is a template of a GDAL XML Description file that may be used to access a remote DEM for the [Measure Tool](/MMGIS/tools/measure).

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/Configure/SPICE/SPICE.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The schema works as follows:
{
"body": {
"{NAIF_BODY_NAME_OR_ID}": {
"desciption": "If a function uses this BODY, it will furnsh() all these direct kernels.",
"description": "If a function uses this BODY, it will furnsh() all these direct kernels.",
"kernels": [
"Full URL to kernel to download",
"Or an object that indicates a meta-kernel (a kernel that lists out other kernels to download):",
Expand Down
5 changes: 3 additions & 2 deletions docs/pages/Database/DrawTool/DrawTool.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ The `user_files` table stores an entry for each file a user created via the Draw
- `file_owner_group`: In special cases, a group of users can be the owner of a file. This is currently hardcoded only for Lead users.
- `file_name`: The name of the drawing file.
- `file_description`: The description of the file. File tags also get encoded into this description field based on the following:

- `~^{str}`: denotes that this file is in a `{tag}` elevated(/prioritized) folder of the Draw Tool.
- `~@{str}`: denotes that this file is in a `{tag}` folder of the Draw Tool.
- `~#{str}`: denotes that this file has a tag of the name `{str}`.
Expand All @@ -47,7 +48,7 @@ The `file_histories` table provides a complete representation of all Draw Tool f

- `file_id`: The id of the `user_files` file this history entry belongs to.
- `history_id`: An incrementing id that work per file_id.
- `time`: A Unix timestamp of when the drawing action occured.
- `time`: A Unix timestamp of when the drawing action occurred.
- `action_index`: An id for what action was performed.
- 0: add
- 1: edit
Expand Down Expand Up @@ -75,7 +76,7 @@ The `user_features` table stores every Draw Tool feature and with PostGIS encode

### published_stores

In the Draw Tool, Lead users can copy features from various layers into a Lead layer and then publish that layer. Publishing requires various checks to take place such as no duplicate names, no duplicate uuids, certain features must be fully contained within others, what are a polygon's children, etc. The `published_stores` table stores the intermediary spatial, relational and heirarchical metadata in performing this validation. This metadata speeds up a spatial search API that is not yet released publically.
In the Draw Tool, Lead users can copy features from various layers into a Lead layer and then publish that layer. Publishing requires various checks to take place such as no duplicate names, no duplicate uuids, certain features must be fully contained within others, what are a polygon's children, etc. The `published_stores` table stores the intermediary spatial, relational and hierarchical metadata in performing this validation. This metadata speeds up a spatial search API that is not yet released publicly.

### publisheds

Expand Down
4 changes: 2 additions & 2 deletions docs/pages/Scripts/scripts.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ _Notes:_

## Compositing Tiles:

Adds the resampling algorithm `near-composite` that uses nearest-neighbor resampling and overlays the new tile onto the old tile (if any in output directory). This makes it possible to accumulate or combine tilesets at the indivdual tile image level. Data in tiles can be overwritten by this process so be cognizant of run order and input extents.
Adds the resampling algorithm `near-composite` that uses nearest-neighbor resampling and overlays the new tile onto the old tile (if any in output directory). This makes it possible to accumulate or combine tilesets at the individual tile image level. Data in tiles can be overwritten by this process so be cognizant of run order and input extents.

**Example:**

Expand All @@ -95,7 +95,7 @@ _Notes:_

_Python 3.10.5_

A convience script that wraps gda2customtiles.py. Translates the input data into EPSG:4326 and sets proper ground control points. Might be outdated. Use gdal2customtiles directly for the most control.
A convenience script that wraps gda2customtiles.py. Translates the input data into EPSG:4326 and sets proper ground control points. Might be outdated. Use gdal2customtiles directly for the most control.

**Usage:**
`rasters2customtiles.py [options] input_file [output]` or see `--help`
2 changes: 1 addition & 1 deletion docs/pages/Setup/Installation/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Run: `docker-compose up -d`

1. Click `NEW MISSION`
Enter a new mission name and click `MAKE MISSION`
Optiona;" (Use the mission name `"Test"` (case-sensitive) to make the sample mission)
Optional: (Use the mission name `"Test"` (case-sensitive) to make the sample mission)

Navigate to `http://localhost:8888`.

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/Tools/Isochrone/Isochrone.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,4 @@ This section may have additional options specified by the selected model.

## Technical

The Isochrone tool runs a version of Dijkstra's algorithm on tiled data to generate results. In this implementation, every pixel is a vertex which is implicitly connected by an edge to 16 of its neighbors: its 8 immediate neighbors, plus neigbors that can be reached by the "knight's move" - i.e. the move a knight makes on a chessboard. Analysis is performed entirely in-browser in JavaScript.
The Isochrone tool runs a version of Dijkstra's algorithm on tiled data to generate results. In this implementation, every pixel is a vertex which is implicitly connected by an edge to 16 of its neighbors: its 8 immediate neighbors, plus neighbors that can be reached by the "knight's move" - i.e. the move a knight makes on a chessboard. Analysis is performed entirely in-browser in JavaScript.
8 changes: 4 additions & 4 deletions docs/pages/Tools/Shade/Shade.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ There are two SPICE python scripts that require these backend kernel setups:
- `/private/api/spice/ll2aer11.py`
- Turns a lnglat and target into a directional azimuth, elevation, range, and lntlat
- Reads in all kernels `/private/api/spice/kernels`.
- `/private/api/spice/getKernelUtils` has some wget scripts as examples for downloadign new kernels (however these resources will quickly become outdated)
- `/private/api/spice/getKernelUtils` has some wget scripts as examples for downloading new kernels (however these resources will quickly become outdated)

## Tool Configuration

Expand Down Expand Up @@ -88,7 +88,7 @@ _**utcTimeFormat**_ - Sets the placeholder information for when the observer tim

## Tool Use

**Note:** Terrain beyond the screen's current extent is **not** factored into the displayed visiblity map — only observer-target direction and on-screen terrain is considered. A distant off-screen mountain will **not** cast shadows.
**Note:** Terrain beyond the screen's current extent is **not** factored into the displayed visibility map — only observer-target direction and on-screen terrain is considered. A distant off-screen mountain will **not** cast shadows.

### Interface

Expand All @@ -109,7 +109,7 @@ _**utcTimeFormat**_ - Sets the placeholder information for when the observer tim
- _Time_
- Offers the ability to set the current working time using a mission/spacecraft's custom date type.
- _Height_
- Height in meters above the surface to use when calculating line-of-sight shading. For instance, a point on the surface (0m) may not be visible to a 'Source Entity', say the Mars Reconnaissance Orbiter (MRO), but 2m above that point may be. This value does not _only_ apply to the center longtitude and latitude but to all points on the visible terrain. Gradually increaing this value shows the shade map n-meters above the surface.
- Height in meters above the surface to use when calculating line-of-sight shading. For instance, a point on the surface (0m) may not be visible to a 'Source Entity', say the Mars Reconnaissance Orbiter (MRO), but 2m above that point may be. This value does not _only_ apply to the center longitude and latitude but to all points on the visible terrain. Gradually increasing this value shows the shade map n-meters above the surface.

#### Shaded Region Options

Expand All @@ -118,7 +118,7 @@ _**utcTimeFormat**_ - Sets the placeholder information for when the observer tim
- _Opacity_
- The opaqueness to shade the shadowed regions on the map. A value of 0 is fully transparent and a value of 1 is fully opaque.
- _Resolution_
- MMGIS downloads terrain data needed for the shading alogrithm. Increasing the resolution improves the quality of the shade map and the cost of download and render speed. Each higher option is 4x the resolution of the previous one (i.e. 'ultra' is 4x more terrain data than 'high' and 16x more data than 'medium'). To save on performance, if the resolution is 'high' or 'ultra', the Shade Tool will no longer regenerate the shaded map whenever any parameter changes and instead 'Generate/Regenerate' must manually be pressed.
- MMGIS downloads terrain data needed for the shading algorithm. Increasing the resolution improves the quality of the shade map and the cost of download and render speed. Each higher option is 4x the resolution of the previous one (i.e. 'ultra' is 4x more terrain data than 'high' and 16x more data than 'medium'). To save on performance, if the resolution is 'high' or 'ultra', the Shade Tool will no longer regenerate the shaded map whenever any parameter changes and instead 'Generate/Regenerate' must manually be pressed.
- _Elevation Map_

- Specifies the terrain dataset to use.
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/markdowns/Remote_Virtual_Layer.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

A remote virtual layer can be supported via various GDAL drivers. The most common is the [GDAL WMS Driver](https://gdal.org/drivers/raster/wms.html). This allows MMGIS to treat remote datasets as if they were local.

## GDAL XML Desciption File Template
## GDAL XML Description File Template

Here is a template of a GDAL XML Description file that may be used to access a remote DEM for the [Measure Tool](?page=Measure).

```xml
<GDAL_WMS>
<Service name="WMS">
<!-- recommend Version 1.1.1; Version 1.3 uses different bounding box definition -->
<Version>1.1.1</Version>
<Version>1.1.1</Version>
<!-- root URL of WMS service -->
<ServerUrl>http://localhost/map/?</ServerUrl>
<!-- projection of the source dataset -->
Expand Down
4 changes: 2 additions & 2 deletions public/helps/InfoTool.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Click any vector feature in the Map to view its properties.

### Header Actions

- _Eye:_ This hides (or unhides) the active feature. This is useful if you want a very specific and individually curated view for, say, a screenshot and the Fitlering functionality in the Layers Tool doesn't quite cut it. Deep Links do not store which features are hidden nor do they persist through page reload. If any number of features are hidden, a green eye button will appear next to this one to provide the way to reshow all hidden features.
- _Eye:_ This hides (or unhides) the active feature. This is useful if you want a very specific and individually curated view for, say, a screenshot and the Filtering functionality in the Layers Tool doesn't quite cut it. Deep Links do not store which features are hidden nor do they persist through page reload. If any number of features are hidden, a green eye button will appear next to this one to provide the way to reshow all hidden features.
- _Clipboard:_ Copies the current feature's geometry and properties to your clipboard.
- _Target:_ Pans and zooms to the cuurent feature in the Map.
- _Target:_ Pans and zooms to the current feature in the Map.

### Feature Dropdown

Expand Down
2 changes: 1 addition & 1 deletion public/helps/LayersTool.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ A hierarchical list of available layers.
- Layers above (closer to the top) render on top of layers below them.
- Vector layers _always_ render on top of raster layers (regardless of position).
- Layers can be reordered by dragging their left-side color handles.
- Layers can be toggled by clicking the chceckboxes to the left of their names.
- Layers can be toggled by clicking the checkboxes to the left of their names.
- Hovering over a layer exposes buttons to download the layer, change its settings and view more information.
- In addition to the various filters at the top of the tool, enter a "#" in the 'Search Layers' box to filter on layer tags (if any).

Expand Down
8 changes: 4 additions & 4 deletions public/helps/ShadeTool.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

_Shades the ground when line-of-sights to an orbiting target are occluded._

**Note:** Terrain beyond the screen's current extent is **not** factored into the displayed visiblity map — only observer-target direction and on-screen terrain is considered. A distant off-screen mountain will **not** cast shadows.
**Note:** Terrain beyond the screen's current extent is **not** factored into the displayed visibility map — only observer-target direction and on-screen terrain is considered. A distant off-screen mountain will **not** cast shadows.

### Interface

Expand All @@ -23,7 +23,7 @@ _Shades the ground when line-of-sights to an orbiting target are occluded._
- _Time_
- Offers the ability to set the current working time using a mission/spacecraft's custom date type.
- _Height_
- Height in meters above the surface to use when calculating line-of-sight shading. For instance, a point on the surface (0m) may not be visible to a 'Source Entity', say the Mars Reconnaissance Orbiter (MRO), but 2m above that point may be. This value does not _only_ apply to the center longtitude and latitude but to all points on the visible terrain. Gradually increaing this value shows the shade map n-meters above the surface.
- Height in meters above the surface to use when calculating line-of-sight shading. For instance, a point on the surface (0m) may not be visible to a 'Source Entity', say the Mars Reconnaissance Orbiter (MRO), but 2m above that point may be. This value does not _only_ apply to the center longtitude and latitude but to all points on the visible terrain. Gradually increasing this value shows the shade map n-meters above the surface.

#### Shaded Region Options

Expand All @@ -32,11 +32,11 @@ _Shades the ground when line-of-sights to an orbiting target are occluded._
- _Opacity_
- The opaqueness to shade the shadowed regions on the map. A value of 0 is fully transparent and a value of 1 is fully opaque.
- _Resolution_
- MMGIS downloads terrain data needed for the shading alogrithm. Increasing the resolution improves the quality of the shade map and the cost of download and render speed. Each higher option is 4x the resolution of the previous one (i.e. 'ultra' is 4x more terrain data than 'high' and 16x more data than 'medium'). To save on performance, if the resolution is 'high' or 'ultra', the Shade Tool will no longer regenerate the shaded map whenever any parameter changes and instead 'Generate/Regenerate' must manually be pressed.
- MMGIS downloads terrain data needed for the shading algorithm. Increasing the resolution improves the quality of the shade map and the cost of download and render speed. Each higher option is 4x the resolution of the previous one (i.e. 'ultra' is 4x more terrain data than 'high' and 16x more data than 'medium'). To save on performance, if the resolution is 'high' or 'ultra', the Shade Tool will no longer regenerate the shaded map whenever any parameter changes and instead 'Generate/Regenerate' must manually be pressed.
- The generated viewshed is zoom-dependent. If you are zoomed in far enough, all resolutions will behave the same. If you are zoomed out far enough, all resolutions will behave differently. For instance assuming a 50m data resolution, we'd have:
1. At ≤ 50m zoom scale, all four resolutions are the same.
2. At 100m zoom scale, Ultra, High, and Medium are all the same.
3. At 200m zoom scale, Ultra amd High are the same.
3. At 200m zoom scale, Ultra and High are the same.
4. At ≥ 400m zoom scale, all four resolutions result in different maps.
- _Elevation Map_
- Specifies the terrain dataset to use.
Expand Down
14 changes: 7 additions & 7 deletions public/helps/ViewshedTool.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ _Real-time line-of-sight visibility maps_

- _Checkbox_
- Toggles the viewshed on and off.
- _Editting Icon_
- In the case of multiple viewsheds, if the viewshed is being editted, it means clicking and interacting with the map will set its observer point.
- _Editing Icon_
- In the case of multiple viewsheds, if the viewshed is being edited, it means clicking and interacting with the map will set its observer point.
- _Viewshed Name_
- An edittable viewshed name.
- An editable viewshed name.
- _3D_
- Click to view the viewshed in 3D. (May not be supported depending on configuration.)
- _Options_
Expand All @@ -33,11 +33,11 @@ _Real-time line-of-sight visibility maps_
- _Opacity_
- The opacity/transparency to render the viewshed on the map.
- _Resolution_
- MMGIS downloads terrain data needed for the shading alogrithm. Increasing the resolution improves the quality of the shade map and the cost of download and render speed. Each higher option is 4x the resolution of the previous one (i.e. 'ultra' is 4x more terrain data than 'high' and 16x more data than 'medium'). To save on performance, if the resolution is 'high' or 'ultra', the Shade Tool will no longer regenerate the shaded map whenever any parameter changes and instead 'Generate/Regenerate' must manually be pressed.
- MMGIS downloads terrain data needed for the shading algorithm. Increasing the resolution improves the quality of the shade map and the cost of download and render speed. Each higher option is 4x the resolution of the previous one (i.e. 'ultra' is 4x more terrain data than 'high' and 16x more data than 'medium'). To save on performance, if the resolution is 'high' or 'ultra', the Shade Tool will no longer regenerate the shaded map whenever any parameter changes and instead 'Generate/Regenerate' must manually be pressed.
- The generated viewshed is zoom-dependent. If you are zoomed in far enough, all resolutions will behave the same. If you are zoomed out far enough, all resolutions will behave differently. For instance assuming a 50m data resolution, we'd have:
1. At ≤ 50m zoom scale, all four resolutions are the same.
2. At 100m zoom scale, Ultra, High, and Medium are all the same.
3. At 200m zoom scale, Ultra amd High are the same.
3. At 200m zoom scale, Ultra and High are the same.
4. At ≥ 400m zoom scale, all four resolutions result in different maps.
- _Reverse_
- Whether to invert the viewshedded region. If true, then all the colored regions are **not** visible.
Expand All @@ -56,9 +56,9 @@ _Real-time line-of-sight visibility maps_
- _Center Elevation_
- Tilt angle in degrees in which the observer is looking. 0 is level with the horizon, 90 is looking straight up and -90 is straight down.
- _Latitude_
- Latitude position of the observer. Clicking on the map or draggin the observer marker will also prefill this.
- Latitude position of the observer. Clicking on the map or dragging the observer marker will also prefill this.
- _Longitude_
- Longitude position of the observer. Clicking on the map or draggin the observer marker will also prefill this.
- Longitude position of the observer. Clicking on the map or dragging the observer marker will also prefill this.

#### Footer

Expand Down

0 comments on commit f557a20

Please sign in to comment.