SomeOf
Bases: Transform
Apply a random subset of the given transforms.
When applied to a batch with per_instance=True (the default),
each batch element independently samples its own subset. This
requires shape- and schema-preserving transforms so the elements
can be re-stacked. Pass per_instance=False to sample a single
subset for the whole batch.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
transforms
|
Sequence[Transform] | None
|
Sequence of candidate transforms. |
None
|
num_transforms
|
int | tuple[int, int]
|
How many transforms to apply. An |
1
|
replace
|
bool
|
If |
False
|
**kwargs
|
Any
|
See |
{}
|
Examples:
>>> import torchio as tio
>>> augmentation = tio.SomeOf(
... [tio.Noise(), tio.Flip(), tio.Noise(std=0.5)],
... num_transforms=2,
... )
Source code in src/torchio/transforms/compose.py
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 | |
supports_per_instance_params
property
Whether this transform can sample parameters per batch element.
Defaults to False. Transforms that implement per-instance
parameter sampling override this to return True. When False,
the transform always uses batch-shared parameters regardless of
the per_instance flag, preserving the legacy behavior.
supports_per_instance_p
property
Whether this transform can gate each batch element independently.
Defaults to False. Shape-preserving transforms that implement
per-element probability override this to return True.
Shape-changing transforms must leave it False because masked
and unmasked elements would have incompatible shapes.
invertible
property
Whether this transform can be inverted.
make_params(batch)
Sample random parameters for this transform.
Override in subclasses that have random behavior.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
batch
|
SubjectsBatch
|
A |
required |
Returns:
| Type | Description |
|---|---|
dict[str, Any]
|
Dict of sampled parameters. |
Source code in src/torchio/transforms/transform.py
apply_transform(batch, params)
Apply the transform with the given parameters.
Must be overridden by subclasses. Receives a SubjectsBatch
whose ImagesBatch entries contain 5D tensors
(B, C, I, J, K). Use negative indexing (-3, -2,
-1) for spatial dims.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
batch
|
SubjectsBatch
|
A |
required |
params
|
dict[str, Any]
|
Parameters from |
required |
Returns:
| Type | Description |
|---|---|
SubjectsBatch
|
Transformed |
Source code in src/torchio/transforms/transform.py
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 |