image_dataset.h

Go to the documentation of this file.

// SPDX-License-Identifier: AGPL-3.0-only
// Copyright (C) 2026 Artificial Intelligence Techniques, S.L. and Roberto López González
 
#pragma once
 
#include "opennn/dataset/dataset.h"
#include "opennn/core/io_utilities.h"
#include "opennn/core/statistics.h"
#include "opennn/core/variable.h"
 
namespace opennn
{
 
struct ImageAugmentationPolicy
{
    bool enabled = false;
    bool reflection_axis_x = false;
    bool reflection_axis_y = false;
    float rotation_minimum = 0.0f;
    float rotation_maximum = 0.0f;
    float horizontal_translation_minimum = 0.0f;
    float horizontal_translation_maximum = 0.0f;
    float vertical_translation_minimum = 0.0f;
    float vertical_translation_maximum = 0.0f;
};
 
class ImageDataset : public Dataset
{
 
public:
 
    ImageDataset() = default;
    ImageDataset(const filesystem::path&);
    ImageDataset(const filesystem::path&, const Shape&);
 
    Index get_channels_number() const { return input_shape[2]; }
 
    void set_augmentation_policy(const ImageAugmentationPolicy&);
    void set_input_scaling(const vector<Descriptives>&,
                           const vector<ScalerMethod>&,
                           float,
                           float);
 
    FeatureScaling prepare_training_scaling(
        VariableRole,
        const FeatureScaling&,
        Index) override;
    void clear_training_scaling() noexcept override;
 
    VectorI calculate_target_distribution() const override;
 
    void enable_device_residency() override;
 
    void read_images();
 
    void from_JSON(const JsonDocument&) override;
    void to_JSON(JsonWriter&) const override;
 
    void fill_inputs(const vector<Index>&,
                     const vector<Index>&,
                     float*,
                     FillMode,
                     ColumnContiguity column_contiguity = ColumnContiguity::Unknown) const override;
 
    void fill_targets(const vector<Index>&,
                      const vector<Index>&,
                      float*,
                      FillMode,
                      ColumnContiguity column_contiguity = ColumnContiguity::Unknown) const override;
 
    void augment_inputs(span<float>, Index) const;
 
private:
 
    void write_image_cache(const vector<filesystem::path>&, const string& trailer) const;
 
    ImageAugmentationPolicy augmentation_policy;
 
    vector<float> input_scale;
    vector<float> input_offset;
 
    filesystem::path cache_path;
    mutable FileReader cache_reader;
 
    Shape requested_input_shape;
 
    uint64_t pixel_number = 0;
    uint32_t classes_number = 0;
    vector<int32_t> sample_labels;
};
 
}