Loader

Bases: Dataset

Loader class to handle the loading, preprocessing, and splitting of image datasets for training and testing.

Attributes:
  • image_path (str) –

    Path to the zip file containing the dataset.

  • batch_size (int) –

    Number of images per batch.

  • image_size (int) –

    The height and width to which the images will be resized.

  • split_ratio (float) –

    The ratio of the dataset to be used for testing.

Methods:

Name Description
unzip_folder

Extracts the dataset from a zip file to a specified path.

image_transforms

Returns a composition of image transformations.

image_split

Splits the dataset into training and testing sets.

create_dataloader

Creates and saves data loaders for the dataset.

dataset_details

Prints details about the dataset.

show_images

Displays a set of noisy and clean images for visualization.

Note

Ensure that the paths for RAW_DATA_PATH and PROCESSED_DATA_PATH are correctly set in the 'config' module.

Example

loader = Loader(image_path="./data/data.zip", batch_size=16, image_size=64, split_ratio=0.25) loader.unzip_folder() dataloader = loader.create_dataloader() loader.dataset_details() loader.show_images()

Source code in dataloader.py
 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
118
119
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
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
281
282
283
class Loader(Dataset):
    """
    Loader class to handle the loading, preprocessing, and splitting of image datasets for training and testing.

    Attributes:
        image_path (str): Path to the zip file containing the dataset.
        batch_size (int): Number of images per batch.
        image_size (int): The height and width to which the images will be resized.
        split_ratio (float): The ratio of the dataset to be used for testing.

    Methods:
        unzip_folder: Extracts the dataset from a zip file to a specified path.
        image_transforms: Returns a composition of image transformations.
        image_split: Splits the dataset into training and testing sets.
        create_dataloader: Creates and saves data loaders for the dataset.
        dataset_details: Prints details about the dataset.
        show_images: Displays a set of noisy and clean images for visualization.

    Note:
        Ensure that the paths for RAW_DATA_PATH and PROCESSED_DATA_PATH are correctly set in the 'config' module.

    Example:
        >>> loader = Loader(image_path="./data/data.zip", batch_size=16, image_size=64, split_ratio=0.25)
        >>> loader.unzip_folder()
        >>> dataloader = loader.create_dataloader()
        >>> loader.dataset_details()
        >>> loader.show_images()
    """

    def __init__(self, image_path=None, batch_size=16, image_size=64, split_ratio=0.25):
        """
        Initializes the Loader with dataset path, batch size, image size, and split ratio.

        Parameters:
            image_path (str): Path to the dataset zip file.
            batch_size (int): Number of images in each batch of data.
            image_size (int): Size (height and width) to which images are resized.
            split_ratio (float): Fraction of the dataset to allocate to the test set.

        """
        self.image_path = image_path
        self.batch_size = batch_size
        self.image_size = image_size
        self.split_ratio = split_ratio

        self.clean_images = list()
        self.noise_images = list()

    def unzip_folder(self):
        """
        Extracts images from a zipped file to RAW_DATA_PATH.

        Raises:
            Exception: If RAW_DATA_PATH does not exist or the zip file is invalid.
        """

        try:
            clean()
        except Exception as e:
            print("The exception is: {}".format(e))

        if os.path.exists(RAW_DATA_PATH):
            with zipfile.ZipFile(self.image_path, "r") as zip_ref:
                zip_ref.extractall(
                    os.path.join(
                        RAW_DATA_PATH,
                    )
                )
        else:
            raise Exception("Please provide a valid path".capitalize())

    def image_transforms(self):
        """
        Defines and returns the transformations to be applied to the images.

        Returns:
            torchvision.transforms.Compose: A composed transform with resizing, tensor conversion, and normalization.

        """
        return transforms.Compose(
            [
                transforms.Resize((self.image_size, self.image_size)),
                transforms.ToTensor(),
                transforms.Normalize([0.5, 0.5, 0.5], [0.5, 0.5, 0.5]),
            ]
        )

    def image_split(self, **kwargs):
        """
        Splits the dataset into training and testing sets based on `split_ratio`.

        Parameters:
            **kwargs: Expects 'noise_images' and 'clean_images' lists.

        Returns:
            tuple: Contains split datasets (train_noise, test_noise, train_clean, test_clean).

        Raises:
            ValueError: If `kwargs` does not contain 'noise_images' or 'clean_images'.

        """
        return train_test_split(
            kwargs["noise_images"],
            kwargs["clean_images"],
            test_size=self.split_ratio,
            random_state=42,
        )

    def create_dataloader(self):
        """
        Creates and saves DataLoader objects for training and testing datasets.

        Returns:
            DataLoader: The combined DataLoader for the entire dataset.

        Raises:
            Exception: If necessary paths do not exist or dataset is not properly formatted.
        """
        if os.path.exists(RAW_DATA_PATH):
            dataset = os.listdir(RAW_DATA_PATH)[0]

            clean_images = os.path.join(RAW_DATA_PATH, dataset, "clean_images")
            noise_images = os.path.join(RAW_DATA_PATH, dataset, "noisy_images")

            for image in os.listdir(clean_images):
                clean_image_path = os.path.join(clean_images, image)

                if image in os.listdir(noise_images):
                    noise_image_path = os.path.join(noise_images, image)
                else:
                    continue

                self.clean_images.append(
                    self.image_transforms()(
                        Image.fromarray(cv2.imread(clean_image_path))
                    )
                )

                self.noise_images.append(
                    self.image_transforms()(
                        Image.fromarray(cv2.imread(noise_image_path))
                    )
                )

            try:
                image_split = self.image_split(
                    clean_images=self.clean_images, noise_images=self.noise_images
                )

                dataloader = DataLoader(
                    dataset=list(zip(self.noise_images, self.clean_images)),
                    batch_size=self.batch_size * 10,
                    shuffle=True,
                )

                train_dataloader = DataLoader(
                    dataset=list(zip(image_split[0], image_split[2])),
                    batch_size=self.batch_size,
                    shuffle=True,
                )

                test_dataloader = DataLoader(
                    dataset=list(zip(image_split[1], image_split[3])),
                    batch_size=self.batch_size,
                    shuffle=True,
                )

                if os.path.exists(PROCESSED_DATA_PATH):

                    dump(
                        value=dataloader,
                        filename=os.path.join(PROCESSED_DATA_PATH, "dataloader.pkl"),
                    )

                    dump(
                        value=train_dataloader,
                        filename=os.path.join(
                            PROCESSED_DATA_PATH, "train_dataloader.pkl"
                        ),
                    )

                    dump(
                        value=test_dataloader,
                        filename=os.path.join(
                            PROCESSED_DATA_PATH, "test_dataloader.pkl"
                        ),
                    )
                else:
                    raise Exception("Please provide a valid path".capitalize())

            except Exception as e:
                print("The exception is: {}".format(e))

            return dataloader

    @staticmethod
    def dataset_details():
        """
        Prints the total number of images and the shape of clean and noisy images in the dataset.

        Raises:
            Exception: If PROCESSED_DATA_PATH does not exist.
        """
        if os.path.exists(PROCESSED_DATA_PATH):
            dataloader = load(
                filename=os.path.join(PROCESSED_DATA_PATH, "dataloader.pkl")
            )

            clean, noise = next(iter(dataloader))

            total_data = sum(clean.size(0) for clean, _ in dataloader)

            print("Total number of images: {}".format(total_data))
            print("Clean images shape : {}".format(clean.size()))
            print("Noisy images shape : {}".format(noise.size()))

        else:
            raise Exception("Please provide a valid path".capitalize())

    @staticmethod
    def show_images():
        """
        Visualizes a sample of noisy and clean images from the dataset.

        Raises:
            Exception: If PROCESSED_DATA_PATH does not exist or image files are missing.
        """
        if os.path.exists(PROCESSED_DATA_PATH):
            dataloader = load(
                filename=os.path.join(PROCESSED_DATA_PATH, "dataloader.pkl")
            )
        else:
            raise Exception("Please provide a valid path".capitalize())

        plt.figure(figsize=(40, 15))

        noise, clean = next(iter(dataloader))

        for index, image in enumerate(noise):
            noise_image = image.permute(1, 2, 0)
            noise_image = (noise_image - noise_image.min()) / (
                noise_image.max() - noise_image.min()
            )

            clean_image = clean[index].permute(1, 2, 0)
            clean_image = (clean_image - clean_image.min()) / (
                clean_image.max() - clean_image.min()
            )

            plt.subplot(2 * 4, 2 * 6, 2 * index + 1)
            plt.imshow(noise_image)
            plt.title("Noisy")
            plt.axis("off")

            plt.subplot(2 * 4, 2 * 6, 2 * index + 2)
            plt.imshow(clean_image)
            plt.title("Clean")
            plt.axis("off")

        plt.tight_layout()
        if os.path.exists(FILE_PATH):
            plt.savefig(os.path.join(FILE_PATH, "raw_image.png"))
        else:
            raise Exception("Please provide a valid path".capitalize())

        plt.show()

__init__(image_path=None, batch_size=16, image_size=64, split_ratio=0.25)

Initializes the Loader with dataset path, batch size, image size, and split ratio.

Parameters:
  • image_path (str, default: None ) –

    Path to the dataset zip file.

  • batch_size (int, default: 16 ) –

    Number of images in each batch of data.

  • image_size (int, default: 64 ) –

    Size (height and width) to which images are resized.

  • split_ratio (float, default: 0.25 ) –

    Fraction of the dataset to allocate to the test set.

Source code in dataloader.py
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def __init__(self, image_path=None, batch_size=16, image_size=64, split_ratio=0.25):
    """
    Initializes the Loader with dataset path, batch size, image size, and split ratio.

    Parameters:
        image_path (str): Path to the dataset zip file.
        batch_size (int): Number of images in each batch of data.
        image_size (int): Size (height and width) to which images are resized.
        split_ratio (float): Fraction of the dataset to allocate to the test set.

    """
    self.image_path = image_path
    self.batch_size = batch_size
    self.image_size = image_size
    self.split_ratio = split_ratio

    self.clean_images = list()
    self.noise_images = list()

create_dataloader()

Creates and saves DataLoader objects for training and testing datasets.

Returns:
  • DataLoader

    The combined DataLoader for the entire dataset.

Raises:
  • Exception

    If necessary paths do not exist or dataset is not properly formatted.

Source code in dataloader.py
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
def create_dataloader(self):
    """
    Creates and saves DataLoader objects for training and testing datasets.

    Returns:
        DataLoader: The combined DataLoader for the entire dataset.

    Raises:
        Exception: If necessary paths do not exist or dataset is not properly formatted.
    """
    if os.path.exists(RAW_DATA_PATH):
        dataset = os.listdir(RAW_DATA_PATH)[0]

        clean_images = os.path.join(RAW_DATA_PATH, dataset, "clean_images")
        noise_images = os.path.join(RAW_DATA_PATH, dataset, "noisy_images")

        for image in os.listdir(clean_images):
            clean_image_path = os.path.join(clean_images, image)

            if image in os.listdir(noise_images):
                noise_image_path = os.path.join(noise_images, image)
            else:
                continue

            self.clean_images.append(
                self.image_transforms()(
                    Image.fromarray(cv2.imread(clean_image_path))
                )
            )

            self.noise_images.append(
                self.image_transforms()(
                    Image.fromarray(cv2.imread(noise_image_path))
                )
            )

        try:
            image_split = self.image_split(
                clean_images=self.clean_images, noise_images=self.noise_images
            )

            dataloader = DataLoader(
                dataset=list(zip(self.noise_images, self.clean_images)),
                batch_size=self.batch_size * 10,
                shuffle=True,
            )

            train_dataloader = DataLoader(
                dataset=list(zip(image_split[0], image_split[2])),
                batch_size=self.batch_size,
                shuffle=True,
            )

            test_dataloader = DataLoader(
                dataset=list(zip(image_split[1], image_split[3])),
                batch_size=self.batch_size,
                shuffle=True,
            )

            if os.path.exists(PROCESSED_DATA_PATH):

                dump(
                    value=dataloader,
                    filename=os.path.join(PROCESSED_DATA_PATH, "dataloader.pkl"),
                )

                dump(
                    value=train_dataloader,
                    filename=os.path.join(
                        PROCESSED_DATA_PATH, "train_dataloader.pkl"
                    ),
                )

                dump(
                    value=test_dataloader,
                    filename=os.path.join(
                        PROCESSED_DATA_PATH, "test_dataloader.pkl"
                    ),
                )
            else:
                raise Exception("Please provide a valid path".capitalize())

        except Exception as e:
            print("The exception is: {}".format(e))

        return dataloader

dataset_details() staticmethod

Prints the total number of images and the shape of clean and noisy images in the dataset.

Raises:
  • Exception

    If PROCESSED_DATA_PATH does not exist.

Source code in dataloader.py
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
@staticmethod
def dataset_details():
    """
    Prints the total number of images and the shape of clean and noisy images in the dataset.

    Raises:
        Exception: If PROCESSED_DATA_PATH does not exist.
    """
    if os.path.exists(PROCESSED_DATA_PATH):
        dataloader = load(
            filename=os.path.join(PROCESSED_DATA_PATH, "dataloader.pkl")
        )

        clean, noise = next(iter(dataloader))

        total_data = sum(clean.size(0) for clean, _ in dataloader)

        print("Total number of images: {}".format(total_data))
        print("Clean images shape : {}".format(clean.size()))
        print("Noisy images shape : {}".format(noise.size()))

    else:
        raise Exception("Please provide a valid path".capitalize())

image_split(**kwargs)

Splits the dataset into training and testing sets based on split_ratio.

Parameters:
  • **kwargs

    Expects 'noise_images' and 'clean_images' lists.

Returns:
  • tuple

    Contains split datasets (train_noise, test_noise, train_clean, test_clean).

Raises:
  • ValueError

    If kwargs does not contain 'noise_images' or 'clean_images'.

Source code in dataloader.py
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
def image_split(self, **kwargs):
    """
    Splits the dataset into training and testing sets based on `split_ratio`.

    Parameters:
        **kwargs: Expects 'noise_images' and 'clean_images' lists.

    Returns:
        tuple: Contains split datasets (train_noise, test_noise, train_clean, test_clean).

    Raises:
        ValueError: If `kwargs` does not contain 'noise_images' or 'clean_images'.

    """
    return train_test_split(
        kwargs["noise_images"],
        kwargs["clean_images"],
        test_size=self.split_ratio,
        random_state=42,
    )

image_transforms()

Defines and returns the transformations to be applied to the images.

Returns:
  • torchvision.transforms.Compose: A composed transform with resizing, tensor conversion, and normalization.

Source code in dataloader.py
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
def image_transforms(self):
    """
    Defines and returns the transformations to be applied to the images.

    Returns:
        torchvision.transforms.Compose: A composed transform with resizing, tensor conversion, and normalization.

    """
    return transforms.Compose(
        [
            transforms.Resize((self.image_size, self.image_size)),
            transforms.ToTensor(),
            transforms.Normalize([0.5, 0.5, 0.5], [0.5, 0.5, 0.5]),
        ]
    )

show_images() staticmethod

Visualizes a sample of noisy and clean images from the dataset.

Raises:
  • Exception

    If PROCESSED_DATA_PATH does not exist or image files are missing.

Source code in dataloader.py
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
281
282
283
@staticmethod
def show_images():
    """
    Visualizes a sample of noisy and clean images from the dataset.

    Raises:
        Exception: If PROCESSED_DATA_PATH does not exist or image files are missing.
    """
    if os.path.exists(PROCESSED_DATA_PATH):
        dataloader = load(
            filename=os.path.join(PROCESSED_DATA_PATH, "dataloader.pkl")
        )
    else:
        raise Exception("Please provide a valid path".capitalize())

    plt.figure(figsize=(40, 15))

    noise, clean = next(iter(dataloader))

    for index, image in enumerate(noise):
        noise_image = image.permute(1, 2, 0)
        noise_image = (noise_image - noise_image.min()) / (
            noise_image.max() - noise_image.min()
        )

        clean_image = clean[index].permute(1, 2, 0)
        clean_image = (clean_image - clean_image.min()) / (
            clean_image.max() - clean_image.min()
        )

        plt.subplot(2 * 4, 2 * 6, 2 * index + 1)
        plt.imshow(noise_image)
        plt.title("Noisy")
        plt.axis("off")

        plt.subplot(2 * 4, 2 * 6, 2 * index + 2)
        plt.imshow(clean_image)
        plt.title("Clean")
        plt.axis("off")

    plt.tight_layout()
    if os.path.exists(FILE_PATH):
        plt.savefig(os.path.join(FILE_PATH, "raw_image.png"))
    else:
        raise Exception("Please provide a valid path".capitalize())

    plt.show()

unzip_folder()

Extracts images from a zipped file to RAW_DATA_PATH.

Raises:
  • Exception

    If RAW_DATA_PATH does not exist or the zip file is invalid.

Source code in dataloader.py
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
def unzip_folder(self):
    """
    Extracts images from a zipped file to RAW_DATA_PATH.

    Raises:
        Exception: If RAW_DATA_PATH does not exist or the zip file is invalid.
    """

    try:
        clean()
    except Exception as e:
        print("The exception is: {}".format(e))

    if os.path.exists(RAW_DATA_PATH):
        with zipfile.ZipFile(self.image_path, "r") as zip_ref:
            zip_ref.extractall(
                os.path.join(
                    RAW_DATA_PATH,
                )
            )
    else:
        raise Exception("Please provide a valid path".capitalize())