Skip to content

Commit ed1ba89

Browse files
committed
Remove unnecessary content from the techref for patterns
1 parent 3031c59 commit ed1ba89

File tree

1 file changed

+2
-19
lines changed

1 file changed

+2
-19
lines changed

doc/techref/patterns.md

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,7 @@
1-
# Bit and Hachure Patterns
1+
# 90 Predefined Bit and Hachure Patterns
22

33
PyGMT supports a variety of bit and hachure patterns that can be used to fill polygons.
4-
5-
These patterns can be defined using the following syntax:
6-
7-
**P**|**p**_pattern_[**+b**_color_][**+f**_color_][**+r**_dpi_]
8-
9-
*pattern* can either be a number in the range 1-90 or the name of a 1-, 8-, or 24-bit
10-
image raster file. The former will result in one of the 90 predefined 64x64 bit-patterns
11-
provided by GMT (see the figure below). The latter allows the user to create customized,
12-
repeating images using image raster files.
13-
14-
By specifying uppercase **P** instead of **p** the image will be bit-reversed, i.e.,
15-
white and black areas will be interchanged (only applies to 1-bit images or predefined
16-
bit-image patterns). For these patterns and other 1-bit images one may specify
17-
alternative **b**ackground and **f**oreground colors (by appending **+b**_color_ and/or
18-
**+f**_color_) that will replace the default white and black pixels, respectively.
19-
Excluding *color* from a fore- or background specification yields a transparent image
20-
where only the back- or foreground pixels will be painted. The **+r**_dpi_ modifier sets
21-
the resolution in dpi.
4+
These patterns can be specified via the {class}`pygmt.params.Pattern` class.
225

236
The image below shows the 90 predefined bit patterns that can be used in PyGMT.
247

0 commit comments

Comments
 (0)