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.

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

docs: fix no-inline-html (span tag only) #5148

Merged
merged 2 commits into from
Feb 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
61 changes: 39 additions & 22 deletions general/g.region/g.region.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,9 +124,12 @@ edges. To perform the latter function, use the **raster=***name* option.

### Printing extent and raster resolution in 2D and 3D

<span class="code">` g.region -p `</span>
This will print the current region in the format:

```sh
g.region -p
```

```sh
projection: 1 (UTM)
zone: 13
Expand All @@ -142,10 +145,13 @@ rows: 700
cols: 950
```

<span class="code">` g.region -p3 `</span>
This will print the current region and the 3D region (used for voxels)
in the format:

```sh
g.region -p3
```

```sh
projection: 1 (UTM)
zone: 13
Expand All @@ -169,10 +175,13 @@ cols3: 950
depths: 1
```

<span class="code">` g.region -g `</span>
The **-g** option prints the region in the following script style
(key=value) format:

```sh
g.region -g
```

```sh
n=4928000
s=4914000
Expand All @@ -184,10 +193,13 @@ rows=700
cols=950
```

<span class="code">` g.region -bg `</span>
The **-bg** option prints the region in the following script style
(key=value) format plus the boundary box in latitude-longitude/WGS84:

```sh
g.region -bg
```

```sh
n=4928000
s=4914000
Expand All @@ -203,9 +215,12 @@ LL_N=44.50164277
LL_S=44.37302019
```

<span class="code">` g.region -l `</span>
The **-l** option prints the region in the following format:

```sh
g.region -l
```

```sh
long: -103.86789484 lat: 44.50165890 (north/west corner)
long: -103.62895703 lat: 44.49904013 (north/east corner)
Expand All @@ -217,10 +232,13 @@ Center longitude: 103:44:59.170374W [-103.74977]
Center latitude: 44:26:14.439781N [44.43734]
```

<span class="code">` g.region -pm `</span>
This will print the current region in the format (latitude-longitude
project):

```sh
g.region -pm
```

```sh
projection: 3 (Latitude-Longitude)
zone: 0
Expand All @@ -240,45 +258,44 @@ degrees.

### Changing extent and raster resolution using values

<span class="code">` g.region n=7360100 e=699000 `</span>
will reset the northing and easting for the current region, but leave
`g.region n=7360100 e=699000`
This will reset the northing and easting for the current region, but leave
the south edge, west edge, and the region cell resolutions unchanged.

<span class="code">` g.region n=51:36:05N e=10:10:05E s=51:29:55N w=9:59:55E res=0:00:01 `</span>
will reset the northing, easting, southing, westing and resolution for
`g.region n=51:36:05N e=10:10:05E s=51:29:55N w=9:59:55E res=0:00:01`
This will reset the northing, easting, southing, westing and resolution for
the current region, here in DMS latitude-longitude style (decimal
degrees and degrees with decimal minutes can also be used).

<span class="code">` g.region -dp s=698000 `</span>
will set the current region from the default region for the GRASS
`g.region -dp s=698000`
This will set the current region from the default region for the GRASS
project, reset the south edge to 698000, and then print the result.

<span class="code">` g.region n=n+1000 w=w-500 `</span>
`g.region n=n+1000 w=w-500`
The n=*value* may also be specified as a function of its current value:
n=n+*value* increases the current northing, while n=n-*value* decreases
it. This is also true for s=*value*, e=*value*, and w=*value*. In this
example the current region's northern boundary is extended by 1000 units
and the current region's western boundary is decreased by 500 units.

<span class="code">` g.region n=s+1000 e=w+1000 `</span>
`g.region n=s+1000 e=w+1000`
This form allows the user to set the region boundary values relative to
one another. Here, the northern boundary coordinate is set equal to 1000
units larger than the southern boundary's coordinate value, and the
eastern boundary's coordinate value is set equal to 1000 units larger
than the western boundary's coordinate value. The corresponding forms
s=n-*value* and

w=e-*value* may be used to set the values of the region's southern and
`s=n-value` and
`w=e-value` may be used to set the values of the region's southern and
western boundaries, relative to the northern and eastern boundary
values.

### Changing extent and raster resolution using maps

<span class="code">` g.region raster=soils `</span>
`g.region raster=soils`
This form will make the current region settings exactly the same as
those given in the cell header file for the raster map layer *soils*.

<span class="code">` g.region raster=soils zoom=soils `</span>
`g.region raster=soils zoom=soils`
This form will first look up the cell header file for the raster map
layer *soils*, use this as the current region setting, and then shrink
the region down to the smallest region which still encompasses all
Expand All @@ -287,21 +304,21 @@ non-NULL data in the map layer *soils*. Note that if the parameter
all non-NULL data values in the soils map that were located within the
*current region* settings.

<span class="code">` g.region -up raster=soils `</span>
`g.region -up raster=soils`
The **-u** option suppresses the re-setting of the current region
definition. This can be useful when it is desired to only extract region
information. In this case, the cell header file for the soils map layer
is printed without changing the current region settings.

<span class="code">` g.region -up zoom=soils save=soils `</span>
`g.region -up zoom=soils save=soils`
This will zoom into the smallest region which encompasses all non-NULL
soils data values, and save the new region settings in a file to be
called *soils* and stored under the `windows` directory in the user's
current mapset. The current region settings are not changed.

### Changing extent and raster resolution in 3D

<span class="code">` g.region b=0 t=3000 tbres=200 res3=100 g.region -p3 `</span>
`g.region b=0 t=3000 tbres=200 res3=100 g.region -p3`
This will define the 3D region for voxel computations. In this example a
volume with bottom (0m) to top (3000m) at horizontal resolution (100m)
and vertical resolution (200m) is defined.
Expand Down
27 changes: 5 additions & 22 deletions imagery/i.gensig/i.gensig.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,7 @@ member of the imagery group. Signatures generated for one scene are
suitable for classification of other scenes as long as they consist of
same raster bands (semantic labels match).

## OPTIONS

### Parameters

**trainingmap=***name*
ground truth training map

This map must be prepared by the user in advance using vector or raster
Input **trainingmap** map must be prepared by the user in advance using vector or raster
digitizer. Of course other methods could be devised by the user for
creating this training map - *i.gensig* makes no assumption about the
origin of this map layer. It simply creates signatures for the classes
Expand All @@ -37,28 +30,18 @@ specified in other options - see below). The *[wxGUI vector
digitizer](wxGUI.vdigit.md)* can be used for interactively creating the
training map.

**group=***name*
imagery group

This is the name of the group that contains the band files which
Input **group** is the name of the group that contains the band files which
comprise the image to be analyzed. The *[i.group](i.group.md)* command
is used to construct groups of raster layers which comprise an image.

<span id="subgroup"></span>**subgroup=***name*
subgroup containing image files

This names the subgroup within the group that selects a subset of the
Input **subgroup** names the subgroup within the group that selects a subset of the
bands to be analyzed. The *[i.group](i.group.md)* command is also used
to prepare this subgroup. The subgroup mechanism allows the user to
select a subset of all the band files that form an image.

**signaturefile=***name*
resultant signature file

This is the resultant signature file (containing the means and
Input **signaturefile** is the resultant signature file (containing the means and
covariance matrices) for each class in the training map that is
associated with the band files in the subgroup select (see
[above](#subgroup)). Resultant singature file can be used with any other
associated with the band files in the subgroup select. Resultant singature file can be used with any other
imagery group as long as semantic labels match.

## NOTES
Expand Down
10 changes: 5 additions & 5 deletions imagery/i.gensigset/i.gensigset.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,11 +109,11 @@ accurate training data.
This clustering algorithm estimates both the number of distinct
subclasses in each class, and the spectral mean and covariance for each
subclass. The number of subclasses is estimated using Rissanen's minimum
description length (MDL) criteria \[[1](#rissanen83)\]. This criteria
description length (MDL) criteria (Rissanen, 1983). This criteria
attempts to determine the number of subclasses which "best" describe the
data. The approximate maximum likelihood estimates of the mean and
covariance of the subclasses are computed using the expectation
maximization (EM) algorithm \[[2](#dempster77),[3](#redner84)\].
maximization (EM) algorithm (Dempster, 1977 and Redner, 1984).

## WARNINGS

Expand All @@ -139,13 +139,13 @@ then the user should check for:

## REFERENCES

- <span id="rissanen83">J. Rissanen,</span> "A Universal Prior for
1. J. Rissanen, "A Universal Prior for
Integers and Estimation by Minimum Description Length," *Annals of
Statistics,* vol. 11, no. 2, pp. 417-431, 1983.
- <span id="dempster77">A. Dempster, N. Laird and D. Rubin,</span>
2. A. Dempster, N. Laird and D. Rubin,
"Maximum Likelihood from Incomplete Data via the EM Algorithm," *J.
Roy. Statist. Soc. B,* vol. 39, no. 1, pp. 1-38, 1977.
- <span id="redner84">E. Redner and H. Walker,</span> "Mixture
3. E. Redner and H. Walker, "Mixture
Densities, Maximum Likelihood and the EM Algorithm," *SIAM Review,*
vol. 26, no. 2, April 1984.

Expand Down
Loading
Loading