pineapple_data/data/
segmentation.rs

1// Copyright (c) 2025, Tom Ouellette
2// Licensed under the BSD 3-Clause License
3
4use crate::request;
5use std::path::Path;
6
7// NOTE: This download scheme isn't really good practice as any
8// new dataset additions will require a new release of the library.
9// BUT, if there's request, then I'll move the identifiers outside
10// the library to allow for arbitrary data/dataset additions.
11
12/// Available annotated/segmentation datasets in the pineapple library.
13pub enum SegmentationDatasets {
14    Almeida2023,
15    Arvidsson2022,
16    Cellpose2021,
17    Conic2022,
18    Cryonuseg2021,
19    Dsb2019,
20    Hpa2022,
21    Livecell2021,
22    Nuinseg2024,
23    Pannuke2020,
24    Tissuenet2022,
25    Vicar2021,
26}
27
28impl SegmentationDatasets {
29    /// Select a dataset from the available datasets.
30    pub fn select(name: &str) -> Self {
31        match name {
32            "almeida_2023" => SegmentationDatasets::Almeida2023,
33            "arvidsson_2022" => SegmentationDatasets::Arvidsson2022,
34            "cellpose_2021" => SegmentationDatasets::Cellpose2021,
35            "conic_2022" => SegmentationDatasets::Conic2022,
36            "cryonuseg_2021" => SegmentationDatasets::Cryonuseg2021,
37            "dsb_2019" => SegmentationDatasets::Dsb2019,
38            "hpa_2022" => SegmentationDatasets::Hpa2022,
39            "livecell_2021" => SegmentationDatasets::Livecell2021,
40            "nuinseg_2024" => SegmentationDatasets::Nuinseg2024,
41            "pannuke_2020" => SegmentationDatasets::Pannuke2020,
42            "tissuenet_2022" => SegmentationDatasets::Tissuenet2022,
43            "vicar_2021" => SegmentationDatasets::Vicar2021,
44            _ => {
45                let msg = format!(
46                    "[pineapple::data::segmentation] Dataset {} not found. Avalaible datasets include: {}",
47                    name,
48                    "almeida_2023, arvidsson_2022, cellpose_2021, conic_2022, cryonuseg_2021, dsb_2019, hpa_2022, livecell_2021, nuinseg_2024, pannuke_2020, tissuenet_2022, vicar_2021."
49                );
50                eprintln!("{}", msg);
51                std::process::exit(1);
52            }
53        }
54    }
55
56    /// Return an iterator over the enum members.
57    pub fn iter() -> impl Iterator<Item = &'static SegmentationDatasets> {
58        static ANNOTATED: [SegmentationDatasets; 12] = [
59            SegmentationDatasets::Almeida2023,
60            SegmentationDatasets::Arvidsson2022,
61            SegmentationDatasets::Cellpose2021,
62            SegmentationDatasets::Conic2022,
63            SegmentationDatasets::Cryonuseg2021,
64            SegmentationDatasets::Dsb2019,
65            SegmentationDatasets::Hpa2022,
66            SegmentationDatasets::Livecell2021,
67            SegmentationDatasets::Nuinseg2024,
68            SegmentationDatasets::Pannuke2020,
69            SegmentationDatasets::Tissuenet2022,
70            SegmentationDatasets::Vicar2021,
71        ];
72
73        ANNOTATED.iter()
74    }
75
76    /// Get the name of the model saved on Google drive.
77    pub fn name(&self) -> &str {
78        match self {
79            SegmentationDatasets::Almeida2023 => "almeida_2023",
80            SegmentationDatasets::Arvidsson2022 => "arvidsson_2022",
81            SegmentationDatasets::Cellpose2021 => "cellpose_2021",
82            SegmentationDatasets::Conic2022 => "conic_2022",
83            SegmentationDatasets::Cryonuseg2021 => "cryonuseg_2021",
84            SegmentationDatasets::Dsb2019 => "dsb_2019",
85            SegmentationDatasets::Hpa2022 => "hpa_2022",
86            SegmentationDatasets::Livecell2021 => "livecell_2021",
87            SegmentationDatasets::Nuinseg2024 => "nuinseg_2024",
88            SegmentationDatasets::Pannuke2020 => "pannuke_2020",
89            SegmentationDatasets::Tissuenet2022 => "tissuenet_2022",
90            SegmentationDatasets::Vicar2021 => "vicar_2021",
91        }
92    }
93
94    /// Get the Google drive file identifier for the saved model.
95    pub fn file_id(&self) -> &str {
96        match self {
97            SegmentationDatasets::Almeida2023 => "1BlHvG0MkWwuqGA3ImUJ09D9E7rsVt5ER",
98            SegmentationDatasets::Arvidsson2022 => "12Cwk5MX3V9z_2KmBJyn5jXc-JuW7-e2k",
99            SegmentationDatasets::Cellpose2021 => "12Z9PpJEdSE0bHALNxpAAeD6WA9aBhMEO",
100            SegmentationDatasets::Conic2022 => "1nXOnDkWpRfU5iGXFZe06-CQaAMFq13f_",
101            SegmentationDatasets::Cryonuseg2021 => "1cfIY9BSlTe0RNaq1V8fZmKJwWyBs4WEj",
102            SegmentationDatasets::Dsb2019 => "1qgAyMcrZwLudlA4vjy7jwuKTjAxT7Ky2",
103            SegmentationDatasets::Hpa2022 => "1NyV6xuIAIuaSiXp0H-4VCV8tjaNSpXtX",
104            SegmentationDatasets::Livecell2021 => "1JNXkZS0QSQW25b-opoyKomPKCfO_3pkx",
105            SegmentationDatasets::Nuinseg2024 => "1gSmbsfhO7aP1yBB5R9XMMrAH4hy-Thmm",
106            SegmentationDatasets::Pannuke2020 => "1J9CeH9t23EpottNyUKeBBkYpTfMR3EgT",
107            SegmentationDatasets::Tissuenet2022 => "1ilHrzUuGfobSdFmTezyynCWCLIoJwaHQ",
108            SegmentationDatasets::Vicar2021 => "12tJOlIHZPFqp8GLek_jV__Uhhgsa530_",
109        }
110    }
111
112    /// Get the usage license for a model.
113    pub fn license(&self) -> &str {
114        match self {
115            SegmentationDatasets::Almeida2023 => "CC BY 4.0",
116            SegmentationDatasets::Arvidsson2022 => "CC BY 4.0",
117            SegmentationDatasets::Cellpose2021 => "Custom NC",
118            SegmentationDatasets::Conic2022 => "CC BY-NC 4.0",
119            SegmentationDatasets::Cryonuseg2021 => "MIT",
120            SegmentationDatasets::Dsb2019 => "CC0 1.0 Universal",
121            SegmentationDatasets::Hpa2022 => "CC BY 4.0",
122            SegmentationDatasets::Livecell2021 => "CC BY-NC 4.0",
123            SegmentationDatasets::Nuinseg2024 => "MIT",
124            SegmentationDatasets::Pannuke2020 => "CC BY-NC-SA 4.0",
125            SegmentationDatasets::Tissuenet2022 => "Modified NC Apache",
126            SegmentationDatasets::Vicar2021 => "CC BY 4.0",
127        }
128    }
129
130    /// Get the authors of the model weights.
131    pub fn data_authors(&self) -> &str {
132        match self {
133            SegmentationDatasets::Almeida2023 => "Almeida et al. 2023",
134            SegmentationDatasets::Arvidsson2022 => "Arvidsson et al. 2022",
135            SegmentationDatasets::Cellpose2021 => "Stringer et al. 2021",
136            SegmentationDatasets::Conic2022 => "Graham et al. 2022",
137            SegmentationDatasets::Cryonuseg2021 => "Mahbod et al. 2021",
138            SegmentationDatasets::Dsb2019 => "Caicedo et al. 2019",
139            SegmentationDatasets::Hpa2022 => "HPA 2022",
140            SegmentationDatasets::Livecell2021 => "Edlund et al. 2021",
141            SegmentationDatasets::Nuinseg2024 => "Mahbod et al. 2024",
142            SegmentationDatasets::Pannuke2020 => "Gamper et al. 2020",
143            SegmentationDatasets::Tissuenet2022 => "Greenwald et al. 2022",
144            SegmentationDatasets::Vicar2021 => "Vicar et al. 2021",
145        }
146    }
147
148    /// Get the size of the model in GB.
149    pub fn data_size(&self) -> &str {
150        match self {
151            SegmentationDatasets::Almeida2023 => "0.927",
152            SegmentationDatasets::Arvidsson2022 => "0.028",
153            SegmentationDatasets::Cellpose2021 => "0.356",
154            SegmentationDatasets::Conic2022 => "1.920",
155            SegmentationDatasets::Cryonuseg2021 => "0.031",
156            SegmentationDatasets::Dsb2019 => "0.112",
157            SegmentationDatasets::Hpa2022 => "1.630",
158            SegmentationDatasets::Livecell2021 => "3.260",
159            SegmentationDatasets::Nuinseg2024 => "0.347",
160            SegmentationDatasets::Pannuke2020 => "1.250",
161            SegmentationDatasets::Tissuenet2022 => "4.270",
162            SegmentationDatasets::Vicar2021 => "0.113",
163        }
164    }
165
166    /// Download the dataset to an output directory.
167    pub fn download(&self, output: &Path, verbose: bool) {
168        let filename = format!("{}.tar.gz", self.name().replace("_", "-"));
169
170        if !output.join(&filename).exists() {
171            request::download_file(self.file_id(), output, &filename, !verbose).unwrap();
172
173            if !output.join(&filename).exists() {
174                eprintln!("[pineapple::data::segmentation] Failed to download segmentation dataset.");
175                std::process::exit(1);
176            }
177        }
178    }
179}