aquin.feature_neighbors_check Namespace Reference

Functions
dict[str, Any]	_flatten_feature_neighbors_result (dict[str, Any] result)
tuple[Path, Path]	write_feature_neighbors_check (dict[str, Any] result, *, str|None tool_name, str|Path cwd)
str	_neighbor_label (dict[str, Any] n)
None	_plot_feature_neighbors_check (dict[str, Any] result, Path png_path)

Variables
str	_JSON_NAME = "feature-neighbors-check.json"
str	_PNG_NAME = "feature-neighbors-check.png"

Function Documentation

_flatten_feature_neighbors_result()

dict[str, Any] _flatten_feature_neighbors_result ( dict[str, Any] result )

protected

Definition at line 19 of file feature_neighbors_check.py.

Referenced by write_feature_neighbors_check().

_neighbor_label()

str _neighbor_label ( dict[str, Any] n )

protected

Definition at line 52 of file feature_neighbors_check.py.

Referenced by _plot_feature_neighbors_check().

_plot_feature_neighbors_check()

None _plot_feature_neighbors_check ( dict[str, Any] result, Path png_path )

protected

Definition at line 63 of file feature_neighbors_check.py.

References _neighbor_label().

Referenced by write_feature_neighbors_check().

write_feature_neighbors_check()

tuple[Path, Path] write_feature_neighbors_check	(	dict[str, Any]	result,
		*	,
		str | None	tool_name,
		str | Path	cwd )

Definition at line 31 of file feature_neighbors_check.py.

References _flatten_feature_neighbors_result(), and _plot_feature_neighbors_check().

Variable Documentation

_JSON_NAME

str aquin.feature_neighbors_check._JSON_NAME = "feature-neighbors-check.json"

protected

Definition at line 15 of file feature_neighbors_check.py.

_PNG_NAME

str aquin.feature_neighbors_check._PNG_NAME = "feature-neighbors-check.png"

protected

Definition at line 16 of file feature_neighbors_check.py.