Skip to content

Enforce equal band shapes in true_color() (#1293) #1301

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.

Sign up for GitHub

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

Merged
brendancol merged 1 commit into from
Apr 29, 2026
Merged

Enforce equal band shapes in true_color() (#1293) #1301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions xrspatial/multispectral.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1793,6 +1793,8 @@ def true_color(r, g, b, nodata=1, c=10.0, th=0.125, name='true_color'):
_validate_raster(g, func_name='true_color', name='g')
_validate_raster(b, func_name='true_color', name='b')

validate_arrays(r, g, b)

mapper = ArrayTypeFunctionMapping(
numpy_func=_true_color_numpy,
dask_func=_true_color_dask,
Expand Down
44 changes: 44 additions & 0 deletions xrspatial/tests/test_multispectral.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -840,6 +840,50 @@ def test_true_color_gpu_memory_guard_raises_when_oversized(monkeypatch):
multispectral._check_true_color_gpu_memory(100_000, 100_000)


def test_true_color_mismatched_shapes_raises():
red = xr.DataArray(np.ones((4, 4), dtype=np.float32), dims=['y', 'x'])
red = red.assign_coords(y=np.arange(4), x=np.arange(4))
green = xr.DataArray(np.ones((4, 5), dtype=np.float32), dims=['y', 'x'])
green = green.assign_coords(y=np.arange(4), x=np.arange(5))
blue = xr.DataArray(np.ones((4, 4), dtype=np.float32), dims=['y', 'x'])
blue = blue.assign_coords(y=np.arange(4), x=np.arange(4))

with pytest.raises(ValueError, match='equal shapes'):
true_color(red, green, blue)


@dask_array_available
def test_true_color_mismatched_shapes_raises_dask():
import dask.array as da
red = xr.DataArray(
da.ones((4, 4), chunks=(2, 2), dtype=np.float32), dims=['y', 'x'])
red = red.assign_coords(y=np.arange(4), x=np.arange(4))
green = xr.DataArray(
da.ones((4, 5), chunks=(2, 2), dtype=np.float32), dims=['y', 'x'])
green = green.assign_coords(y=np.arange(4), x=np.arange(5))
blue = xr.DataArray(
da.ones((4, 4), chunks=(2, 2), dtype=np.float32), dims=['y', 'x'])
blue = blue.assign_coords(y=np.arange(4), x=np.arange(4))

with pytest.raises(ValueError, match='equal shapes'):
true_color(red, green, blue)


def test_true_color_mismatched_backends_raises():
pytest.importorskip('dask.array')
import dask.array as da
red = xr.DataArray(np.ones((4, 4), dtype=np.float32), dims=['y', 'x'])
red = red.assign_coords(y=np.arange(4), x=np.arange(4))
green = xr.DataArray(
da.ones((4, 4), chunks=(2, 2), dtype=np.float32), dims=['y', 'x'])
green = green.assign_coords(y=np.arange(4), x=np.arange(4))
blue = xr.DataArray(np.ones((4, 4), dtype=np.float32), dims=['y', 'x'])
blue = blue.assign_coords(y=np.arange(4), x=np.arange(4))

with pytest.raises(ValueError, match='same type'):
true_color(red, green, blue)


# NDSI ----------
@pytest.fixture
def expected_ndsi():
Expand Down
Loading