essential device metadata for 2p

[bendichter]

Radek (@chrapkiewicz) is looking at NWB for help sharing some upcoming optical data, and has some requests regarding device metadata. Here are the comments regarding 2p. (Radek, please correct and expand as necessary)

• excitation power in Watts is one of the most important pieces of metadata and is currently missing. Normal range is 20-100 mW and upper end is 200 mW.

  • It seems like this should go in the ImagingPlane object.

• imaging_depth is another important parameter.

• No one is using lumens. People record the power they apply, but never the power they collect. We should not require users to express their data in lumens.

  • We should change the units of TwoPhotonSeries.

• The two most important things to document are the objective lens and the laser. For Objective lens, the most important features are:

  • manufacturer: str
  • magnification: float
  • numerical aperture: float between 0 and ~2

• For laser, the most important features are:

  • pulse duration in femtoseconds (usually about 100 fs)
  • repetition rate (usually about 80 MHz)
  • dispersion compensation (e.g. -100000 fs^2). This is important from an engr perspective but is often not known by biologists, so it should be optional.

For the OpticalChannel associated with an ImagingPlane, there should be a linked dichroic filter. This would have features:

• central wavelength: float
• bandwidth: float

There is a general rule that Radek recommended for devices that would apply to both the laser, objective lens, and the diachroic filter: The essential metadata would be fully captured if the user supplied the part model number. If the model number is given, the other data can be looked up and that should be counted as sufficient. I think this could be a general rule across modalities so I am going to make it a separate issue (#461), but I thought it was worth noting here.

I'm not sure how to reconcile the metadata requirements with the current data types. ImagingPlane requires a generic Device type. Maybe the most straightforward thing would be to define a 2PMicroscope type that contains a Lens and Laser (both of which are also Device s), and then encourage users to use a 2PMicroscope instead of a generic Device.

[chrapkiewicz]

Hi, I will be happy to help and provide more information for one-photon and two-photon imaging to make sure collected data makes datasets reproducible and promotes best practices in terms of appropriate experiment documentation. Before going into low-level details, I would suggest a short discussion or just introducing me how do you currently see generic microscope recordings on the high-level. From the diagrams found in: https://neurodatawithoutborders.github.io/matnwb/tutorials/html/ophys.html It looks to me the key class currently is ImagingPlane and perhaps TwoPhotonSeries which of course does not cover any one-photon imaging which is really a widespread technique, probably with more users than two-photon these days.

We can logically break apart objects related to the apparatus, particular imaging session, surgical preparation of the mouse on the higher level, and then properly define each of those subcategories.

[chrapkiewicz]

A few more comments on Ben's summary:

• excitation power - ok, really important parameter for the reproduction of the results in terms of the mouse safety and resulting SNR
• units of collected data - virtually no one knows it. At best you can express it in photon numbers (unitless) or W/pixel but the calibration is tricky and a very few labs could provide this information.

Objective lens: manufacturer: str magnification: float numerical aperture: float between 0 and ~2, high-end objectives for two-photon have NA=1.1, the values can get much larger for in-vitro imaging with confocal microscopes (formally NA=n x sin(theta), and n index of refraction n>=1

Standard 2PMicroscope can be just broken down into objective lens (replaceable), laser model (may vary independently from microscope body), filters (set for individual measurements) and optionally PMTs (they are occasionally upgraded). Custom 2p microscopes have just a few more components to be reported (and they always are there). I can comment on it later.

[rly]

This is currently being addressed and tested through NWB extensions:

• https://github.com/catalystneuro/ndx-microscopy
• https://github.com/catalystneuro/ndx-ophys-devices

[chrapkiewicz]

Thanks, happy to help in review / further ideas