obi icon indicating copy to clipboard operation
obi copied to clipboard

Created data-sets template and added image data sets from MRIO

Open adbartni opened this issue 2 years ago • 7 comments

Using templates where applicable

adbartni avatar Apr 14 '22 19:04 adbartni

Thanks! I will take a look soon.

jamesaoverton avatar Apr 20 '22 14:04 jamesaoverton

@adbartni we can discuss this on the June 6, 2022 OBI dev call. Can you attend?

cstoeckert avatar May 09 '22 16:05 cstoeckert

@cstoeckert That works for me, I'll be there. I'll discuss with Alex Diehl and others to see if they can join as well.

adbartni avatar May 19 '22 13:05 adbartni

We would still be happy to discuss this on an OBI developer call. Is there a convenient time @adbartni ?

jamesaoverton avatar Jul 25 '22 16:07 jamesaoverton

So sorry for the delay, I've had to juggle a few projects for my thesis lately. I'll jump on the OBI developer call today to discuss, since it looks like there's time allotted for discussing open PRs on the agenda.

adbartni avatar Aug 15 '22 14:08 adbartni

I've managed to sort out the conflicts with the up to date obi-edit.owl and assays.owl/tsv files and am trying to keep the changes confined to templates as much as possible this time around.

Since the edit I want to make to magnetic resonance imaging assay is to add an axiom stating that its specified output is a magnetic resonance image dataset, the tests will fail because the assays template is processed first and the magnetic image dataset class is never inserted. I'd gotten around this the first time I submitted this PR by added a blank class to obi-edit.owl for magnetic resonance image dataset to allow the test to run, but as I mentioned I'm trying to keep the changes as much as possible in the templates.

My question before proceeding is if these changes so far can be merged so that magnetic resonance image data at least is in obi-edit.owl so that I can properly add the specified output axiom to magnetic resonance imaging assay. Or should I just do what I did before and add the bare class for magnetic resonance image dataset directly to obi-edit.owl and let the template update the axioms?

adbartni avatar Aug 26 '22 18:08 adbartni

Discussed on 8/29 call: Agreement to add the needed classes to obi-edit.owl first. Minor edits were suggested to call it 'imaging data set', and to add examples (including what is not covered).

bpeters42 avatar Aug 29 '22 16:08 bpeters42

@jamesaoverton We've added the examples of usage to our new terms. Before merging, we'd like to discuss the renaming of 'image data set' to 'imaging data set' and our concerns on the 11/21 developer call if there's time.

adbartni avatar Nov 17 '22 19:11 adbartni

@bpeters42 We discussed on the obi-developer call today, but wanted to get your opinion before moving forward.

We would prefer keeping the label 'image data set' as opposed to 'imaging data set.' Although some image data sets are the direct result of an imaging assay, within MRIO we have subclasses of 'image data set' (such as 'computed image data set,' 'image segmentation map') that are derived from a 'data transformation' of an existing 'image data set.' As such, we think it makes more sense to leave the label 'image data set' so that there is no confusion whether 'image data sets' are only produced by an imaging assay.

adbartni avatar Nov 21 '22 19:11 adbartni

My concern was that the definition of 'image data set' was not general and didn't seem to match the label. If the definition is broad in line with the label, I have no concerns.

bpeters42 avatar Nov 21 '22 21:11 bpeters42

We have revised the definition of 'image data set' to better convey what our class is intended to represent in reality.

Original definition: "A data set that is comprised of structured measurements about some entity and its associated metadata using pixels (2D), voxels (3D), or an arbitrary number of dimensions. An image data set can be the source from which an image is produced."

New definition: "A data set that is comprised of multidimensional structured measurements and metadata required for a morphological representation of an entity. An image data set can be the source from which an image (such as a 2D image using pixels or a 3D image using voxels) is produced."

adbartni avatar Dec 02 '22 01:12 adbartni

2023-02-06 @bpeters42 Please review (definition changed).

johnwjudkins avatar Feb 06 '23 17:02 johnwjudkins

Discussed on call 02/27/23:

  1. Approved this proposed definition for image data set
  2. Consider adding "spatial data set" as a parent of image data set at a later date.
  3. Bjoern note: images are expected to represent spatial organization of entities, and exclude things like graphs of MS peaks or an organizational chart

DanBerrios avatar Feb 27 '23 17:02 DanBerrios

I'm very sorry that this has taken so long. We will get this PR merged as soon as possible.

One more thing: My understanding is that you prefer the label 'image data set', but the PR still uses 'imaging data set' throughout. Should all 'imaging data set' strings in the PR be changed to 'imaging data set', which would also mean changing 'magnetic resonance imaging data set' to 'magnetic resonance image data set' and 'raw imaging data set' to 'raw image data set'?

jamesaoverton avatar Feb 27 '23 17:02 jamesaoverton

@jamesaoverton I can't make the meeting today so I figured I'd ping you here.

I updated the labels to 'image data set' from 'imaging data set' for the three terms in the data-sets template. Let me know if there's anything else that should be done, but I think it should be ready for merging.

adbartni avatar Mar 06 '23 16:03 adbartni