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

52 control vocabulary for targeted structures #53

Merged
merged 17 commits into from
Sep 3, 2024

Conversation

dbirman
Copy link
Member

@dbirman dbirman commented Aug 12, 2024

Adds a new Mouse CCF class, use by doing:

from aind_data_schema_models.mouse_ccf import CCFStructure

and then:

CCFStructure.ROOT
CCFStructure.VISP

etc

Also available are:

CCFStructure.from_id(997)
CCFStructure.from_acronym('root')
CCFStructure.acronym2id("root")
CCFStructure.id2acronym(997)

This was linked to issues Aug 12, 2024
@dbirman dbirman requested review from dyf and saskiad August 12, 2024 21:39
@dbirman dbirman requested a review from saskiad August 13, 2024 17:08
Copy link
Member

@dyf dyf left a comment

Choose a reason for hiding this comment

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

I'm a little nervous calling the CCF terms a registry, given that we historically called it an "ontology" and now some are pushing for "parcellation terminology".

Suspect we might have to change this later, but likely we will want to wholesale rename Registry to something else, so I guess we can proceed as-is.

src/aind_data_schema_models/models/registries.csv Outdated Show resolved Hide resolved
@dbirman dbirman requested a review from dyf August 15, 2024 17:54
@saskiad
Copy link
Collaborator

saskiad commented Aug 15, 2024

I'm a little nervous calling the CCF terms a registry, given that we historically called it an "ontology" and now some are pushing for "parcellation terminology".

Suspect we might have to change this later, but likely we will want to wholesale rename Registry to something else, so I guess we can proceed as-is.

Is your concern about having it in a list of registries? Or in having the field that references it be registry? Because the latter is vestigial from using PIDName and I'm thinking we don't need to be super strict on that. We can call the field "ontology" in its place. (I'm not sure parcellation terminology is going to work well).

@saskiad
Copy link
Collaborator

saskiad commented Aug 15, 2024

Okay, @dyf and I hashed this out

  • let's not add CCF to the registries
  • in the CCFStructureModel have these fields:
  • - atlas (hard coded to CCF v3)
  • - name
  • - acronym
  • - id

Future issue will be to get rid of the concept of a Registry and adjust the schema to point to taxonomies more directly. Since we aren't using the PIDName structure we can do this more easily. This will be a big change, but I think it will be better (and reduce nesting)

@dbirman
Copy link
Member Author

dbirman commented Aug 15, 2024

Okay those changes are in place, either of you can merge this and maybe make a ticket to track the larger change if you didn't already?

@dbirman dbirman requested a review from dyf August 22, 2024 15:48
@dbirman
Copy link
Member Author

dbirman commented Aug 27, 2024

After discussion w/ Saskia we decided:

  1. Not to change the base CSV files, they just have floats for now (these are pulled directly from BG)
  2. To refactor the model to a single class that can be shared across different atlases

See brain_atlas.py for how I built CCFStructure, other atlases can easily be added by copying the CSV file and repeating that pattern. It would be very quick to add all the remaining BG atlases now (rat, etc).

To do this I also had to add a new feature to create_literal_class that lets you pass a value that is shared.

@dbirman dbirman requested a review from saskiad August 27, 2024 17:42
@saskiad saskiad removed the request for review from dyf August 28, 2024 00:06
@dbirman dbirman requested a review from dyf August 30, 2024 17:35
@saskiad saskiad merged commit 9e20b6f into main Sep 3, 2024
4 checks passed
@saskiad saskiad deleted the 52-control-vocabulary-for-targeted-structures branch September 3, 2024 22:02
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.

Control vocabulary for targeted structures Add brain regions
3 participants