Data loading
Loaders
SubjectsLoader
Bases: DataLoader
DataLoader that returns SubjectsBatch instances.
A thin wrapper around torch.utils.data.DataLoader that
collates Subject instances into SubjectsBatch.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dataset
|
Dataset
|
A dataset that returns |
required |
**kwargs
|
Any
|
Passed to |
{}
|
Examples:
>>> loader = tio.SubjectsLoader(dataset, batch_size=4)
>>> batch = next(iter(loader))
>>> batch.t1.data.shape
torch.Size([4, 1, 256, 256, 176])
Source code in src/torchio/loader.py
ImagesLoader
Bases: DataLoader
DataLoader that returns ImagesBatch instances.
A thin wrapper around torch.utils.data.DataLoader that
collates Image instances into ImagesBatch.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dataset
|
Dataset
|
A dataset that returns |
required |
**kwargs
|
Any
|
Passed to |
{}
|
Examples:
>>> loader = tio.ImagesLoader(dataset, batch_size=4)
>>> batch = next(iter(loader))
>>> batch.data.shape
torch.Size([4, 1, 256, 256, 176])
Source code in src/torchio/loader.py
Collation functions
collate_subjects(batch)
Collate a list of Subjects into a SubjectsBatch.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
batch
|
Sequence[Any]
|
Sequence of |
required |
Returns:
| Type | Description |
|---|---|
SubjectsBatch
|
A |
Source code in src/torchio/loader.py
collate_images(batch)
Collate a list of Images into an ImagesBatch.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
batch
|
Sequence[Any]
|
Sequence of |
required |
Returns:
| Type | Description |
|---|---|
ImagesBatch
|
An |
Source code in src/torchio/loader.py
Batch containers
SubjectsBatch
Bases: Invertible
A batch of subjects with stacked image data.
Each named image entry becomes an ImagesBatch. Metadata is
stored as lists (one value per sample).
Created by SubjectsLoader or SubjectsBatch.from_subjects().
Source code in src/torchio/data/batch.py
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 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 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 | |
batch_size
property
Number of samples in the batch.
images
property
Dict of named image batches.
metadata
property
Metadata lists (one value per sample).
device
property
Device of the batch data.
get_inverse_transform(*, warn=True, ignore_intensity=False)
Get a composed transform that inverts the applied history.
Returns a Compose of the inverse of each
applied transform, in reverse order. Non-invertible transforms
are skipped (with a warning if warn=True).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
warn
|
bool
|
Issue a warning for non-invertible transforms. |
True
|
ignore_intensity
|
bool
|
Skip all intensity transforms. |
False
|
Returns:
| Type | Description |
|---|---|
Any
|
A |
Source code in src/torchio/data/invertible.py
apply_inverse_transform(**kwargs)
Apply the inverse of all applied transforms, in reverse order.
Non-invertible transforms are skipped. Intensity transforms
can be ignored with ignore_intensity=True.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
**kwargs
|
Any
|
Forwarded to
|
{}
|
Returns:
| Type | Description |
|---|---|
Self
|
Data with transforms undone. |
Examples:
Source code in src/torchio/data/invertible.py
clear_history()
from_subjects(subjects)
classmethod
Stack a list of subjects into a batch.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
subjects
|
list[Any]
|
List of |
required |
Source code in src/torchio/data/batch.py
to(*args, **kwargs)
unbatch()
Split the batch back into individual Subjects.
Source code in src/torchio/data/batch.py
ImagesBatch
Bases: Invertible
A batch of images with per-sample affines.
Wraps a 5D tensor (B, C, I, J, K) and a list of AffineMatrix
matrices (one per sample). Created by stacking multiple Image
objects or directly from a 5D tensor.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data
|
Tensor
|
5D tensor with shape |
required |
affines
|
list[AffineMatrix]
|
List of affine matrices, one per sample. |
required |
image_class
|
type[Image]
|
The |
ScalarImage
|
Source code in src/torchio/data/batch.py
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 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | |
data
property
writable
5D tensor with shape (B, C, I, J, K).
affines
property
List of affine matrices, one per sample.
batch_size
property
Number of samples in the batch.
device
property
Device the batch data resides on.
get_inverse_transform(*, warn=True, ignore_intensity=False)
Get a composed transform that inverts the applied history.
Returns a Compose of the inverse of each
applied transform, in reverse order. Non-invertible transforms
are skipped (with a warning if warn=True).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
warn
|
bool
|
Issue a warning for non-invertible transforms. |
True
|
ignore_intensity
|
bool
|
Skip all intensity transforms. |
False
|
Returns:
| Type | Description |
|---|---|
Any
|
A |
Source code in src/torchio/data/invertible.py
apply_inverse_transform(**kwargs)
Apply the inverse of all applied transforms, in reverse order.
Non-invertible transforms are skipped. Intensity transforms
can be ignored with ignore_intensity=True.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
**kwargs
|
Any
|
Forwarded to
|
{}
|
Returns:
| Type | Description |
|---|---|
Self
|
Data with transforms undone. |
Examples:
Source code in src/torchio/data/invertible.py
clear_history()
from_images(images)
classmethod
Stack a list of images into a batch.
All images must have the same shape.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
images
|
list[Image]
|
List of |
required |
Source code in src/torchio/data/batch.py
to(*args, **kwargs)
Move batch data to a device and/or cast dtype.