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 ContentType for Webwarp & WebAlign #51

Open
UlrikeS91 opened this issue Apr 29, 2024 · 9 comments · May be fixed by #53
Open

Add ContentType for Webwarp & WebAlign #51

UlrikeS91 opened this issue Apr 29, 2024 · 9 comments · May be fixed by #53
Assignees
Labels
ContentType ContentType instances - addition of new or update of existing ones

Comments

@UlrikeS91
Copy link
Contributor

This is one half of the original issue #10.

Both Webwarp and WebAlign have been registered and published on the Knowledge Graph:
Webwarp (0.7): https://search.kg.ebrains.eu/instances/06358a83-5bf0-4271-b482-1efc10208a0e
WebAlign (v0.7): https://search.kg.ebrains.eu/instances/5258054a-8755-428d-8d0a-cc7a344e95d9

We should register these content types now. @Majpuc suggested

{
  "@context": {
    "@vocab": "https://openminds.ebrains.eu/vocab/"
  },
  "@id": "https://openminds.ebrains.eu/instances/contentTypes/application/vnd.webalign.waln",
  "@type": "https://openminds.ebrains.eu/core/ContentType",
  "fileExtension": [
    ".waln"
  ],
  "name": "application/vnd.webalign.waln",
  "relatedMediaType": null,
  "synonym": [
    "WebAlign waln file"
  ]
}

with comment: "The waln file contains image registration information. This file type was created for WebAlign and don't exist elsewhere."

and

{
  "@context": {
    "@vocab": "https://openminds.ebrains.eu/vocab/"
  },
  "@id": "https://openminds.ebrains.eu/instances/contentTypes/application/vnd.webwarp.wwrp",
  "@type": "https://openminds.ebrains.eu/core/ContentType",
  "fileExtension": [
    ".wwrp"
  ],
  "name": "application/vnd.webwarp.wwrp",
  "relatedMediaType": null,
  "synonym": [
    "WebWarp wwrp file"
  ]
}

with comment: "The wwrp file contains image registration information. This file type was created for WebWarp and don't exist elsewhere."

@lzehl Do you think these make sense? Or should parts be changed? If these look fine, I can make the PR.

PS: I actively ignored NutilWeb since it is not published on the KG yet. @Majpuc, please open a new issue once the content types are actually needed.

@UlrikeS91 UlrikeS91 self-assigned this Apr 29, 2024
@Majpuc
Copy link

Majpuc commented Apr 29, 2024

Yes, I think you can create these two content type. Could we just ask @Tevemadar for a final check?

@lzehl
Copy link
Member

lzehl commented Apr 29, 2024

@Majpuc @UlrikeS91 I would add a "description" and modify the "synonyms" of these content types to reflect that you are talking not about one file but a software specific file format (content type). The description should potentially include the base file format (e.g. json, ascii text, csv, etc) and more details on the content (inlc structure if helpful).

From the current description (comments) they both contain the same type of data and it is unclear what the difference is. (that they are specific for the software is clear since it would be registered as the software specific content type; which is deducible already from the name)

@UlrikeS91 UlrikeS91 linked a pull request Apr 29, 2024 that will close this issue
@UlrikeS91
Copy link
Contributor Author

@Tevemadar could you please provide:

WebAlign:

  • specification of the file format (as a URL if this is already documented somewhere or as text so that I can add this under "description")
  • better synonyms (what does waln stand for? "WebAlign something something"?)

Webwarp:

  • specification of the file format (as a URL if this is already documented somewhere or as text so that I can add this under "description")
  • better synonyms (what does wwrp stand for? just "Webwarp"?)

@UlrikeS91 UlrikeS91 added ContentType ContentType instances - addition of new or update of existing ones PR made labels May 8, 2024
@Tevemadar
Copy link

Hi,
Yes, they're simple abbreviations.
There's no written specification for these formats yet.
They're closely related, technically wwrp files contain a single optional field per section on top of a waln file, that field encodes nonlinear deformation.

@lzehl
Copy link
Member

lzehl commented May 14, 2024

@Tevemadar could you please provide us with a concrete suggestion. I've started writing something for the description for each content type below but please provide a correction / extension. How these dictionaries are actually structured (what keys, what values) is hard coded in the software, correct? If that is the case, then you can provide a link to the code as specification of these formats. If not, the description is sufficient write now.

WebAlign (content type filename: application_vnd.webalign.waln.jsonld):

{
  "@context": {
    "@vocab": "https://openminds.ebrains.eu/vocab/"
  },
  "@id": "https://openminds.ebrains.eu/instances/contentTypes/application_vnd.webalign.waln",
  "@type": "https://openminds.ebrains.eu/core/ContentType",
  "description": "WebAlign waln format is used for text-based files containing the registration information for multiple tissue section images to ??? in form of a dictionary. ",
  "fileExtension": [
    ".waln"
  ],
  "name": "application/vnd.webalign.waln",
  "relatedMediaType": null,
  "synonym": [
    "WebAlign waln format"
  ]
}

Webwarp (content type filename: application_vnd.webwarp.wwrp.jsonld):


{
  "@context": {
    "@vocab": "https://openminds.ebrains.eu/vocab/"
  },
  "@id": "https://openminds.ebrains.eu/instances/contentTypes/application_vnd.webwarp.wwrp",
  "@type": "https://openminds.ebrains.eu/core/ContentType",
  "description": "WebWarp wwrp format is used for text-based files containing the same registration information for multiple tissue section images to ??? in form of a dictionary as the WebAlign waln format. However this format has the option to additionally add information on the nonlinear deformation of each tissue section image.",
  "fileExtension": [
    ".wwrp"
  ],
  "name": "application/vnd.webwarp.wwrp",
  "relatedMediaType": null,
  "synonym": [
    "WebWarp wwrp format"
  ]
}

@UlrikeS91 UlrikeS91 linked a pull request May 30, 2024 that will close this issue
@UlrikeS91 UlrikeS91 removed the PR made label Jun 4, 2024
@lzehl
Copy link
Member

lzehl commented Oct 17, 2024

@Majpuc @Tevemadar can you help formulating a correct description for each content type? See first suggestion above.

@lzehl
Copy link
Member

lzehl commented Oct 23, 2024

@Majpuc and @Tevemadar we need your feedback / help to complete these content types. Could you please have a look at the descriptions and provide corrections/completions?

@Tevemadar
Copy link

I'll try to look at them on Friday.

@Tevemadar
Copy link

While I don't really know what that field means, they may be a relatedMediaType to https://github.com/openMetadataInitiative/openMINDS_instances/blob/main/instances/latest/contentTypes/application_vnd.ebrains.image-service.deepzoom.jsonld

WebAlign waln format is used for text-based files containing the registration information for multiple tissue section images to a standard atlas space in form of a dictionary. Internally it is a JSON file that contains complete metadata for a collection of deepzoom images (mandatory), their location in the EBRAINS storage infrastructure (mandatory), identifier of the standard atlas space (mandatory), and the actual spatial registration in the form of 3D vector triplets per image (optional).

WebWarp wwrp format is used for text-based files containing the same registration information for multiple tissue section images to a standard atlas space in form of a dictionary as the WebAlign waln format. However this format has the option to additionally add information on the nonlinear deformation of each tissue section image. Internally it is the same JSON as WebAlign waln, extended with a list of 2D deformation vectors per image (optional).

I don't know the level of detail needed here, the descriptions can be stripped of the "Internally" parts, to get a simple one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ContentType ContentType instances - addition of new or update of existing ones
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants