CompassDirection

See also:: Format Specification or Source Specification for CompassDirection.

class types.core.CompassDirection(varargin)[source]

Bases: types.core.NWBDataInterface, types.untyped.GroupClass, matnwb.mixin.HasUnnamedGroups

COMPASSDIRECTION - With a CompassDirection interface, a module publishes a SpatialSeries object representing a floating point value for theta. The SpatialSeries::reference_frame field should indicate what direction corresponds to 0 and which is the direction of rotation (this should be clockwise). The si_unit for the SpatialSeries should be radians or degrees.

Required Properties*:: spatialseries

Constructor Summary

CompassDirection(varargin)

COMPASSDIRECTION - Constructor for CompassDirection

Syntax:

compassDirection = types.core.COMPASSDIRECTION() creates a CompassDirection object with unset property values.

compassDirection = types.core.COMPASSDIRECTION(Name, Value) creates a CompassDirection object where one or more property values are specified using name-value pairs.

Input Arguments (Name-Value Arguments):

spatialseries (SpatialSeries) - SpatialSeries object containing direction of gaze travel.

Output Arguments:

compassDirection (types.core.CompassDirection) - A CompassDirection object

Property Summary

spatialseries: REQUIRED (SpatialSeries) SpatialSeries object containing direction of gaze travel.

Tip

* If a required property link is not functional, the property may be defined in a superclass. Please refer to the superclass documentation.