bids-specification icon indicating copy to clipboard operation
bids-specification copied to clipboard

Add 1PE to complement 2PE (microscopy)

Open yarikoptic opened this issue 4 months ago • 10 comments

https://blog.biodock.ai/one-vs-two-photon-microscopy/ seems to provide a nice comparison between one- and two-photon microscopy. Also https://www.gophotonics.com/community/what-are-single-photon-and-two-photon-excitation provides another comparison and uses "excitation" consistently between them.

Note that there is also already "FLUO" suffix for "Fluorescence microscopy" in general, of which both 1PE and 2PE and likely MPE (multi-photon) mechanisms are, so unclear when FLUO to be used, but I guess 2PE, MPE and now 1PE should be RECOMMENDED to be used in favor of FLUO as more specific

Some related references:

  • https://github.com/bids-standard/bids-specification/pull/1632

ping @bids-standard/bep031 @bendichter

yarikoptic avatar Aug 18 '25 18:08 yarikoptic

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 82.71%. Comparing base (5a357dd) to head (f5906f7). :warning: Report is 8 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2173   +/-   ##
=======================================
  Coverage   82.71%   82.71%           
=======================================
  Files          20       20           
  Lines        1608     1608           
=======================================
  Hits         1330     1330           
  Misses        278      278           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

codecov[bot] avatar Aug 18 '25 18:08 codecov[bot]

cc @bids-standard/bep031

effigies avatar Aug 26 '25 12:08 effigies

pinging wider @bids-standard/maintainers for blessing on this

yarikoptic avatar Sep 15 '25 18:09 yarikoptic

  • Who needs this?
  • Is this an addition, or a refinement of FLUO?
  • Is any metadata needed to make 1PE images usable?
  • Are there any microscopy practitioners who support this?

@jcohenadad would you be willing to weigh in on this?

effigies avatar Sep 15 '25 19:09 effigies

I don't have enough expertise in microscopy, sorry

jcohenadad avatar Sep 15 '25 19:09 jcohenadad

Okay, failing that, @yarikoptic I think it would be good to seek out some kind of consensus and not a bunch of non-practitioners who have commit privileges. IDK if posting to the bids-discussion list makes sense? Or perhaps OME lists?

effigies avatar Sep 16 '25 14:09 effigies

@CodyCBakerPhD @bendichter , may be you could assist

  • how much of one-photon imaging data do we have in dandi?
  • do you see anything critical missing from https://bids-specification.readthedocs.io/en/stable/modality-specific-files/microscopy.html#microscopy-metadata-sidecar-json which would needs to be there for 1PE in addition to 2PE or FLUO?

yarikoptic avatar Sep 16 '25 19:09 yarikoptic

@yarikoptic BIDS microscopy only applies to static images to my understanding. We may have a certain number of those scattered throughout (namely for anatomical markers) but the majority is time-dependent (videos)

There is a fair amount of metadata missing overall in BIDS to 'pull out' from NWB (field of view, coordinate systems, grid spacing, depths, optical channels)

From what I see the minimal amount to distinguish from 2P would be the excitation wavelengths (scalar per optic channel; technically the 'peak' of the excitation waveform). Some people even think the full waveform matters but can also usually be pulled from external sources if you specify the indicator

CodyCBakerPhD avatar Sep 16 '25 19:09 CodyCBakerPhD

@yarikoptic BIDS microscopy only applies to static images to my understanding.

as I have mentioned in

  • https://github.com/bids-standard/bids-specification/pull/1632#issuecomment-1769248031

there is nothing in BIDS microscopy restricting to anatomical, although indeed lacking desired temporal data formalized.

But overall questions mostly relevant to this particular PR: -given current listed support of 2PE and FLUO, would addition of 1PE be warranted for 1PE datasets (temporal data is not forbidden, thus IMHO permitted)?

  • if not - would FLUO be appropriate for 1PE (but at the cost of loosing expresiveness)?
  • Could there be FLUO which is not 1PE or 2PE?

yarikoptic avatar Sep 18 '25 14:09 yarikoptic

  1. @just-meng knows it all and gonna fix everything!

yarikoptic avatar Oct 25 '25 12:10 yarikoptic