FZJ-INM1-BDA / siibra-python

Software interfaces for interacting with brain atlases - Python client
Apache License 2.0
47 stars 9 forks source link

Solidfy descriptive attributes of siibra concepts (i.e. atlas, parcellation, space, region, feature) #417

Open AhmetNSimsek opened 1 year ago

AhmetNSimsek commented 1 year ago

Each feature name should be informative but as brief as possible especially considering the display in the explorer.

EDT: Feature names need to be reworked for the next release of siibra-explorer

xgui3783 commented 1 year ago

I would argue, the name should be concise but descriptive enough for user of siibra-python

AhmetNSimsek commented 1 year ago

Naming examples for queries with the region siibra.get_region("2.9", 'hoc1 left') as of 0.4a59 - dfce6eccb9bd36659125b390a8e2ca3c256ea002:

(Ebrains query)

(gene=siibra.vocabularies.GENE_ NAMES.GABARAP)

For the other voi:

Querry for julich brain 2.9 parcellation:

AhmetNSimsek commented 9 months ago

Dev meeting 07.12.2023 update:

Several attributes describing siibra concepts are not necessarily clearly defined. The table below shows what it should be and the restrictions on the attributes.

Concept Name Shortname key id description
Atlas title of a panel or a window to label UI elements autocompletion and registry at run time to encode the state  
Parcellation title of a panel or a window to label UI elements autocompletion and registry at run time to encode the state  
Region title of a panel or a window        
Parc map title of a panel or a window   autocompletion and registry at run time    
Space title of a panel or a window to label UI elements autocompletion and registry at run time to encode the state  
Feature title of a panel or a window search lists and title on side bar   to encode the state  
           
style human readable human readable upper case wo special chars uuid and persistent human readable
length 120 chrs or so: important words show up in truncated version too fits to the chips not constrained   a paragraph

see features names in version v0.4a59 see features names in version 1.0a05

AhmetNSimsek commented 7 months ago

Names as of v1.0a05 (see comment for v.04a59)

(Ebrains query)

(gene=siibra.vocabularies.GENE_ NAMES.GABARA)

(Connectivity for Julich Brain 3.0)

AhmetNSimsek commented 7 months ago

Suggestions for features

Examples

(gene=siibra.vocabularies.GENE_ NAMES.GABARAP)

(Connectivity for Julich Brain 3.0)

No idea at the moment

No change:

(Ebrains query)

xgui3783 commented 7 months ago

n.b. changing names will change the feature id.

This invalidates all URLs that has feature selected.

as discussed with @AhmetNSimsek :

Also to consider: how to more efficiently encode the id of compound/live query feature

dickscheid commented 6 months ago

Are the suggestions above for the name attribute?

I think we have to suggest the complete picture of all necessary attributes, building on the table from Dec 7 where we outlines the use of the different properties. I suggest to expand the suggestions above into a table, with columns "name", "shortname", "description".

One particular issue is in my eyes, whether the location information is needed in the name at all. I think the location (assigned region, coordinate[s], bounding box) could well be a separate attribute, or be requested from the str representation of the anatomical anchors when needed. The question is wether the location is required in the name to disambiguate in any of the relevant use cases.

xgui3783 commented 6 months ago

re: if location is needed at all in name and/or shortname attribute

correct me if I am wrong, but in some cases, the location is the only differentiator, e.g. big brain cell intensity (?)

ping @AhmetNSimsek

AhmetNSimsek commented 6 months ago

Are the suggestions above for the name attribute?

Yes since the explorer currently uses the name property to populate the text for a feature. Ideally, we should define and discuss all. However, this is currently a blocking issue for the release of next siibra-explorer version (which includes some improvements along with compound features (so F-Tract as well)). Therefore, we wanted to start "small" and go for a release ASAP.

One particular issue is in my eyes, whether the location information is needed in the name at all. I think the location (assigned region, coordinate[s], bounding box) could well be a separate attribute, or be requested from the str representation of the anatomical anchors when needed. The question is wether the location is required in the name to disambiguate in any of the relevant use cases.

There are features that has an anchor with location only. Therefore, distinguishing them is impossible without the location information. We could remedy this by indexing the points for example, i.e., "Modified silver staining intensity - point #1" (since it will be a compound feature). (Then the user can check the exact location by location property.) BUT this is not a guaranteed for features to be introduced in the future.

AhmetNSimsek commented 6 months ago

I think we have to suggest the complete picture of all necessary attributes, building on the table from Dec 7 where we outlines the use of the different properties. I suggest to expand the suggestions above into a table, with columns "name", "shortname", "description".

Concept Name Shortname key id description
CF BigBrainIntensityProfile 1579 modified silver staining profiles - Area hOc1 (V1, 17, CalcS) left, 1579 points in ([-63.69,-59.94,-29.09], [0.91,77.90,54.03])mm in BigBrain  
GeneExpression GABARAP gene expression in 64 points in ([-17.00,-99.00,-7.00], [0.06,-59.00,14.00])mm in ICBM 2009c nonl asym  
LayerwiseBigBrainIntensity Layerwise cell body density anchored at 10 points in ([-3.95,-65.80,-0.44], [20.20,-42.70,9.71])mm on BigBrain assigned to Area hOc1 (V1, 17, CalcS) left of Julich Brain 2.9  
Sections Section 47: 1-micron cell-body-staining scans of BigBrain (v1.0)
BlockfaceVOI The Enriched Connectome - Block face images of full sagittal human brain sections
CF AnatomoFunctionalConnectivity 78 anatomo functional connectivity matrices for Julich-Brain 3.0.3 - cohort: adult pharmaco-resistant focal epilepsy patients  
AnatomoFunctionalConnectivity P_01: amplitude__mad anatomo functional connectivity for Julich-Brain 3.0.3 - cohort: adult pharmaco-resistant focal epilepsy patients  
CF FunctionalConnectivity 200 functional connectivity matrices for Julich-Brain 3.0.3 - cohort: HCP, paradigm: Resting state (EmpCorrFC concatenated)  
FunctionalConnectivity Subject 000 functional connectivity for Julich-Brain 3.0.3 - cohort: HCP, paradigm: Resting state (EmpCorrFC concatenated)  
EbrainsDataset Ebrains Dataset: CEREBRUM-7T: Fast and Fully-volumetric Brain Segmentation of 7 Tesla MR Volumes (v1)  
ReceptorDensityFingerprint 16 receptor density profiles - Area hOc1 (V1, 17, CalcS)  
ReceptorDensityProfile 5-HT1A receptor density profile - Area hOc1 (V1, 17, CalcS)