metadata
Functions to create a metadata dataframe from Yokogawa files.
_create_well_ids(row_series, col_series, plate_type)
¶
Create well_id list from XML metadata
Handles the conversion of Cellvoyager XML metadata into well indentifiers. Returns well identifiers like A01, B02 etc. for 96 & 384 well plates. Returns well identifiers like A01.a1, A01.b2 etc. for 1536 well plates. Defaults to the processing used for 96 & 384 well plates, unless the plate_type is 1536. For 1536 well plates, the first 4x4 wells go into A01.a1 - A01.d4 and so on.
PARAMETER | DESCRIPTION |
---|---|
row_series |
Series with index being the index of the image and the value the row position (starting at 1 for top left).
TYPE:
|
col_series |
Series with index being the index of the image and the value the col position (starting at 1 for top left).
TYPE:
|
plate_type |
Number of wells in the plate layout. Used to determine whether it's a 1536 well plate or a different layout.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
list[str]
|
list of well_ids |
Source code in fractal_tasks_core/cellvoyager/metadata.py
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 |
|
calculate_steps(site_series)
¶
TBD
PARAMETER | DESCRIPTION |
---|---|
site_series |
TBD
TYPE:
|
Source code in fractal_tasks_core/cellvoyager/metadata.py
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 |
|
check_group_consistency(grouped_df, message='')
¶
TBD
PARAMETER | DESCRIPTION |
---|---|
grouped_df |
TBD
TYPE:
|
message |
TBD
TYPE:
|
Source code in fractal_tasks_core/cellvoyager/metadata.py
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 |
|
get_earliest_time_per_site(mlf_frame)
¶
TBD
PARAMETER | DESCRIPTION |
---|---|
mlf_frame |
TBD
TYPE:
|
Source code in fractal_tasks_core/cellvoyager/metadata.py
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 |
|
get_z_steps(mlf_frame)
¶
TBD
PARAMETER | DESCRIPTION |
---|---|
mlf_frame |
TBD
TYPE:
|
Source code in fractal_tasks_core/cellvoyager/metadata.py
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 |
|
parse_yokogawa_metadata(mrf_path, mlf_path, *, include_patterns=None, exclude_patterns=None)
¶
Parse Yokogawa CV7000 metadata files and prepare site-level metadata.
PARAMETER | DESCRIPTION |
---|---|
mrf_path |
Full path to MeasurementDetail.mrf metadata file. |
mlf_path |
Full path to MeasurementData.mlf metadata file. |
include_patterns |
List of patterns to filter the image filenames in the mlf metadata table. Patterns must be defined as in https://docs.python.org/3/library/fnmatch.html |
exclude_patterns |
List of exclusion patterns. Any file matching any of those patterns is excluded. Patterns must be defined as in https://docs.python.org/3/library/fnmatch.html |
Source code in fractal_tasks_core/cellvoyager/metadata.py
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 |
|
read_metadata_files(mrf_path, mlf_path, include_patterns=None, exclude_patterns=None)
¶
Create tables for mrf & mlf Yokogawa metadata.
PARAMETER | DESCRIPTION |
---|---|
mrf_path |
Full path to MeasurementDetail.mrf metadata file.
TYPE:
|
mlf_path |
Full path to MeasurementData.mlf metadata file.
TYPE:
|
include_patterns |
List of patterns to filter the image filenames in the mlf metadata table. Patterns must be defined as in https://docs.python.org/3/library/fnmatch.html |
exclude_patterns |
List of exclusion patterns. Any file matching any of those patterns is excluded. Patterns must be defined as in https://docs.python.org/3/library/fnmatch.html |
Returns:
Source code in fractal_tasks_core/cellvoyager/metadata.py
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 |
|
read_mlf_file(mlf_path, plate_type, include_patterns=None, exclude_patterns=None)
¶
Process the mlf metadata file of a Cellvoyager CV7K/CV8K.
PARAMETER | DESCRIPTION |
---|---|
mlf_path |
Full path to MeasurementData.mlf metadata file.
TYPE:
|
plate_type |
Plate layout, integer for the number of potential wells.
TYPE:
|
include_patterns |
List of patterns to filter the image filenames in the mlf metadata table. Patterns must be defined as in https://docs.python.org/3/library/fnmatch.html |
exclude_patterns |
List of exclusion patterns. Any file matching any of those patterns is excluded. Patterns must be defined as in https://docs.python.org/3/library/fnmatch.html |
RETURNS | DESCRIPTION |
---|---|
mlf_frame
|
pd.DataFrame with relevant metadata per image
TYPE:
|
error_count
|
Count of errors found during metadata processing
TYPE:
|
Source code in fractal_tasks_core/cellvoyager/metadata.py
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 |
|
read_mrf_file(mrf_path)
¶
Parses the mrf metadata file
PARAMETER | DESCRIPTION |
---|---|
mrf_path |
Full path to MeasurementDetail.mrf metadata file.
TYPE:
|
RETURNS | DESCRIPTION |
---|---|
DataFrame
|
Parsed mrf pandas table with one row per channel imaged |
int
|
The plate_type: The number of wells |
Source code in fractal_tasks_core/cellvoyager/metadata.py
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 |
|