Skip to content
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.

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

Optional gamma correction parameter #350

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
"cachetools>=3.1.0",
"click",
"click-spinner",
"color-operations",
"flask",
"flask_cors",
"marshmallow>=3.0.0",
Expand Down
22 changes: 20 additions & 2 deletions terracotta/handlers/rgb.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ def rgb(
tile_xyz: Optional[Tuple[int, int, int]] = None,
*,
stretch_ranges: Optional[ListOfRanges] = None,
color_transform: Optional[str] = None,
tile_size: Optional[Tuple[int, int]] = None
) -> BinaryIO:
"""Return RGB image as PNG
Expand Down Expand Up @@ -80,6 +81,7 @@ def get_band_future(band_key: str) -> Future:
futures = [get_band_future(key) for key in rgb_values]
band_items = zip(rgb_values, stretch_ranges_, futures)

out_ranges = []
out_arrays = []

for i, (band_key, band_stretch_override, band_data_future) in enumerate(
Expand All @@ -88,7 +90,8 @@ def get_band_future(band_key: str) -> Future:
keys = (*some_keys, band_key)
metadata = driver.get_metadata(keys)

band_stretch_range = list(metadata["range"])
band_range = list(metadata["range"])
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why introduce this variable? Looks unused.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh now I see, you're using this further below. But beware, since you're setting this in a loop only the value for the last band will be used in the color transform!

band_stretch_range = band_range.copy()
scale_min, scale_max = band_stretch_override

percentiles = metadata.get("percentiles", [])
Expand All @@ -104,7 +107,22 @@ def get_band_future(band_key: str) -> Future:
)

band_data = band_data_future.result()
out_arrays.append(image.to_uint8(band_data, *band_stretch_range))

out_ranges.append(band_stretch_range)
out_arrays.append(band_data)

band_data = np.ma.stack(out_arrays, axis=0)

if color_transform:
out_ranges = [np.array(band_rng, dtype=band_data.dtype) for band_rng in out_ranges]
out_ranges = np.ma.stack(out_ranges, axis=0)

out_ranges = image.apply_color_transform(out_ranges, color_transform, band_range)
band_data = image.apply_color_transform(band_data, color_transform, band_range)

out_arrays = []
for k in range(band_data.shape[0]):
out_arrays.append(image.to_uint8(band_data[k], *out_ranges[k]))

out = np.ma.stack(out_arrays, axis=-1)
return image.array_to_png(out)
15 changes: 14 additions & 1 deletion terracotta/handlers/singleband.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

import collections

import numpy as np

from terracotta import get_settings, get_driver, image, xyz
from terracotta.profile import trace

Expand All @@ -26,6 +28,7 @@ def singleband(
*,
colormap: Union[str, Mapping[Number, RGBA], None] = None,
stretch_range: Optional[Tuple[NumberOrString, NumberOrString]] = None,
color_transform: Optional[str] = None,
tile_size: Optional[Tuple[int, int]] = None
) -> BinaryIO:
"""Return singleband image as PNG"""
Expand Down Expand Up @@ -61,7 +64,8 @@ def singleband(
out = image.label(tile_data, labels)
else:
# determine stretch range from metadata and arguments
stretch_range_ = list(metadata["range"])
band_range = list(metadata["range"])
stretch_range_ = band_range.copy()

percentiles = metadata.get("percentiles", [])
if stretch_min is not None:
Expand All @@ -71,6 +75,15 @@ def singleband(
stretch_range_[1] = image.get_stretch_scale(stretch_max, percentiles)

cmap_or_palette = cast(Optional[str], colormap)

if color_transform:
stretch_range_ = np.array(stretch_range_, dtype=tile_data.dtype)
stretch_range_ = np.ma.stack(stretch_range_, axis=0)

stretch_range_ = image.apply_color_transform(stretch_range_, color_transform, band_range)
tile_data = np.expand_dims(tile_data, axis=0)
tile_data = image.apply_color_transform(tile_data, color_transform, band_range)[0]

out = image.to_uint8(tile_data, *stretch_range_)

return image.array_to_png(out, colormap=cmap_or_palette)
23 changes: 23 additions & 0 deletions terracotta/image.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@

import numpy as np
from PIL import Image
from color_operations import parse_operations
from color_operations.utils import to_math_type

from terracotta.profile import trace
from terracotta import exceptions, get_settings
Expand Down Expand Up @@ -162,6 +164,27 @@ def to_uint8(data: Array, lower_bound: Number, upper_bound: Number) -> Array:
return rescaled.astype(np.uint8)


def apply_color_transform(
masked_data: Array,
color_transform: str,
band_range: list,
) -> Array:
"""Apply gamma correction to the input array and scale it to the output dtype."""

if band_range:
arr = contrast_stretch(masked_data, band_range, (0, 1))
elif np.issubdtype(masked_data.dtype, np.integer):
arr = to_math_type(masked_data)
else:
raise exceptions.InvalidArgumentsError("No band range given and array is not of integer type")


for func in parse_operations(color_transform):
arr = func(arr)
Comment on lines +182 to +183
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this assume a particular scaling already?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. It may be easier to apply stretching before color transform then. I.e., normalize to [0,1] using stretch_range and clamp spillover to 0 / 1, then apply color transform, then convert to uint8. That way we don't rely on a transformation of the stretch range?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it may not be a good idea since it would change the result.

The color stretch fills the [0, 1] range whereas the normalization to_math_type does is relative to the dtype range. So when you apply the color transform I think that would shift where values fall along the curve.

This is what chatgpt said in the case of gamma correction:

Gamma correction is typically applied before color stretching, particularly when working with image data in scientific imaging, photography, or graphic design.

Here's why:

    Gamma Correction First: Gamma correction adjusts the image data to a linear color space, which compensates for the nonlinear response of human vision and many display systems. This linearization step ensures that subsequent adjustments, like color stretching, are applied to data that more accurately represents real-world light intensities.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, but who says that the dtype range is appropriate? The user-provided stretch range is telling us how to map the values in the raster to a linear scale.

Summoning @vincentsarago in case you want to weigh in on the appropriate order of linear scaling (and clamping out of range values) vs. color correction :)


return arr


def label(data: Array, labels: Sequence[Number]) -> Array:
"""Create a labelled uint8 version of data, with output values starting at 1.

Expand Down
18 changes: 18 additions & 0 deletions terracotta/server/fields.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

from typing import Any, Union

from color_operations import parse_operations


class StringOrNumber(fields.Field):
"""
Expand Down Expand Up @@ -45,3 +47,19 @@ def validate_stretch_range(data: Any) -> None:
if isinstance(data, str):
if not re.match("^p\\d+$", data):
raise ValidationError("Percentile format is `p<digits>`")


def validate_color_transform(data: Any) -> None:
"""
Validate that the color transform is a string and can be parsed by `color_operations`.
"""
if not isinstance(data, str):
raise ValidationError("Color transform needs to be a string")

if "saturation" in data:
raise ValidationError("Saturation is currently not supported")

try:
parse_operations(data)
except (ValueError, KeyError):
raise ValidationError("Invalid color transform")
9 changes: 7 additions & 2 deletions terracotta/server/rgb.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
from marshmallow import Schema, fields, validate, pre_load, ValidationError, EXCLUDE
from flask import request, send_file, Response

from terracotta.server.fields import StringOrNumber, validate_stretch_range
from terracotta.server.fields import StringOrNumber, validate_stretch_range, validate_color_transform
from terracotta.server.flask_api import TILE_API


Expand Down Expand Up @@ -48,7 +48,7 @@ class Meta:
example="[0,1]",
missing=None,
description=(
"Stretch range [min, max] to use for the gren band as JSON array. "
"Stretch range [min, max] to use for the green band as JSON array. "
"Min and max may be numbers to use as absolute range, or strings "
"of the format `p<digits>` with an integer between 0 and 100 "
"to use percentiles of the image instead. "
Expand All @@ -68,6 +68,11 @@ class Meta:
"Null values indicate global minimum / maximum."
),
)
color_transform = fields.String(
validate=validate_color_transform,
missing=None,
description="Color transform DSL string from color-operations.",
)
tile_size = fields.List(
fields.Integer(),
validate=validate.Length(equal=2),
Expand Down
10 changes: 9 additions & 1 deletion terracotta/server/singleband.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
)
from flask import request, send_file, Response

from terracotta.server.fields import StringOrNumber, validate_stretch_range
from terracotta.server.fields import StringOrNumber, validate_stretch_range, validate_color_transform
from terracotta.server.flask_api import TILE_API
from terracotta.cmaps import AVAILABLE_CMAPS

Expand Down Expand Up @@ -65,6 +65,14 @@ class Meta:
"hex strings.",
)

color_transform = fields.String(
validate=validate_color_transform,
missing=None,
example="gamma 1 1.5, sigmoidal 1 15 0.5",
description="Color transform DSL string from color-operations."
"All color operations for singleband should specify band 1.",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what this means. Could you elaborate?

)

tile_size = fields.List(
fields.Integer(),
validate=validate.Length(equal=2),
Expand Down