# omero-metadata column mapping

The following table collects the way CSV columns should be mapped into
`omero.grid.Column` based on the header names (rows) and the class of the target object (columns).

The relevant code is in the `HeaderResolver` class of `omero_metadata.populate` - see notably the [keys dictionaries](https://github.com/ome/omero-metadata/blob/2c1b2691dd61f42ac860ee12095829b1523fed95/src/omero_metadata/populate.py#L153-L179) and the [_create_columns](https://github.com/ome/omero-metadata/blob/2c1b2691dd61f42ac860ee12095829b1523fed95/src/omero_metadata/populate.py#L255-L324) class.

| | Screen | Plate | Project | Dataset | Image |
| -------- | -------- | -------- | -------- | -------- | -------- |
| plate | PlateColumn [^1] [^2] | | | | | |
| well | WellColumn [^3] [^4] | WellColumn [^3] [^4] | | | |
| field | ImageColumn [^5] [^6] | ImageColumn [^5] [^6] | | | |
| row | LongColumn | LongColumn | | | |
| column | LongColumn | LongColumn | | | |
| wellsample | ImageColumn [^5] [^6] | ImageColumn [^5] [^6] | | | |
| dataset | | | StringColumn | StringColumn | |
| dataset_name | | | StringColumn | StringColumn | |
| image | ImageColumn [^5] [^6] | ImageColumn [^5] [^6] | ImageColumn [^5] [^6] | ImageColumn [^5] [^6] | |
| image_name | | | StringColumn [^9] | StringColumn [^9] | |
| roi | | | |Will: RoiColumn [^7] | RoiColumn [^7] [^8] |
| shape | | | | LongColumn | LongColumn |

[^1]: Column renamed as `Plate`.
[^2]: Appends a StringColumn called `Plate Name`
[^3]: Column renamed as `Well`
[^4]: Appends a StringColumn called `Well Name`
[^5]: Column renamed as `Image`.
[^6]: Appends a StringColumn called `Image Name`
[^7]: Column renamed as `Roi`.
[^8]: Appends a StringColumn called `Roi Name`
[^9]: Appends an ImageColumn called `Image`