Add optional parameters to OpticalSeries constructor

[bendichter]

fix #1616

Motivation

The OpticalSeries class in PyNWB currently requires the fields 'distance', 'orientation', and 'field_of_view' in its constructor, but according to the NWB schema these fields should be optional. This PR fixes this discrepancy by making these fields optional in the code to match the schema specification.

How to test the behavior?

from pynwb.image import OpticalSeries

# Create OpticalSeries without the optional fields
optical_series = OpticalSeries(
    name='test_optical_series',
    data=np.ones((2, 2, 2)),  # example data
    unit='pixels',
    timestamps=[1.0, 2.0]
)

# All these fields should be None
assert optical_series.distance is None
assert optical_series.field_of_view is None
assert optical_series.orientation is None

Checklist

[x] Did you update CHANGELOG.md with your changes?
[x] Have you checked our Contributing document?
[x] Have you ensured the PR clearly describes the problem and the solution?
[x] Is your contribution compliant with our coding style? This can be checked running ruff check . && codespell from the source directory.
[x] Have you checked to ensure that there aren't other open Pull Requests for the same change?
[x] Have you included the relevant issue number using "Fix #1616" notation where XXX is the issue number? By including "Fix #1616" you allow GitHub to close issue #1616 when the PR is merged.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.78%. Comparing base (f3b3306) to head (fa59027).
Report is 1 commits behind head on dev.

Additional details and impacted files

@@           Coverage Diff           @@
##              dev    #2023   +/-   ##
=======================================
  Coverage   91.78%   91.78%           
=======================================
  Files          27       27           
  Lines        2738     2738           
  Branches      709      709           
=======================================
  Hits         2513     2513           
  Misses        149      149           
  Partials       76       76           

Flag	Coverage Δ
integration	73.15% <ø> (ø)
unit	82.39% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[bendichter]

@stephprince fixed

[stephprince]

looks good - thanks!