Behavior

SpatialSeries

SpatialSeries objects are specifically for the position (angular or translational) of a Subject over time. Related data such as velocity and acceleration should be placed in a different neurodata object.

SpatialSeries Dimensionality

SpatialSeries should have 1 column (x), 2 columns (x, y), or 3 columns (x, y, z).

Check function: check_spatial_series_dims()

SpatialSeries Units

When a SpatialSeries is in a CompassDirection, the units should either be “degrees” or “radians”.

Check function: check_compass_direction_unit()

SpatialSeries General Units

A SpatialSeries that is not inside a CompassDirection should have a unit from the following recognized set: “meters”, “centimeters”, “millimeters”, “micrometers”, “degrees”, “radians”, “pixels”, or “n.a.” (not available) as a placeholder when the unit is not known. These follow the PyNWB convention of full SI words in plural form.

Check function: check_spatial_series_unit()

SpatialSeries Data Values

When a SpatialSeries has units “radians”, it should have data values between -2π and 2π. When a SpatialSeries has units “degrees”, it should have data values between -360 and 360.

Check functions: check_spatial_series_radians_magnitude(), check_spatial_series_degrees_magnitude()