|
2 | 2 |
|
3 | 3 | Distributed-CellProfiler can be told what files to use through LoadData.csv, Batch Files, or file lists. |
4 | 4 |
|
| 5 | +## Metadata use in DCP |
| 6 | + |
| 7 | +Distributed-CellProfiler requires metadata and grouping in order to split jobs. |
| 8 | +This means that, unlikely a generic CellProfiler workflow, the inclusion of metadata and grouping are NOT optional for pipelines you wish to use in Distributed-CellProfiler. |
| 9 | +- If using LoadData, this means ensuring that your input CSV has some metadata to use for grouping and "Group images by metdata?" is set to "Yes". |
| 10 | +- If using batch files or file lists, this means ensuring that the Metadata and Groups modules are enabled, and that you are extracting metadata from file and folder names _that will also be present in your remote system_ in the Metadata module in your CellProfiler pipeline. |
| 11 | +You can pass additional metadata to CellProfiler by `Add another extraction method`, setting the method to `Import from file` and setting Metadata file location to `Default Input Folder`. |
| 12 | +Metadata of either type can be used for grouping. |
| 13 | + |
5 | 14 | ## Load Data |
6 | 15 |
|
7 | 16 |  |
@@ -58,15 +67,13 @@ Note that if you do not follow our standard file organization, under **#not proj |
58 | 67 |
|
59 | 68 | ## File lists |
60 | 69 |
|
61 | | -You can also simply pass a list of absolute file paths (not relative paths) with one file per row in `.txt` format. |
62 | | -Note that file lists themselves do not associate metadata with file paths (in contrast to LoadData.csv files where you can enter any metadata columns you desire.) |
63 | | -Therefore, you need to extract metadata for Distributed-CellProfiler to use for grouping by extracting metadata from file and folder names in the Metadata module in your CellProfiler pipeline. |
64 | | -You can pass additional metadata to CellProfiler by `Add another extraction method`, setting the method to `Import from file` and setting Metadata file location to `Default Input Folder`. |
| 70 | +You can also simply pass a list of absolute file paths (not relative paths) with one file per row in `.txt` format. |
| 71 | +These must be the absolute paths that Distributed-CellProfiler will see, aka relative to the root of your bucket (which will be mounted as `/bucket`. |
65 | 72 |
|
66 | 73 | ### Creating File Lists |
67 | 74 |
|
68 | 75 | Use any text editing software to create a `.txt` file where each line of the file is a path to a single image that you want to process. |
69 | 76 |
|
70 | 77 | ### Using File Lists |
71 | 78 |
|
72 | | -To use a file list with submitJobs, put the path to the `.txt` file in **data_file:**. |
| 79 | +To use a file list with submitJobs, put the path to the `.txt` file in **data_file:**. |
0 commit comments