egrace479 commited on
Commit
5d9aaac
1 Parent(s): 10f6ed4

Update column descriptions in README

Browse files
Files changed (1) hide show
  1. README.md +6 -3
README.md CHANGED
@@ -120,7 +120,7 @@ Segmentation was completed by adapting the elytra length and width annotations t
120
  - `cm_pix`: Integer. The number of pixels in a centimeter on the scalebar (measured by Euclidean distance between points given in `scalebar`).
121
  - `individual`: Integer. The beetle in the image to whom the measurements refer. The beetles are measured "in line" (numbering is from left to right, top to bottom, as one would read a book). However, Zooniverse does not register individual IDs beyond 99 (once 99 individuals are marked, it restarts the count at 1). Be careful with it.
122
  - `structure`: Whether the measurement applies to the length or width of the elytra (`ElytraLength` or `ElytraWidth`, respectively).
123
- - `lying_straight`: Whether or not the beetle is lying _flat_ in the image (`Yes` or `No`). This does _NOT_ correlate to vertical or horizontal alignment; it is whether the individual is twisted to one side or not--a side effect of how they died. Generally, the measured width will be shorter than the true width if this is `No`.
124
  - `coords_pix`: Pixel coordinates of the line marking the length or width of the elytra (green or purple line in the sample image). Note that these annotations were done on the resized copy of the image (1MB), but the aspect ratio was maintained in the resizing.
125
  - `dist_pix`: Float. The length or width of the elytra (indicated by `structure`) as measured in pixels (calculated as Euclidean distance beetween `coords_pix` points).
126
  - `dist_cm`: Float. The length or width of the elytra (indicated by `structure`) as measured in centimeters using the scalebar compared to the measured pixel distance (`dist_pix/cm_pix`).
@@ -136,6 +136,9 @@ Segmentation was completed by adapting the elytra length and width annotations t
136
  - `combinedID`: Generated from `PictureID` (minus the `.jpg`) plus `_<individual>`. This gives only 11,104 IDs, as it suffers from the issue of `individual` based on Zooniverse's export. Individuals should be measured by half the number of rows with `user_name == "IsaFluck"`.
137
  - `measureID`: Unique identifier for the beetle measurements (and this CSV), generated using the `uuid` package. There are 39,064 unique measurements (2 per beetle, with overlap on 234 images annotated by all three annotators and 1 annotated by just two).
138
  - `file_name`: Relative path to image from the root of the directory (`<group_images>/<pictureID>.jpg`); allows for image to be displayed in the dataset viewer alongside its associated metadata.
 
 
 
139
 
140
  **NOTE:**
141
  - The `NEON_sampleID` RMNP_014.20180709.CALADV.01 is repeated because there were too many individuals in the sample to organize them all in one picture. Thus, the individuals from this sample are split between two pictures: `A00000051555_1` and `A00000051555_2`.
@@ -143,17 +146,17 @@ Segmentation was completed by adapting the elytra length and width annotations t
143
  - See notebooks in the [Beetle Processing Repository](https://github.com/Imageomics/2018-NEON-beetles-processing) for more information and analyses of these values, addition and renaming of the above columns from the [original measurement CSV](https://huggingface.co/datasets/imageomics/2018-NEON-beetles/blob/bbefad05d50ed55da82e99bd330afe12a5fd1d97/BeetleMeasurements.csv), and the creation of the individual metadata CSV.
144
  - `BeetleMeasurements_resized.csv` has `pictureID`, `scientificName`, `genus`, `species`, `NEON_sampleID`, `siteID`, and `file_name` columns to display the resized images in the dataset viewer with some group image-level information. It will match up to information from `BeetleMeasurments.csv` on `pictureID`, though this is _not_ a unique alignment since it's not a unique ID for `BeetleMeasurements.csv`, but is for the resize.
145
 
146
- **TODO:* Make individual metadata CSV file:
147
 
148
  **individual_metadata.csv**:
149
  - `individualID`: ID of beetle in the individual image (`<measureID_length>_<measureID_width>`). This is a unique identifier for this CSV.
150
  - `combinedID`: Generated from `PictureID` (minus the `.jpg`) plus `_<individual>`. (Matches `combinedID` in `BeetleMeasurements.csv`.)
 
151
  - `elytraLength`: Length of the elytra in centimeters. Indicated by the green line in the image below.
152
  - `elytraWidth`: Width of the elytra in centimeters. Indicated by the purple line in the image below.
153
  - `measureID_length`: `measureID` from `BeetleMeasurements.csv` for the `elytraLength` of this individual. Can be used to fetch measure-specific information from `BeetleMeasurements.csv`.
154
  - `measureID_width`: `measureID` from `BeetleMeasurements.csv` for the `elytraWidth` of this individual. Can be used to fetch measure-specific information from `BeetleMeasurements.csv`.
155
  - `genus`: Genus of the individual (generated by taking the first word in the `scientificName` from `BeetleMeasurements.csv`). There are 36 unique genera labeled.
156
- - `species`: Species of the individual (generated from the word(s) following the `genus` in the `scientificName` from `BeetleMeasurements.csv). There are 78 unique species labeled.
157
  - `NEON_sampleID`: NEON identifier for the sample (576 unique IDs), prefixed by the `plotID`. (Matches `NEON_sampleID` in `BeetleMeasurements.csv`.)
158
  - `file_name`: Relative path to image from the root of the directory (`individual_images/<individualID>.jpg`); allows for image to be displayed in the dataset viewer alongside its associated metadata.
159
 
 
120
  - `cm_pix`: Integer. The number of pixels in a centimeter on the scalebar (measured by Euclidean distance between points given in `scalebar`).
121
  - `individual`: Integer. The beetle in the image to whom the measurements refer. The beetles are measured "in line" (numbering is from left to right, top to bottom, as one would read a book). However, Zooniverse does not register individual IDs beyond 99 (once 99 individuals are marked, it restarts the count at 1). Be careful with it.
122
  - `structure`: Whether the measurement applies to the length or width of the elytra (`ElytraLength` or `ElytraWidth`, respectively).
123
+ - `lying_flat`: Whether or not the beetle is lying _flat_ in the image (`Yes` or `No`). This does _NOT_ correlate to vertical or horizontal alignment; it is whether the individual is twisted to one side or not--a side effect of how they died. Generally, the measured width will be shorter than the true width if this is `No`.
124
  - `coords_pix`: Pixel coordinates of the line marking the length or width of the elytra (green or purple line in the sample image). Note that these annotations were done on the resized copy of the image (1MB), but the aspect ratio was maintained in the resizing.
125
  - `dist_pix`: Float. The length or width of the elytra (indicated by `structure`) as measured in pixels (calculated as Euclidean distance beetween `coords_pix` points).
126
  - `dist_cm`: Float. The length or width of the elytra (indicated by `structure`) as measured in centimeters using the scalebar compared to the measured pixel distance (`dist_pix/cm_pix`).
 
136
  - `combinedID`: Generated from `PictureID` (minus the `.jpg`) plus `_<individual>`. This gives only 11,104 IDs, as it suffers from the issue of `individual` based on Zooniverse's export. Individuals should be measured by half the number of rows with `user_name == "IsaFluck"`.
137
  - `measureID`: Unique identifier for the beetle measurements (and this CSV), generated using the `uuid` package. There are 39,064 unique measurements (2 per beetle, with overlap on 234 images annotated by all three annotators and 1 annotated by just two).
138
  - `file_name`: Relative path to image from the root of the directory (`<group_images>/<pictureID>.jpg`); allows for image to be displayed in the dataset viewer alongside its associated metadata.
139
+ - `image_dim`: Dimensions of full-sized image `(<height>, <width>, <number of channels>)`.
140
+ - `resized_image_dim`: Dimensions of resized image `(<height>, <width>, <number of channels>)`.
141
+ - `coords_pix_scaled_up`: `coords_pix` adjusted for full-sized image.
142
 
143
  **NOTE:**
144
  - The `NEON_sampleID` RMNP_014.20180709.CALADV.01 is repeated because there were too many individuals in the sample to organize them all in one picture. Thus, the individuals from this sample are split between two pictures: `A00000051555_1` and `A00000051555_2`.
 
146
  - See notebooks in the [Beetle Processing Repository](https://github.com/Imageomics/2018-NEON-beetles-processing) for more information and analyses of these values, addition and renaming of the above columns from the [original measurement CSV](https://huggingface.co/datasets/imageomics/2018-NEON-beetles/blob/bbefad05d50ed55da82e99bd330afe12a5fd1d97/BeetleMeasurements.csv), and the creation of the individual metadata CSV.
147
  - `BeetleMeasurements_resized.csv` has `pictureID`, `scientificName`, `genus`, `species`, `NEON_sampleID`, `siteID`, and `file_name` columns to display the resized images in the dataset viewer with some group image-level information. It will match up to information from `BeetleMeasurments.csv` on `pictureID`, though this is _not_ a unique alignment since it's not a unique ID for `BeetleMeasurements.csv`, but is for the resize.
148
 
 
149
 
150
  **individual_metadata.csv**:
151
  - `individualID`: ID of beetle in the individual image (`<measureID_length>_<measureID_width>`). This is a unique identifier for this CSV.
152
  - `combinedID`: Generated from `PictureID` (minus the `.jpg`) plus `_<individual>`. (Matches `combinedID` in `BeetleMeasurements.csv`.)
153
+ - `lying_flat`: Whether or not the beetle is lying _flat_ in the image (`Yes` or `No`). This does _NOT_ correlate to vertical or horizontal alignment; it is whether the individual is twisted to one side or not--a side effect of how they died. Generally, the measured width will be shorter than the true width if this is `No`.
154
  - `elytraLength`: Length of the elytra in centimeters. Indicated by the green line in the image below.
155
  - `elytraWidth`: Width of the elytra in centimeters. Indicated by the purple line in the image below.
156
  - `measureID_length`: `measureID` from `BeetleMeasurements.csv` for the `elytraLength` of this individual. Can be used to fetch measure-specific information from `BeetleMeasurements.csv`.
157
  - `measureID_width`: `measureID` from `BeetleMeasurements.csv` for the `elytraWidth` of this individual. Can be used to fetch measure-specific information from `BeetleMeasurements.csv`.
158
  - `genus`: Genus of the individual (generated by taking the first word in the `scientificName` from `BeetleMeasurements.csv`). There are 36 unique genera labeled.
159
+ - `species`: Species of the individual (generated from the word(s) following the `genus` in the `scientificName` from `BeetleMeasurements.csv`). There are 78 unique species labeled.
160
  - `NEON_sampleID`: NEON identifier for the sample (576 unique IDs), prefixed by the `plotID`. (Matches `NEON_sampleID` in `BeetleMeasurements.csv`.)
161
  - `file_name`: Relative path to image from the root of the directory (`individual_images/<individualID>.jpg`); allows for image to be displayed in the dataset viewer alongside its associated metadata.
162