[BUG] Fix TimeSeries data does not match length of timestamps should raise an error when created

[weiglszonja]

Motivation

This is a follow up on the issue described in #1536 to prevent a TimeSeries being created with timestamps that does not match the length of data.

This PR changes TimeSeries _check_time_series_dimension check to warn when reading from file and raise an error when constructing new data.

This change also affects ImageSeries check that will also raise a ValueError when an ImageSeries is being created with timestamps that do not match the length of data. If ImageSeries is used with external file, then this error or warning will not be triggered.

Resolve #1536

How to test the behavior?

tests/unit/test_base.py
tests/unit/test_image.py

Checklist

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

[weiglszonja]

@oruebel
In docs/gallery/domain/brain_observatory.py ImageSeries are being created with timestamps of [0], I tried to fix it but I don't have currently access to the data that is being used here to that was my guess. But it's not working yet.

[rly]

@weiglszonja

This code stores images in an ImageSeries so that they can be referenced by IndexSeries:
https://github.com/NeurodataWithoutBorders/pynwb/blob/dev/docs/gallery/domain/brain_observatory.py#L71-L85

This approach is no longer the recommended approach. Instead, use the Images and Image types with IndexSeries which was recently updated to support this. For example:
https://github.com/NeurodataWithoutBorders/pynwb/blob/dev/tests/unit/test_image.py#L313-L325