Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some HiP-CT docs #18

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add some HiP-CT docs #18

wants to merge 1 commit into from

Conversation

dstansby
Copy link
Member

This adds some docs on the HiP-CT data, including registrations, as requested by @kabilar. cc @ucbpclw

The chunk number is set to `yyxx`, where yy is the resolution of the scan in micrometers, and xx is a scan number that is unique between datasets.
For example, a scan number of `402` is the second 4um scan.
The highest lowest resolution dataset (equivalently, highest chunk number) is the overview dataset that contains an image of the whole sample.
There are then one or more datsets at higher resolution.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
There are then one or more datsets at higher resolution.
There are then one or more datasets at higher resolution.


Datasets have the name `sub-<donor>_sample-<sample name>_chunk<chunk number>_PC.ome.zarr`.
The chunk number is set to `yyxx`, where yy is the resolution of the scan in micrometers, and xx is a scan number that is unique between datasets.
For example, a scan number of `402` is the second 4um scan.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For example, a scan number of `402` is the second 4um scan.
For example, a chunk number of `402` is the second 4um scan.

Datasets have the name `sub-<donor>_sample-<sample name>_chunk<chunk number>_PC.ome.zarr`.
The chunk number is set to `yyxx`, where yy is the resolution of the scan in micrometers, and xx is a scan number that is unique between datasets.
For example, a scan number of `402` is the second 4um scan.
The highest lowest resolution dataset (equivalently, highest chunk number) is the overview dataset that contains an image of the whole sample.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The highest lowest resolution dataset (equivalently, highest chunk number) is the overview dataset that contains an image of the whole sample.
The lowest resolution dataset (equivalently, highest chunk number) is the overview dataset that contains an image of the whole sample.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this file.

For more information on the modality see the [HiP-CT website](https://mecheng.ucl.ac.uk/hip-ct/).
Most of the time HiP-CT consists of a single 'low' (but still quite high!) resolution scan of a whole sample, and then one or more 'high' resolution scans of particular volumes of interest within the same sample.

## Data information
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Data information
## Data acquisition and naming

Comment on lines +12 to +13
Datasets have the name `sub-<donor>_sample-<sample name>_chunk<chunk number>_PC.ome.zarr`.
The chunk number is set to `yyxx`, where yy is the resolution of the scan in micrometers, and xx is a scan number that is unique between datasets.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we should use the acq entity for the resolution. The chunk entity could be used for different fields of view in the same sample. If the same field of view is acquired multiple times then perhaps the ses entity should be used.

Copy link
Member

@kabilar kabilar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @dstansby. This is great. I have a few suggestions above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants