Skip to content

Clamp

Bases: IntensityTransform

Clamp intensity values into the range \([a, b]\).

Wraps torch.clamp.

Parameters:

Name Type Description Default
out_min float | None

Minimum value \(a\). None means no lower bound.

 None
out_max float | None

Maximum value \(b\). None means no upper bound.

 None
**kwargs Any

See Transform.

 {}

Examples:

>>> import torchio as tio
>>> # CT windowing: clip to [-1000, 1000] Hounsfield units
>>> clamp = tio.Clamp(out_min=-1000, out_max=1000)
>>> # Clip negative values only
>>> clamp = tio.Clamp(out_min=0)
Source code in src/torchio/transforms/intensity/clamp.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
class Clamp(IntensityTransform):
    r"""Clamp intensity values into the range $[a, b]$.

    Wraps [`torch.clamp`][torch.clamp].

    Args:
        out_min: Minimum value $a$. `None` means no lower bound.
        out_max: Maximum value $b$. `None` means no upper bound.
        **kwargs: See [`Transform`][torchio.Transform].

    Examples:
        >>> import torchio as tio
        >>> # CT windowing: clip to [-1000, 1000] Hounsfield units
        >>> clamp = tio.Clamp(out_min=-1000, out_max=1000)
        >>> # Clip negative values only
        >>> clamp = tio.Clamp(out_min=0)
    """

    def __init__(
        self,
        *,
        out_min: float | None = None,
        out_max: float | None = None,
        **kwargs: Any,
    ) -> None:
        super().__init__(**kwargs)
        if out_min is not None and out_max is not None and out_min > out_max:
            msg = f"out_min ({out_min}) must be <= out_max ({out_max})"
            raise ValueError(msg)
        self.out_min = out_min
        self.out_max = out_max

    def make_params(self, batch: SubjectsBatch) -> dict[str, Any]:
        """No random parameters."""
        return {"out_min": self.out_min, "out_max": self.out_max}

    def apply_transform(
        self,
        batch: SubjectsBatch,
        params: dict[str, Any],
    ) -> SubjectsBatch:
        """Clamp each selected image."""
        out_min = params["out_min"]
        out_max = params["out_max"]
        for _name, img_batch in self._get_images(batch).items():
            img_batch.data = img_batch.data.clamp(min=out_min, max=out_max)
        return batch

invertible property

Whether this transform can be inverted.

forward(data) 

forward(data: Subject) -> Subject

forward(data: Image) -> Image

forward(data: Tensor) -> Tensor

forward(data: np.ndarray) -> np.ndarray

forward(data: sitk.Image) -> sitk.Image

forward(data: nib.Nifti1Image) -> nib.Nifti1Image

forward(data: dict) -> dict

forward(data: ImagesBatch) -> ImagesBatch

forward(data: SubjectsBatch) -> SubjectsBatch

Apply the transform.

The output type always matches the input type.

Parameters:

Name Type Description Default
data Any

Input data to transform.

 required
Source code in src/torchio/transforms/transform.py 
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
def forward(self, data: Any) -> Any:
    """Apply the transform.

    The output type always matches the input type.

    Args:
        data: Input data to transform.
    """
    if self.copy:
        data = _copy.deepcopy(data)
    batch, unwrap = self._wrap(data)
    if torch.rand(1).item() > self.p:
        return unwrap(batch)
    params = self.make_params(batch)
    batch = self.apply_transform(batch, params)
    # Record history on the batch
    trace = AppliedTransform(name=type(self).__name__, params=params)
    if not hasattr(batch, "applied_transforms"):
        batch.applied_transforms = []
    batch.applied_transforms.append(trace)
    result = unwrap(batch)
    # Propagate history to outputs that can carry it
    if (
        hasattr(batch, "applied_transforms")
        and not isinstance(result, (SubjectsBatch, Tensor, np.ndarray))
        and not isinstance(result, dict)
    ):
        with contextlib.suppress(AttributeError):
            result.applied_transforms = list(batch.applied_transforms)
    return result

inverse(params)

Return a transform that undoes this one.

Override in invertible subclasses. The returned transform, when applied, reverses the effect of the forward pass with the given parameters.

Parameters:

Name Type Description Default
params dict[str, Any]

The parameters recorded in the forward pass.

 required

Returns:

Type Description
Transform

A new Transform instance that inverts this one.
Source code in src/torchio/transforms/transform.py 
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
def inverse(self, params: dict[str, Any]) -> Transform:
    """Return a transform that undoes this one.

    Override in invertible subclasses. The returned transform,
    when applied, reverses the effect of the forward pass with
    the given parameters.

    Args:
        params: The parameters recorded in the forward pass.

    Returns:
        A new `Transform` instance that inverts this one.
    """
    msg = f"{type(self).__name__} is not invertible"
    raise NotImplementedError(msg)

to_hydra()

Export as a Hydra-compatible config dict.

Returns a dict with _target_ set to the fully qualified class name and only non-default field values included.

Returns:

Type Description
dict[str, Any]

Dict suitable for hydra.utils.instantiate().
Source code in src/torchio/transforms/transform.py 
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
def to_hydra(self) -> dict[str, Any]:
    """Export as a Hydra-compatible config dict.

    Returns a dict with `_target_` set to the fully qualified
    class name and only non-default field values included.

    Returns:
        Dict suitable for `hydra.utils.instantiate()`.
    """
    from .parameter_range import _ParameterRange

    cls = type(self)
    target = f"torchio.{cls.__qualname__}"
    cfg: dict[str, Any] = {"_target_": target}

    for name, default in _collect_init_params(cls).items():
        value = getattr(self, name, default)
        if isinstance(value, _ParameterRange):
            if value._original == default:
                continue
            value = _hydra_value(value._original)
        elif value == default:
            continue
        else:
            value = _hydra_value(value)
        cfg[name] = value
    return cfg

make_params(batch)

No random parameters.

Source code in src/torchio/transforms/intensity/clamp.py 
43
44
45
def make_params(self, batch: SubjectsBatch) -> dict[str, Any]:
    """No random parameters."""
    return {"out_min": self.out_min, "out_max": self.out_max}

apply_transform(batch, params)

Clamp each selected image.

Source code in src/torchio/transforms/intensity/clamp.py 
47
48
49
50
51
52
53
54
55
56
57
def apply_transform(
    self,
    batch: SubjectsBatch,
    params: dict[str, Any],
) -> SubjectsBatch:
    """Clamp each selected image."""
    out_min = params["out_min"]
    out_max = params["out_max"]
    for _name, img_batch in self._get_images(batch).items():
        img_batch.data = img_batch.data.clamp(min=out_min, max=out_max)
    return batch