publiplots.get_hatch_patterns

publiplots.get_hatch_patterns(mode=None)

Get hatch patterns for a specified density mode.

The density mode controls how dense/sparse the hatch patterns are by multiplying the base patterns:

• Mode 1: base × 1 (e.g., ‘/’, ‘.’ becomes ‘/’, ‘.’)

• Mode 2: base × 2 (e.g., ‘/’, ‘.’ becomes ‘//’, ‘..’)

• Mode 3: base × 3 (e.g., ‘/’, ‘.’ becomes ‘///’, ‘…’)

• Mode 4: base × 4 (e.g., ‘/’, ‘.’ becomes ‘////’, ‘….’)

Denser patterns provide stronger visual distinction but may appear cluttered in small plot areas. Mode 1 is recommended for most use cases.

Parameters:

mode (int, optional) – Pattern density mode (1, 2, 3, 4). If None, uses the current global mode set by set_hatch_mode() or DEFAULT_HATCH_MODE from config.

Returns:

List of hatch pattern strings.

Return type:

List[str]

Raises:

ValueError – If mode is not 1, 2, 3, or 4.

Examples

Get mode 1 patterns: >>> patterns = get_hatch_patterns(mode=1) >>> patterns[1] # ‘/’ ‘/’

Get mode 3 (dense) patterns: >>> patterns = get_hatch_patterns(mode=3) >>> patterns[1] # Forward diagonal ‘///’

Use current global mode: >>> set_hatch_mode(2) >>> patterns = get_hatch_patterns() # Uses mode 2