Texture Features API
pictologics.features.texture
Texture Feature Extraction Module
This module provides a comprehensive suite of functions for calculating 3D texture features from medical images. It implements the Image Biomarker Standardisation Initiative (IBSI) compliant algorithms for various texture matrices.
Key Concepts:
Texture analysis quantifies the spatial arrangement of grey levels in an image. It assumes that the texture (e.g., "smooth", "coarse", "regular") is contained in the spatial relationship between the grey levels of the voxels.
Implemented Matrices:
-
GLCM (Grey Level Co-occurrence Matrix): Counts how often pairs of grey levels occur at a specific distance and direction. Captures: Contrast, homogeneity, correlation.
-
GLRLM (Grey Level Run Length Matrix): Counts the lengths of consecutive runs of the same grey level. Captures: Coarseness, directionality.
-
GLSZM (Grey Level Size Zone Matrix): Counts the size of zones (connected components) of the same grey level. Captures: Regional homogeneity, size distribution of texture elements.
-
GLDZM (Grey Level Distance Zone Matrix): Counts zones based on their distance from the ROI border. Captures: Spatial distribution relative to the boundary.
-
NGTDM (Neighbourhood Grey Tone Difference Matrix): Quantifies the difference between a voxel and its neighbours. Captures: Human perception of texture (coarseness, contrast, busyness).
-
NGLDM (Neighbourhood Grey Level Dependence Matrix): Captures the dependence of grey levels on their neighbours. Captures: Dependence, spatial relationships.
Optimization:
This module uses numba for Just-In-Time (JIT) compilation to achieve high performance.
The core calculations are parallelized and optimized for memory usage.
- Single-pass calculation: Multiple matrices are computed in a single pass over the image
to minimize memory access overhead.
- Flattened DFS: Zone-based features (GLSZM, GLDZM) use a memory-efficient Depth-First Search
with flattened stack indices.
Usage:
The main entry point is calculate_all_texture_matrices, which computes all raw matrices.
Then, specific feature calculation functions (e.g., calculate_glcm_features) can be called
using these matrices.
Example
Calculate texture features:
import numpy as np
from pictologics.features.texture import (
calculate_all_texture_matrices,
calculate_glcm_features
)
# Create dummy data
data = np.random.randint(1, 33, (50, 50, 50))
mask = np.ones((50, 50, 50))
# Calculate matrices
matrices = calculate_all_texture_matrices(data, mask, n_bins=32)
# Extract features
glcm_feats = calculate_glcm_features(
data,
mask,
n_bins=32,
glcm_matrix=matrices['glcm']
)
print(glcm_feats['contrast_ACUI'])
calculate_all_texture_features(disc_array, mask_array, n_bins, distance_mask_array=None, ngldm_alpha=0)
Calculate all texture features (GLCM, GLRLM, GLSZM, GLDZM, NGTDM, NGLDM).
This is a convenience wrapper that computes all texture matrices and then extracts all available features.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
disc_array
|
NDArray[floating[Any]]
|
Discretised image array. |
required |
mask_array
|
NDArray[floating[Any]]
|
Mask array (ROI). |
required |
n_bins
|
int
|
Number of bins. |
required |
distance_mask_array
|
Optional[NDArray[floating[Any]]]
|
Optional mask for GLDZM distance calculation. If None, mask_array is used. |
None
|
ngldm_alpha
|
int
|
The coarseness parameter α for NGLDM. Two grey levels are considered dependent if their absolute difference is ≤ α. Default is 0 (IBSI standard). |
0
|
Returns:
| Type | Description |
|---|---|
dict[str, float]
|
Dictionary of all texture features. |
Source code in pictologics/features/texture.py
1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 | |
calculate_all_texture_matrices(data, mask, n_bins, distance_mask=None, ngldm_alpha=0)
Calculate all texture matrices (GLCM, GLRLM, GLSZM, GLDZM, NGTDM, NGLDM) in an optimized single pass.
This function serves as the computational backbone for texture analysis. It computes the raw matrices required to extract specific texture features. By aggregating these calculations, it minimizes the number of passes over the image data, significantly improving performance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
NDArray[floating[Any]]
|
The 3D image array containing discretised grey levels. Values should be integers in the range [1, n_bins]. |
required |
mask
|
NDArray[floating[Any]]
|
The 3D binary mask array defining the Region of Interest (ROI).
Must have the same shape as |
required |
n_bins
|
int
|
The number of grey levels used for discretization (e.g., 16, 32, 64). This determines the size of the resulting matrices. |
required |
distance_mask
|
Optional[NDArray[floating[Any]]]
|
Optional mask used to calculate the distance map for GLDZM.
If None, |
None
|
ngldm_alpha
|
int
|
The coarseness parameter α for NGLDM calculation. Two grey levels are considered dependent if their absolute difference is ≤ α. Default is 0 (exact match), which is the IBSI standard. Use α=1 for tolerance of ±1 grey level difference. |
0
|
Returns:
| Type | Description |
|---|---|
dict[str, Any]
|
dict[str, Any]: A dictionary containing the calculated texture matrices: - 'glcm' (npt.NDArray[np.floating[Any]]): Grey Level Co-occurrence Matrix. Shape: (n_dirs, n_bins, n_bins). - 'glrlm' (npt.NDArray[np.floating[Any]]): Grey Level Run Length Matrix. Shape: (n_dirs, n_bins, max_run_length). - 'ngtdm_s' (npt.NDArray[np.floating[Any]]): NGTDM Sum of absolute differences. Shape: (n_bins,). - 'ngtdm_n' (npt.NDArray[np.floating[Any]]): NGTDM Number of valid voxels. Shape: (n_bins,). - 'ngldm' (npt.NDArray[np.floating[Any]]): Neighbouring Grey Level Dependence Matrix. Shape: (n_bins, n_dependence). - 'glszm' (npt.NDArray[np.floating[Any]]): Grey Level Size Zone Matrix. Shape: (n_bins, max_zone_size). - 'gldzm' (npt.NDArray[np.floating[Any]]): Grey Level Distance Zone Matrix. Shape: (n_bins, max_distance). |
Example
Calculate all texture matrices:
import numpy as np
from pictologics.features.texture import calculate_all_texture_matrices
# Create dummy data
data = np.random.randint(1, 33, (50, 50, 50))
mask = np.ones((50, 50, 50))
# Calculate matrices
matrices = calculate_all_texture_matrices(data, mask, n_bins=32)
print(matrices['glcm'].shape)
# (13, 32, 32)
Source code in pictologics/features/texture.py
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 | |
calculate_glcm_features(data, mask, n_bins, glcm_matrix=None)
Calculate Grey Level Co-occurrence Matrix (GLCM) features.
The GLCM describes the second-order statistical distribution of grey levels in the ROI.
It counts how often pairs of grey levels occur at a specific distance and direction.
This implementation computes features based on the 3D merged GLCM (averaged over all 13 directions),
making the features rotationally invariant.
**IBSI Reference**: Section 3.6 (Grey Level Co-occurrence Based Features).
**Mathematical Definition**:
Let $P(i,j)$ be the co-occurrence matrix, where $i$ and $j$ are grey levels.
The matrix is normalized such that $\sum_{i,j} P(i,j) = 1$.
**Calculated Features**:
* Joint Maximum (GYBY)
* Joint Average (60VM)
* Joint Variance (UR99)
* Joint Entropy (TU9B)
* Difference Average (TF7R)
* Difference Variance (D3YU)
* Difference Entropy (NTRS)
* Sum Average (ZGXS)
* Sum Variance (OEEB)
* Sum Entropy (P6QZ)
* Angular Second Moment (8ZQL)
* Contrast (ACUI)
* Dissimilarity (8S9J)
* Inverse Difference (IB1Z)
* Normalised Inverse Difference (NDRX)
* Inverse Difference Moment (WF0Z)
* Normalised Inverse Difference Moment (1QCO)
* Inverse Variance (E8JP)
* Correlation (NI2N)
* Autocorrelation (QWB0)
* Cluster Tendency (DG8W)
* Cluster Shade (7NFM)
* Cluster Prominence (AE86)
* Information Correlation 1 (R8DG)
* Information Correlation 2 (JN9H)
Args:
data (npt.NDArray[np.floating[Any]]): The 3D image array containing discretised grey levels.
mask (npt.NDArray[np.floating[Any]]): The 3D binary mask array defining the ROI.
n_bins (int): The number of grey levels.
glcm_matrix (Optional[npt.NDArray[np.floating[Any]]]): Pre-calculated GLCM matrix. If provided, `data` and `mask`
are ignored for matrix calculation, but `data` is still used for `Ng` estimation if needed.
If None, the matrix is calculated from scratch.
Returns:
dict[str, float]: A dictionary of calculated GLCM features, keyed by their name and IBSI code.
Example keys: 'joint_maximum_GYBY', 'contrast_ACUI', 'correlation_NI2N'.
Example:
```python
import numpy as np
from numpy import typing as npt # ... assuming data and mask defined ... features = calculate_glcm_features(data, mask, n_bins=32) print(features['contrast_ACUI']) ``` 12.5
Source code in pictologics/features/texture.py
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 | |
calculate_gldzm_features(data, mask, n_bins, gldzm_matrix=None, distance_mask=None)
Calculate Grey Level Distance Zone Matrix (GLDZM) features.
The GLDZM counts the number of zones of linked voxels with the same grey level, categorized by the distance of the zone from the ROI border. This captures information about the spatial distribution of textures relative to the boundary.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
NDArray[floating[Any]]
|
The 3D image array containing discretised grey levels. |
required |
mask
|
NDArray[floating[Any]]
|
The 3D binary mask array defining the ROI. |
required |
n_bins
|
int
|
The number of grey levels. |
required |
gldzm_matrix
|
Optional[NDArray[floating[Any]]]
|
Pre-calculated GLDZM matrix. |
None
|
distance_mask
|
Optional[NDArray[floating[Any]]]
|
Optional mask used to calculate the distance map.
If None, |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, float]
|
dict[str, float]: A dictionary of calculated GLDZM features. Example keys: 'small_distance_emphasis_0GBI', 'zone_distance_entropy_GBDU'. |
Source code in pictologics/features/texture.py
1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 | |
calculate_glrlm_features(data, mask, n_bins, glrlm_matrix=None)
Calculate Grey Level Run Length Matrix (GLRLM) features.
The GLRLM quantifies grey level runs, which are defined as the length in number of pixels, of consecutive pixels that have the same grey level value. This implementation computes features based on the 3D merged GLRLM (averaged over all 13 directions).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
NDArray[floating[Any]]
|
The 3D image array containing discretised grey levels. |
required |
mask
|
NDArray[floating[Any]]
|
The 3D binary mask array defining the ROI. |
required |
n_bins
|
int
|
The number of grey levels. |
required |
glrlm_matrix
|
Optional[NDArray[floating[Any]]]
|
Pre-calculated GLRLM matrix. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, float]
|
dict[str, float]: A dictionary of calculated GLRLM features. Example keys: 'short_runs_emphasis_22OV', 'grey_level_non_uniformity_R5YN'. |
Source code in pictologics/features/texture.py
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 | |
calculate_glszm_features(data, mask, n_bins, glszm_matrix=None)
Calculate Grey Level Size Zone Matrix (GLSZM) features.
The GLSZM counts the number of zones (connected components) of linked voxels that share the same grey level intensity. A zone is defined as a group of connected voxels with the same grey level. This matrix is rotationally invariant by definition.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
NDArray[floating[Any]]
|
The 3D image array containing discretised grey levels. |
required |
mask
|
NDArray[floating[Any]]
|
The 3D binary mask array defining the ROI. |
required |
n_bins
|
int
|
The number of grey levels. |
required |
glszm_matrix
|
Optional[NDArray[floating[Any]]]
|
Pre-calculated GLSZM matrix. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, float]
|
dict[str, float]: A dictionary of calculated GLSZM features. Example keys: 'small_zone_emphasis_P001', 'zone_percentage_P30P'. |
Source code in pictologics/features/texture.py
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 | |
calculate_ngldm_features(data, mask, n_bins, ngldm_matrix=None, ngldm_alpha=0)
Calculate Neighbourhood Grey Level Dependence Matrix (NGLDM) features.
The NGLDM captures the dependence of grey levels on their neighbours. A "dependence" is defined as a connected voxel having a similar grey level (within a tolerance α).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
NDArray[floating[Any]]
|
The 3D image array containing discretised grey levels. |
required |
mask
|
NDArray[floating[Any]]
|
The 3D binary mask array defining the ROI. |
required |
n_bins
|
int
|
The number of grey levels. |
required |
ngldm_matrix
|
Optional[NDArray[floating[Any]]]
|
Pre-calculated NGLDM matrix. |
None
|
ngldm_alpha
|
int
|
The coarseness parameter α. Two grey levels are considered dependent if their absolute difference is ≤ α. Default is 0 (exact match, IBSI standard). |
0
|
Returns:
| Type | Description |
|---|---|
dict[str, float]
|
dict[str, float]: A dictionary of calculated NGLDM features. Example keys: 'low_dependence_emphasis_SODN', 'dependence_count_entropy_FCBV'. |
Source code in pictologics/features/texture.py
1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 | |
calculate_ngtdm_features(data, mask, n_bins, ngtdm_matrices=None)
Calculate Neighbourhood Grey Tone Difference Matrix (NGTDM) features.
The NGTDM quantifies the difference between a grey value and the average grey value of its neighbours. It captures the coarseness and contrast of the texture.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
NDArray[floating[Any]]
|
The 3D image array containing discretised grey levels. |
required |
mask
|
NDArray[floating[Any]]
|
The 3D binary mask array defining the ROI. |
required |
n_bins
|
int
|
The number of grey levels. |
required |
ngtdm_matrices
|
Optional[tuple[NDArray[floating[Any]], NDArray[floating[Any]]]]
|
Pre-calculated NGTDM matrices
(sum of absolute differences |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, float]
|
dict[str, float]: A dictionary of calculated NGTDM features. Example keys: 'coarseness_QCDE', 'contrast_65HE', 'busyness_NQ30'. |
Source code in pictologics/features/texture.py
1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 | |
calculate_zone_features(data, mask, dist_map, n_bins, calc_glszm=True, calc_gldzm=True)
Wrapper for _calculate_zone_features_numba with buffer pooling.
This function manages pre-allocated buffers to reduce memory allocation overhead for repeated calls (e.g., during batch processing).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
NDArray[floating[Any]]
|
3D discretized image data. |
required |
mask
|
NDArray[floating[Any]]
|
3D mask array (not modified - copied internally by JIT function). |
required |
dist_map
|
NDArray[floating[Any]]
|
3D distance map for GLDZM. |
required |
n_bins
|
int
|
Number of grey level bins. |
required |
calc_glszm
|
bool
|
Whether to calculate GLSZM. |
True
|
calc_gldzm
|
bool
|
Whether to calculate GLDZM. |
True
|
Returns:
| Type | Description |
|---|---|
tuple[NDArray[floating[Any]], NDArray[floating[Any]]]
|
Tuple of (glszm, gldzm) matrices. |