Bases: tvb.basic.neotraits._core.HasTraits
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.datatypes.connectivity.Connectivity, tvb.contrib.scripts.datatypes.base.BaseModel
parent_connectivity : tvb.datatypes.connectivity.Connectivity.parent_connectivity = Attr(field_type=<class ‘str’>, default=None, required=False)
saved_selection : tvb.datatypes.connectivity.Connectivity.saved_selection = List(of=<class ‘int’>, default=(), required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.basic.neotraits._core.HasTraits
One patient virtualization. Fully configured for defining hypothesis on it.
title : tvb.contrib.scripts.datatypes.head.Head.title = Attr(field_type=<class ‘str’>, default=’Head’, required=False)
path : tvb.contrib.scripts.datatypes.head.Head.path = Attr(field_type=<class ‘str’>, default=’path’, required=False)
connectivity : tvb.contrib.scripts.datatypes.head.Head.connectivity = Attr(field_type=<class ‘tvb.datatypes.connectivity.Connectivity’>, default=None, required=True)
cortical_surface : tvb.contrib.scripts.datatypes.head.Head.cortical_surface = Attr(field_type=<class ‘tvb.datatypes.surfaces.Surface’>, default=None, required=False)
subcortical_surface : tvb.contrib.scripts.datatypes.head.Head.subcortical_surface = Attr(field_type=<class ‘tvb.datatypes.surfaces.Surface’>, default=None, required=False)
cortical_region_mapping : tvb.contrib.scripts.datatypes.head.Head.cortical_region_mapping = Attr(field_type=<class ‘tvb.datatypes.region_mapping.RegionMapping’>, default=None, required=False)
subcortical_region_mapping : tvb.contrib.scripts.datatypes.head.Head.subcortical_region_mapping = Attr(field_type=<class ‘tvb.datatypes.region_mapping.RegionMapping’>, default=None, required=False)
region_volume_mapping : tvb.contrib.scripts.datatypes.head.Head.region_volume_mapping = Attr(field_type=<class ‘tvb.datatypes.region_mapping.RegionVolumeMapping’>, default=None, required=False)
local_connectivity : tvb.contrib.scripts.datatypes.head.Head.local_connectivity = Attr(field_type=<class ‘tvb.datatypes.local_connectivity.LocalConnectivity’>, default=None, required=False)
t1 : tvb.contrib.scripts.datatypes.head.Head.t1 = Attr(field_type=<class ‘tvb.datatypes.structural.StructuralMRI’>, default=None, required=False)
t2 : tvb.contrib.scripts.datatypes.head.Head.t2 = Attr(field_type=<class ‘tvb.datatypes.structural.StructuralMRI’>, default=None, required=False)
flair : tvb.contrib.scripts.datatypes.head.Head.flair = Attr(field_type=<class ‘tvb.datatypes.structural.StructuralMRI’>, default=None, required=False)
b0 : tvb.contrib.scripts.datatypes.head.Head.b0 = Attr(field_type=<class ‘tvb.datatypes.structural.StructuralMRI’>, default=None, required=False)
eeg_sensors : tvb.contrib.scripts.datatypes.head.Head.eeg_sensors = Attr(field_type=<class ‘tvb.datatypes.sensors.Sensors’>, default=None, required=False)
seeg_sensors : tvb.contrib.scripts.datatypes.head.Head.seeg_sensors = Attr(field_type=<class ‘tvb.datatypes.sensors.Sensors’>, default=None, required=False)
meg_sensors : tvb.contrib.scripts.datatypes.head.Head.meg_sensors = Attr(field_type=<class ‘tvb.datatypes.sensors.Sensors’>, default=None, required=False)
eeg_projection : tvb.contrib.scripts.datatypes.head.Head.eeg_projection = Attr(field_type=<class ‘tvb.datatypes.projections.ProjectionMatrix’>, default=None, required=False)
seeg_projection : tvb.contrib.scripts.datatypes.head.Head.seeg_projection = Attr(field_type=<class ‘tvb.datatypes.projections.ProjectionMatrix’>, default=None, required=False)
meg_projection : tvb.contrib.scripts.datatypes.head.Head.meg_projection = Attr(field_type=<class ‘tvb.datatypes.projections.ProjectionMatrix’>, default=None, required=False)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.datatypes.local_connectivity.LocalConnectivity, tvb.contrib.scripts.datatypes.base.BaseModel
surface : tvb.datatypes.local_connectivity.LocalConnectivity.surface = Attr(field_type=<class ‘tvb.datatypes.surfaces.CorticalSurface’>, default=None, required=True)
matrix : tvb.datatypes.local_connectivity.LocalConnectivity.matrix = Attr(field_type=<class ‘scipy.sparse.base.spmatrix’>, default=None, required=False)
equation : tvb.datatypes.local_connectivity.LocalConnectivity.equation = Attr(field_type=<class ‘tvb.datatypes.equations.FiniteSupportEquation’>, default=<tvb.datatypes.equations.Gaussian object at 0x7f01487dc690>, required=False)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
The LookUpTable datatype.
Bases: tvb.basic.neotraits._core.HasTraits
Lookup Tables for storing pre-computed functions. Specific table subclasses are implemented below.
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Invoke the compute methods for computable attributes that haven’t been set during initialization.
Declares a numpy array. dtype enforces the dtype. The default dtype is float32. An optional symbolic shape can be given, as a tuple of Dim attributes from the owning class. The shape will be enforced, but no broadcasting will be done. domain declares what values are allowed in this array. It can be any object that can be checked for membership Defaults are checked if they are in the declared domain. For performance reasons this does not happen on every attribute set.
Declares a numpy array. dtype enforces the dtype. The default dtype is float32. An optional symbolic shape can be given, as a tuple of Dim attributes from the owning class. The shape will be enforced, but no broadcasting will be done. domain declares what values are allowed in this array. It can be any object that can be checked for membership Defaults are checked if they are in the declared domain. For performance reasons this does not happen on every attribute set.
Declares a float. This is different from Attr(field_type=float). The former enforces float subtypes. This allows any type that can be safely cast to the declared float type according to numpy rules.
Reading and writing this attribute is slower than a plain python attribute. In performance sensitive code you might want to use plain python attributes or even better local variables.
Declares a float. This is different from Attr(field_type=float). The former enforces float subtypes. This allows any type that can be safely cast to the declared float type according to numpy rules.
Reading and writing this attribute is slower than a plain python attribute. In performance sensitive code you might want to use plain python attributes or even better local variables.
Declares an integer This is different from Attr(field_type=int). The former enforces int subtypes This allows all integer types, including numpy ones that can be safely cast to the declared type according to numpy rules
Gather scientifically interesting summary information from an instance of this dataType, if any ...
Declares a float. This is different from Attr(field_type=float). The former enforces float subtypes. This allows any type that can be safely cast to the declared float type according to numpy rules.
Reading and writing this attribute is slower than a plain python attribute. In performance sensitive code you might want to use plain python attributes or even better local variables.
Declares a float. This is different from Attr(field_type=float). The former enforces float subtypes. This allows any type that can be safely cast to the declared float type according to numpy rules.
Reading and writing this attribute is slower than a plain python attribute. In performance sensitive code you might want to use plain python attributes or even better local variables.
Bases: tvb.contrib.scripts.datatypes.lookup_tables.LookUpTable
Look up table containing the values of Nerf integral within the \(\phi\) function that describes how the discharge rate vary as a function of parameters defining the statistical properties of the membrane potential in presence of synaptic inputs.
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.contrib.scripts.datatypes.lookup_tables.LookUpTable
Look up table containing the values of a function representing the time-averaged gating variable \(\psi(\nu)\) as a function of the presynaptic rates \(\nu\)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.datatypes.projections.ProjectionMatrix, tvb.contrib.scripts.datatypes.base.BaseModel
projection_type : tvb.datatypes.projections.ProjectionMatrix.projection_type = Attr(field_type=<class ‘str’>, default=None, required=True)
sources : tvb.datatypes.projections.ProjectionMatrix.sources = Attr(field_type=<class ‘tvb.datatypes.surfaces.CorticalSurface’>, default=None, required=True)
projection_data : tvb.datatypes.projections.ProjectionMatrix.projection_data = NArray(label=’Projection Matrix Data’, dtype=float64, default=None, dim_names=(), ndim=None, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.contrib.scripts.datatypes.projections.ProjectionMatrix, tvb.datatypes.projections.ProjectionSurfaceEEG
projection_type : tvb.datatypes.projections.ProjectionSurfaceEEG.projection_type = Attr(field_type=<class ‘str’>, default=’projEEG’, required=True)
sensors : tvb.datatypes.projections.ProjectionSurfaceEEG.sensors = Attr(field_type=<class ‘tvb.datatypes.sensors.SensorsEEG’>, default=None, required=True)
sources : tvb.datatypes.projections.ProjectionMatrix.sources = Attr(field_type=<class ‘tvb.datatypes.surfaces.CorticalSurface’>, default=None, required=True)
projection_data : tvb.datatypes.projections.ProjectionMatrix.projection_data = NArray(label=’Projection Matrix Data’, dtype=float64, default=None, dim_names=(), ndim=None, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.contrib.scripts.datatypes.projections.ProjectionMatrix, tvb.datatypes.projections.ProjectionSurfaceMEG
projection_type : tvb.datatypes.projections.ProjectionSurfaceMEG.projection_type = Attr(field_type=<class ‘str’>, default=’projMEG’, required=True)
sensors : tvb.datatypes.projections.ProjectionSurfaceMEG.sensors = Attr(field_type=<class ‘tvb.datatypes.sensors.SensorsMEG’>, default=None, required=True)
sources : tvb.datatypes.projections.ProjectionMatrix.sources = Attr(field_type=<class ‘tvb.datatypes.surfaces.CorticalSurface’>, default=None, required=True)
projection_data : tvb.datatypes.projections.ProjectionMatrix.projection_data = NArray(label=’Projection Matrix Data’, dtype=float64, default=None, dim_names=(), ndim=None, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.contrib.scripts.datatypes.projections.ProjectionMatrix, tvb.datatypes.projections.ProjectionSurfaceSEEG
projection_type : tvb.datatypes.projections.ProjectionSurfaceSEEG.projection_type = Attr(field_type=<class ‘str’>, default=’projSEEG’, required=True)
sensors : tvb.datatypes.projections.ProjectionSurfaceSEEG.sensors = Attr(field_type=<class ‘tvb.datatypes.sensors.SensorsInternal’>, default=None, required=True)
sources : tvb.datatypes.projections.ProjectionMatrix.sources = Attr(field_type=<class ‘tvb.datatypes.surfaces.CorticalSurface’>, default=None, required=True)
projection_data : tvb.datatypes.projections.ProjectionMatrix.projection_data = NArray(label=’Projection Matrix Data’, dtype=float64, default=None, dim_names=(), ndim=None, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: enum.Enum
An enumeration.
Bases: tvb.contrib.scripts.datatypes.region_mapping.RegionMapping
array_data : tvb.datatypes.region_mapping.RegionMapping.array_data = NArray(label=’‘, dtype=int64, default=None, dim_names=(), ndim=None, required=True)
connectivity : tvb.datatypes.region_mapping.RegionMapping.connectivity = Attr(field_type=<class ‘tvb.datatypes.connectivity.Connectivity’>, default=None, required=True)
surface : tvb.datatypes.region_mapping.RegionMapping.surface = Attr(field_type=<class ‘tvb.datatypes.surfaces.Surface’>, default=None, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.datatypes.region_mapping.RegionMapping, tvb.contrib.scripts.datatypes.base.BaseModel
array_data : tvb.datatypes.region_mapping.RegionMapping.array_data = NArray(label=’‘, dtype=int64, default=None, dim_names=(), ndim=None, required=True)
connectivity : tvb.datatypes.region_mapping.RegionMapping.connectivity = Attr(field_type=<class ‘tvb.datatypes.connectivity.Connectivity’>, default=None, required=True)
surface : tvb.datatypes.region_mapping.RegionMapping.surface = Attr(field_type=<class ‘tvb.datatypes.surfaces.Surface’>, default=None, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.datatypes.region_mapping.RegionVolumeMapping, tvb.contrib.scripts.datatypes.base.BaseModel
array_data : tvb.datatypes.region_mapping.RegionVolumeMapping.array_data = NArray(label=’‘, dtype=int64, default=None, dim_names=(), ndim=None, required=True)
connectivity : tvb.datatypes.region_mapping.RegionVolumeMapping.connectivity = Attr(field_type=<class ‘tvb.datatypes.connectivity.Connectivity’>, default=None, required=True)
volume : tvb.datatypes.region_mapping.RegionVolumeMapping.volume = Attr(field_type=<class ‘tvb.datatypes.volumes.Volume’>, default=None, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.contrib.scripts.datatypes.region_mapping.RegionMapping
array_data : tvb.datatypes.region_mapping.RegionMapping.array_data = NArray(label=’‘, dtype=int64, default=None, dim_names=(), ndim=None, required=True)
connectivity : tvb.datatypes.region_mapping.RegionMapping.connectivity = Attr(field_type=<class ‘tvb.datatypes.connectivity.Connectivity’>, default=None, required=True)
surface : tvb.datatypes.region_mapping.RegionMapping.surface = Attr(field_type=<class ‘tvb.datatypes.surfaces.Surface’>, default=None, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.datatypes.sensors.Sensors, tvb.contrib.scripts.datatypes.base.BaseModel
sensors_type : tvb.datatypes.sensors.Sensors.sensors_type = Attr(field_type=<class ‘str’>, default=None, required=False)
labels : tvb.datatypes.sensors.Sensors.labels = NArray(label=’Sensor labels’, dtype=<U128, default=None, dim_names=(), ndim=None, required=True)
locations : tvb.datatypes.sensors.Sensors.locations = NArray(label=’Sensor locations’, dtype=float64, default=None, dim_names=(), ndim=None, required=True)
has_orientation : tvb.datatypes.sensors.Sensors.has_orientation = Attr(field_type=<class ‘bool’>, default=False, required=True)
orientations : tvb.datatypes.sensors.Sensors.orientations = NArray(label=’‘, dtype=float64, default=None, dim_names=(), ndim=None, required=False)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.contrib.scripts.datatypes.sensors.Sensors, tvb.datatypes.sensors.SensorsEEG
sensors_type : tvb.datatypes.sensors.SensorsEEG.sensors_type = Attr(field_type=<class ‘str’>, default=’EEG’, required=True)
has_orientation : tvb.datatypes.sensors.SensorsEEG.has_orientation = Attr(field_type=<class ‘bool’>, default=False, required=True)
labels : tvb.datatypes.sensors.Sensors.labels = NArray(label=’Sensor labels’, dtype=<U128, default=None, dim_names=(), ndim=None, required=True)
locations : tvb.datatypes.sensors.Sensors.locations = NArray(label=’Sensor locations’, dtype=float64, default=None, dim_names=(), ndim=None, required=True)
orientations : tvb.datatypes.sensors.Sensors.orientations = NArray(label=’‘, dtype=float64, default=None, dim_names=(), ndim=None, required=False)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.contrib.scripts.datatypes.sensors.Sensors, tvb.datatypes.sensors.SensorsInternal
sensors_type : tvb.datatypes.sensors.SensorsInternal.sensors_type = Attr(field_type=<class ‘str’>, default=’Internal’, required=True)
labels : tvb.datatypes.sensors.Sensors.labels = NArray(label=’Sensor labels’, dtype=<U128, default=None, dim_names=(), ndim=None, required=True)
locations : tvb.datatypes.sensors.Sensors.locations = NArray(label=’Sensor locations’, dtype=float64, default=None, dim_names=(), ndim=None, required=True)
has_orientation : tvb.datatypes.sensors.Sensors.has_orientation = Attr(field_type=<class ‘bool’>, default=False, required=True)
orientations : tvb.datatypes.sensors.Sensors.orientations = NArray(label=’‘, dtype=float64, default=None, dim_names=(), ndim=None, required=False)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Declares a numpy array. dtype enforces the dtype. The default dtype is float32. An optional symbolic shape can be given, as a tuple of Dim attributes from the owning class. The shape will be enforced, but no broadcasting will be done. domain declares what values are allowed in this array. It can be any object that can be checked for membership Defaults are checked if they are in the declared domain. For performance reasons this does not happen on every attribute set.
Declares a numpy array. dtype enforces the dtype. The default dtype is float32. An optional symbolic shape can be given, as a tuple of Dim attributes from the owning class. The shape will be enforced, but no broadcasting will be done. domain declares what values are allowed in this array. It can be any object that can be checked for membership Defaults are checked if they are in the declared domain. For performance reasons this does not happen on every attribute set.
Bases: tvb.contrib.scripts.datatypes.sensors.Sensors, tvb.datatypes.sensors.SensorsMEG
sensors_type : tvb.datatypes.sensors.SensorsMEG.sensors_type = Attr(field_type=<class ‘str’>, default=’MEG’, required=True)
has_orientation : tvb.datatypes.sensors.SensorsMEG.has_orientation = Attr(field_type=<class ‘bool’>, default=True, required=True)
labels : tvb.datatypes.sensors.Sensors.labels = NArray(label=’Sensor labels’, dtype=<U128, default=None, dim_names=(), ndim=None, required=True)
locations : tvb.datatypes.sensors.Sensors.locations = NArray(label=’Sensor locations’, dtype=float64, default=None, dim_names=(), ndim=None, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.contrib.scripts.datatypes.sensors.SensorsInternal
sensors_type : tvb.contrib.scripts.datatypes.sensors.SensorsSEEG.sensors_type = Attr(field_type=<class ‘str’>, default=’Internal’, required=False)
labels : tvb.datatypes.sensors.Sensors.labels = NArray(label=’Sensor labels’, dtype=<U128, default=None, dim_names=(), ndim=None, required=True)
locations : tvb.datatypes.sensors.Sensors.locations = NArray(label=’Sensor locations’, dtype=float64, default=None, dim_names=(), ndim=None, required=True)
has_orientation : tvb.datatypes.sensors.Sensors.has_orientation = Attr(field_type=<class ‘bool’>, default=False, required=True)
orientations : tvb.datatypes.sensors.Sensors.orientations = NArray(label=’‘, dtype=float64, default=None, dim_names=(), ndim=None, required=False)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.contrib.scripts.datatypes.structural.StructuralMRI
weighting : tvb.contrib.scripts.datatypes.structural.B0.weighting = Attr(field_type=<class ‘str’>, default=’B0’, required=True)
array_data : tvb.datatypes.structural.StructuralMRI.array_data = NArray(label=’contrast’, dtype=float64, default=None, dim_names=(), ndim=None, required=True)
volume : tvb.datatypes.structural.StructuralMRI.volume = Attr(field_type=<class ‘tvb.datatypes.volumes.Volume’>, default=None, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.contrib.scripts.datatypes.structural.StructuralMRI
weighting : tvb.contrib.scripts.datatypes.structural.Flair.weighting = Attr(field_type=<class ‘str’>, default=’Flair’, required=True)
array_data : tvb.datatypes.structural.StructuralMRI.array_data = NArray(label=’contrast’, dtype=float64, default=None, dim_names=(), ndim=None, required=True)
volume : tvb.datatypes.structural.StructuralMRI.volume = Attr(field_type=<class ‘tvb.datatypes.volumes.Volume’>, default=None, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.datatypes.structural.StructuralMRI, tvb.contrib.scripts.datatypes.base.BaseModel
array_data : tvb.datatypes.structural.StructuralMRI.array_data = NArray(label=’contrast’, dtype=float64, default=None, dim_names=(), ndim=None, required=True)
weighting : tvb.datatypes.structural.StructuralMRI.weighting = Attr(field_type=<class ‘str’>, default=None, required=True)
volume : tvb.datatypes.structural.StructuralMRI.volume = Attr(field_type=<class ‘tvb.datatypes.volumes.Volume’>, default=None, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.contrib.scripts.datatypes.structural.StructuralMRI
weighting : tvb.contrib.scripts.datatypes.structural.T1.weighting = Attr(field_type=<class ‘str’>, default=’T1’, required=True)
array_data : tvb.datatypes.structural.StructuralMRI.array_data = NArray(label=’contrast’, dtype=float64, default=None, dim_names=(), ndim=None, required=True)
volume : tvb.datatypes.structural.StructuralMRI.volume = Attr(field_type=<class ‘tvb.datatypes.volumes.Volume’>, default=None, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.contrib.scripts.datatypes.structural.StructuralMRI
weighting : tvb.contrib.scripts.datatypes.structural.T2.weighting = Attr(field_type=<class ‘str’>, default=’T2’, required=True)
array_data : tvb.datatypes.structural.StructuralMRI.array_data = NArray(label=’contrast’, dtype=float64, default=None, dim_names=(), ndim=None, required=True)
volume : tvb.datatypes.structural.StructuralMRI.volume = Attr(field_type=<class ‘tvb.datatypes.volumes.Volume’>, default=None, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.contrib.scripts.datatypes.surface.Surface, tvb.datatypes.surfaces.BrainSkull
surface_type : tvb.datatypes.surfaces.BrainSkull.surface_type = Final(field_type=<class ‘str’>, default=’Brain Skull’, required=True)
edge_mean_length : tvb.datatypes.surfaces.Surface.edge_mean_length = Float(field_type=<class ‘float’>, default=0, required=True)
edge_min_length : tvb.datatypes.surfaces.Surface.edge_min_length = Float(field_type=<class ‘float’>, default=0, required=True)
edge_max_length : tvb.datatypes.surfaces.Surface.edge_max_length = Float(field_type=<class ‘float’>, default=0, required=True)
hemisphere_mask : tvb.datatypes.surfaces.Surface.hemisphere_mask = NArray(label=’An array specifying if a vertex belongs to the right hemisphere’, dtype=bool, default=None, dim_names=(), ndim=None, required=False)
zero_based_triangles : tvb.datatypes.surfaces.Surface.zero_based_triangles = Attr(field_type=<class ‘bool’>, default=None, required=True)
bi_hemispheric : tvb.datatypes.surfaces.Surface.bi_hemispheric = Attr(field_type=<class ‘bool’>, default=False, required=True)
valid_for_simulations : tvb.datatypes.surfaces.Surface.valid_for_simulations = Attr(field_type=<class ‘bool’>, default=True, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.contrib.scripts.datatypes.surface.Surface, tvb.datatypes.surfaces.CorticalSurface
surface_type : tvb.datatypes.surfaces.CorticalSurface.surface_type = Attr(field_type=<class ‘str’>, default=’Cortical Surface’, required=True)
edge_mean_length : tvb.datatypes.surfaces.Surface.edge_mean_length = Float(field_type=<class ‘float’>, default=0, required=True)
edge_min_length : tvb.datatypes.surfaces.Surface.edge_min_length = Float(field_type=<class ‘float’>, default=0, required=True)
edge_max_length : tvb.datatypes.surfaces.Surface.edge_max_length = Float(field_type=<class ‘float’>, default=0, required=True)
hemisphere_mask : tvb.datatypes.surfaces.Surface.hemisphere_mask = NArray(label=’An array specifying if a vertex belongs to the right hemisphere’, dtype=bool, default=None, dim_names=(), ndim=None, required=False)
zero_based_triangles : tvb.datatypes.surfaces.Surface.zero_based_triangles = Attr(field_type=<class ‘bool’>, default=None, required=True)
bi_hemispheric : tvb.datatypes.surfaces.Surface.bi_hemispheric = Attr(field_type=<class ‘bool’>, default=False, required=True)
valid_for_simulations : tvb.datatypes.surfaces.Surface.valid_for_simulations = Attr(field_type=<class ‘bool’>, default=True, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.contrib.scripts.datatypes.surface.Surface, tvb.datatypes.surfaces.EEGCap
surface_type : tvb.datatypes.surfaces.EEGCap.surface_type = Final(field_type=<class ‘str’>, default=’EEG Cap’, required=True)
edge_mean_length : tvb.datatypes.surfaces.Surface.edge_mean_length = Float(field_type=<class ‘float’>, default=0, required=True)
edge_min_length : tvb.datatypes.surfaces.Surface.edge_min_length = Float(field_type=<class ‘float’>, default=0, required=True)
edge_max_length : tvb.datatypes.surfaces.Surface.edge_max_length = Float(field_type=<class ‘float’>, default=0, required=True)
hemisphere_mask : tvb.datatypes.surfaces.Surface.hemisphere_mask = NArray(label=’An array specifying if a vertex belongs to the right hemisphere’, dtype=bool, default=None, dim_names=(), ndim=None, required=False)
zero_based_triangles : tvb.datatypes.surfaces.Surface.zero_based_triangles = Attr(field_type=<class ‘bool’>, default=None, required=True)
bi_hemispheric : tvb.datatypes.surfaces.Surface.bi_hemispheric = Attr(field_type=<class ‘bool’>, default=False, required=True)
valid_for_simulations : tvb.datatypes.surfaces.Surface.valid_for_simulations = Attr(field_type=<class ‘bool’>, default=True, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.contrib.scripts.datatypes.surface.Surface, tvb.datatypes.surfaces.FaceSurface
surface_type : tvb.datatypes.surfaces.FaceSurface.surface_type = Final(field_type=<class ‘str’>, default=’Face’, required=True)
edge_mean_length : tvb.datatypes.surfaces.Surface.edge_mean_length = Float(field_type=<class ‘float’>, default=0, required=True)
edge_min_length : tvb.datatypes.surfaces.Surface.edge_min_length = Float(field_type=<class ‘float’>, default=0, required=True)
edge_max_length : tvb.datatypes.surfaces.Surface.edge_max_length = Float(field_type=<class ‘float’>, default=0, required=True)
hemisphere_mask : tvb.datatypes.surfaces.Surface.hemisphere_mask = NArray(label=’An array specifying if a vertex belongs to the right hemisphere’, dtype=bool, default=None, dim_names=(), ndim=None, required=False)
zero_based_triangles : tvb.datatypes.surfaces.Surface.zero_based_triangles = Attr(field_type=<class ‘bool’>, default=None, required=True)
bi_hemispheric : tvb.datatypes.surfaces.Surface.bi_hemispheric = Attr(field_type=<class ‘bool’>, default=False, required=True)
valid_for_simulations : tvb.datatypes.surfaces.Surface.valid_for_simulations = Attr(field_type=<class ‘bool’>, default=True, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.contrib.scripts.datatypes.surface.Surface, tvb.datatypes.surfaces.SkinAir
surface_type : tvb.datatypes.surfaces.SkinAir.surface_type = Final(field_type=<class ‘str’>, default=’Skin Air’, required=True)
edge_mean_length : tvb.datatypes.surfaces.Surface.edge_mean_length = Float(field_type=<class ‘float’>, default=0, required=True)
edge_min_length : tvb.datatypes.surfaces.Surface.edge_min_length = Float(field_type=<class ‘float’>, default=0, required=True)
edge_max_length : tvb.datatypes.surfaces.Surface.edge_max_length = Float(field_type=<class ‘float’>, default=0, required=True)
hemisphere_mask : tvb.datatypes.surfaces.Surface.hemisphere_mask = NArray(label=’An array specifying if a vertex belongs to the right hemisphere’, dtype=bool, default=None, dim_names=(), ndim=None, required=False)
zero_based_triangles : tvb.datatypes.surfaces.Surface.zero_based_triangles = Attr(field_type=<class ‘bool’>, default=None, required=True)
bi_hemispheric : tvb.datatypes.surfaces.Surface.bi_hemispheric = Attr(field_type=<class ‘bool’>, default=False, required=True)
valid_for_simulations : tvb.datatypes.surfaces.Surface.valid_for_simulations = Attr(field_type=<class ‘bool’>, default=True, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.contrib.scripts.datatypes.surface.Surface, tvb.datatypes.surfaces.SkullSkin
surface_type : tvb.datatypes.surfaces.SkullSkin.surface_type = Final(field_type=<class ‘str’>, default=’Skull Skin’, required=True)
edge_mean_length : tvb.datatypes.surfaces.Surface.edge_mean_length = Float(field_type=<class ‘float’>, default=0, required=True)
edge_min_length : tvb.datatypes.surfaces.Surface.edge_min_length = Float(field_type=<class ‘float’>, default=0, required=True)
edge_max_length : tvb.datatypes.surfaces.Surface.edge_max_length = Float(field_type=<class ‘float’>, default=0, required=True)
hemisphere_mask : tvb.datatypes.surfaces.Surface.hemisphere_mask = NArray(label=’An array specifying if a vertex belongs to the right hemisphere’, dtype=bool, default=None, dim_names=(), ndim=None, required=False)
zero_based_triangles : tvb.datatypes.surfaces.Surface.zero_based_triangles = Attr(field_type=<class ‘bool’>, default=None, required=True)
bi_hemispheric : tvb.datatypes.surfaces.Surface.bi_hemispheric = Attr(field_type=<class ‘bool’>, default=False, required=True)
valid_for_simulations : tvb.datatypes.surfaces.Surface.valid_for_simulations = Attr(field_type=<class ‘bool’>, default=True, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.contrib.scripts.datatypes.surface.Surface, tvb.datatypes.surfaces.CorticalSurface
surface_type : tvb.contrib.scripts.datatypes.surface.SubcorticalSurface.surface_type = Attr(field_type=<class ‘str’>, default=’Subcortical Surface’, required=True)
edge_mean_length : tvb.datatypes.surfaces.Surface.edge_mean_length = Float(field_type=<class ‘float’>, default=0, required=True)
edge_min_length : tvb.datatypes.surfaces.Surface.edge_min_length = Float(field_type=<class ‘float’>, default=0, required=True)
edge_max_length : tvb.datatypes.surfaces.Surface.edge_max_length = Float(field_type=<class ‘float’>, default=0, required=True)
hemisphere_mask : tvb.datatypes.surfaces.Surface.hemisphere_mask = NArray(label=’An array specifying if a vertex belongs to the right hemisphere’, dtype=bool, default=None, dim_names=(), ndim=None, required=False)
zero_based_triangles : tvb.datatypes.surfaces.Surface.zero_based_triangles = Attr(field_type=<class ‘bool’>, default=None, required=True)
bi_hemispheric : tvb.datatypes.surfaces.Surface.bi_hemispheric = Attr(field_type=<class ‘bool’>, default=False, required=True)
valid_for_simulations : tvb.datatypes.surfaces.Surface.valid_for_simulations = Attr(field_type=<class ‘bool’>, default=True, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.datatypes.surfaces.Surface, tvb.contrib.scripts.datatypes.base.BaseModel
edge_mean_length : tvb.datatypes.surfaces.Surface.edge_mean_length = Float(field_type=<class ‘float’>, default=0, required=True)
edge_min_length : tvb.datatypes.surfaces.Surface.edge_min_length = Float(field_type=<class ‘float’>, default=0, required=True)
edge_max_length : tvb.datatypes.surfaces.Surface.edge_max_length = Float(field_type=<class ‘float’>, default=0, required=True)
hemisphere_mask : tvb.datatypes.surfaces.Surface.hemisphere_mask = NArray(label=’An array specifying if a vertex belongs to the right hemisphere’, dtype=bool, default=None, dim_names=(), ndim=None, required=False)
zero_based_triangles : tvb.datatypes.surfaces.Surface.zero_based_triangles = Attr(field_type=<class ‘bool’>, default=None, required=True)
bi_hemispheric : tvb.datatypes.surfaces.Surface.bi_hemispheric = Attr(field_type=<class ‘bool’>, default=False, required=True)
surface_type : tvb.datatypes.surfaces.Surface.surface_type = Attr(field_type=<class ‘str’>, default=None, required=True)
valid_for_simulations : tvb.datatypes.surfaces.Surface.valid_for_simulations = Attr(field_type=<class ‘bool’>, default=True, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
This function computes the surface area :param: surface: input surface object :return: (sub)surface area, float
Declares a numpy array. dtype enforces the dtype. The default dtype is float32. An optional symbolic shape can be given, as a tuple of Dim attributes from the owning class. The shape will be enforced, but no broadcasting will be done. domain declares what values are allowed in this array. It can be any object that can be checked for membership Defaults are checked if they are in the declared domain. For performance reasons this does not happen on every attribute set.
Bases: tvb.contrib.scripts.datatypes.surface.Surface, tvb.datatypes.surfaces.WhiteMatterSurface
surface_type : tvb.datatypes.surfaces.WhiteMatterSurface.surface_type = Final(field_type=<class ‘str’>, default=’White Matter’, required=True)
edge_mean_length : tvb.datatypes.surfaces.Surface.edge_mean_length = Float(field_type=<class ‘float’>, default=0, required=True)
edge_min_length : tvb.datatypes.surfaces.Surface.edge_min_length = Float(field_type=<class ‘float’>, default=0, required=True)
edge_max_length : tvb.datatypes.surfaces.Surface.edge_max_length = Float(field_type=<class ‘float’>, default=0, required=True)
hemisphere_mask : tvb.datatypes.surfaces.Surface.hemisphere_mask = NArray(label=’An array specifying if a vertex belongs to the right hemisphere’, dtype=bool, default=None, dim_names=(), ndim=None, required=False)
zero_based_triangles : tvb.datatypes.surfaces.Surface.zero_based_triangles = Attr(field_type=<class ‘bool’>, default=None, required=True)
bi_hemispheric : tvb.datatypes.surfaces.Surface.bi_hemispheric = Attr(field_type=<class ‘bool’>, default=False, required=True)
valid_for_simulations : tvb.datatypes.surfaces.Surface.valid_for_simulations = Attr(field_type=<class ‘bool’>, default=True, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: enum.Enum
An enumeration.
Bases: tvb.datatypes.time_series.TimeSeries, tvb.contrib.scripts.datatypes.base.BaseModel
title : tvb.datatypes.time_series.TimeSeries.title = Attr(field_type=<class ‘str’>, default=None, required=True)
start_time : tvb.datatypes.time_series.TimeSeries.start_time = Float(field_type=<class ‘float’>, default=0, required=True)
sample_period : tvb.datatypes.time_series.TimeSeries.sample_period = Float(field_type=<class ‘float’>, default=1.0, required=True)
sample_period_unit : tvb.datatypes.time_series.TimeSeries.sample_period_unit = Attr(field_type=<class ‘str’>, default=’ms’, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: tvb.contrib.scripts.datatypes.time_series.TimeSeries
title : tvb.datatypes.time_series.TimeSeries.title = Attr(field_type=<class ‘str’>, default=None, required=True)
start_time : tvb.datatypes.time_series.TimeSeries.start_time = Float(field_type=<class ‘float’>, default=0, required=True)
sample_period : tvb.datatypes.time_series.TimeSeries.sample_period = Float(field_type=<class ‘float’>, default=1.0, required=True)
sample_period_unit : tvb.datatypes.time_series.TimeSeries.sample_period_unit = Attr(field_type=<class ‘str’>, default=’ms’, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Bases: enum.Enum
An enumeration.
Bases: tvb.contrib.scripts.datatypes.time_series.TimeSeriesSensors, tvb.datatypes.time_series.TimeSeriesEEG
title : tvb.contrib.scripts.datatypes.time_series.TimeSeriesEEG.title = Attr(field_type=<class ‘str’>, default=’EEG Time Series’, required=True)
labels_ordering : tvb.contrib.scripts.datatypes.time_series.TimeSeriesSensors.labels_ordering = List(of=<class ‘str’>, default=(‘Time’, ‘State Variable’, ‘Sensor’, ‘Sample’), required=True)
sensors : tvb.datatypes.time_series.TimeSeriesEEG.sensors = Attr(field_type=<class ‘tvb.datatypes.sensors.SensorsEEG’>, default=None, required=True)
start_time : tvb.datatypes.time_series.TimeSeries.start_time = Float(field_type=<class ‘float’>, default=0, required=True)
sample_period : tvb.datatypes.time_series.TimeSeries.sample_period = Float(field_type=<class ‘float’>, default=1.0, required=True)
sample_period_unit : tvb.datatypes.time_series.TimeSeries.sample_period_unit = Attr(field_type=<class ‘str’>, default=’ms’, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.contrib.scripts.datatypes.time_series.TimeSeriesSensors, tvb.datatypes.time_series.TimeSeriesMEG
title : tvb.contrib.scripts.datatypes.time_series.TimeSeriesMEG.title = Attr(field_type=<class ‘str’>, default=’MEG Time Series’, required=True)
labels_ordering : tvb.contrib.scripts.datatypes.time_series.TimeSeriesSensors.labels_ordering = List(of=<class ‘str’>, default=(‘Time’, ‘State Variable’, ‘Sensor’, ‘Sample’), required=True)
sensors : tvb.datatypes.time_series.TimeSeriesMEG.sensors = Attr(field_type=<class ‘tvb.datatypes.sensors.SensorsMEG’>, default=None, required=True)
start_time : tvb.datatypes.time_series.TimeSeries.start_time = Float(field_type=<class ‘float’>, default=0, required=True)
sample_period : tvb.datatypes.time_series.TimeSeries.sample_period = Float(field_type=<class ‘float’>, default=1.0, required=True)
sample_period_unit : tvb.datatypes.time_series.TimeSeries.sample_period_unit = Attr(field_type=<class ‘str’>, default=’ms’, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.contrib.scripts.datatypes.time_series.TimeSeriesBrain, tvb.datatypes.time_series.TimeSeriesRegion
labels_ordering : tvb.contrib.scripts.datatypes.time_series.TimeSeriesRegion.labels_ordering = List(of=<class ‘str’>, default=(‘Time’, ‘State Variable’, ‘Region’, ‘Sample’), required=True)
title : tvb.contrib.scripts.datatypes.time_series.TimeSeriesRegion.title = Attr(field_type=<class ‘str’>, default=’Region Time Series’, required=True)
connectivity : tvb.datatypes.time_series.TimeSeriesRegion.connectivity = Attr(field_type=<class ‘tvb.datatypes.connectivity.Connectivity’>, default=None, required=True)
region_mapping_volume : tvb.datatypes.time_series.TimeSeriesRegion.region_mapping_volume = Attr(field_type=<class ‘tvb.datatypes.region_mapping.RegionVolumeMapping’>, default=None, required=False)
region_mapping : tvb.datatypes.time_series.TimeSeriesRegion.region_mapping = Attr(field_type=<class ‘tvb.datatypes.region_mapping.RegionMapping’>, default=None, required=False)
start_time : tvb.datatypes.time_series.TimeSeries.start_time = Float(field_type=<class ‘float’>, default=0, required=True)
sample_period : tvb.datatypes.time_series.TimeSeries.sample_period = Float(field_type=<class ‘float’>, default=1.0, required=True)
sample_period_unit : tvb.datatypes.time_series.TimeSeries.sample_period_unit = Attr(field_type=<class ‘str’>, default=’ms’, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
The attribute is a list of values. Choices and type are reinterpreted as applying not to the list but to the elements of it
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.contrib.scripts.datatypes.time_series.TimeSeriesSensors, tvb.datatypes.time_series.TimeSeriesSEEG
title : tvb.contrib.scripts.datatypes.time_series.TimeSeriesSEEG.title = Attr(field_type=<class ‘str’>, default=’SEEG Time Series’, required=True)
labels_ordering : tvb.contrib.scripts.datatypes.time_series.TimeSeriesSensors.labels_ordering = List(of=<class ‘str’>, default=(‘Time’, ‘State Variable’, ‘Sensor’, ‘Sample’), required=True)
sensors : tvb.datatypes.time_series.TimeSeriesSEEG.sensors = Attr(field_type=<class ‘tvb.datatypes.sensors.SensorsInternal’>, default=None, required=True)
start_time : tvb.datatypes.time_series.TimeSeries.start_time = Float(field_type=<class ‘float’>, default=0, required=True)
sample_period : tvb.datatypes.time_series.TimeSeries.sample_period = Float(field_type=<class ‘float’>, default=1.0, required=True)
sample_period_unit : tvb.datatypes.time_series.TimeSeries.sample_period_unit = Attr(field_type=<class ‘str’>, default=’ms’, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.contrib.scripts.datatypes.time_series.TimeSeries
labels_ordering : tvb.contrib.scripts.datatypes.time_series.TimeSeriesSensors.labels_ordering = List(of=<class ‘str’>, default=(‘Time’, ‘State Variable’, ‘Sensor’, ‘Sample’), required=True)
title : tvb.contrib.scripts.datatypes.time_series.TimeSeriesSensors.title = Attr(field_type=<class ‘str’>, default=’Sensor Time Series’, required=True)
start_time : tvb.datatypes.time_series.TimeSeries.start_time = Float(field_type=<class ‘float’>, default=0, required=True)
sample_period : tvb.datatypes.time_series.TimeSeries.sample_period = Float(field_type=<class ‘float’>, default=1.0, required=True)
sample_period_unit : tvb.datatypes.time_series.TimeSeries.sample_period_unit = Attr(field_type=<class ‘str’>, default=’ms’, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
The attribute is a list of values. Choices and type are reinterpreted as applying not to the list but to the elements of it
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.contrib.scripts.datatypes.time_series.TimeSeriesBrain, tvb.datatypes.time_series.TimeSeriesSurface
labels_ordering : tvb.contrib.scripts.datatypes.time_series.TimeSeriesSurface.labels_ordering = List(of=<class ‘str’>, default=(‘Time’, ‘State Variable’, ‘Vertex’, ‘Sample’), required=True)
title : tvb.contrib.scripts.datatypes.time_series.TimeSeriesSurface.title = Attr(field_type=<class ‘str’>, default=’Surface Time Series’, required=True)
surface : tvb.datatypes.time_series.TimeSeriesSurface.surface = Attr(field_type=<class ‘tvb.datatypes.surfaces.CorticalSurface’>, default=None, required=True)
start_time : tvb.datatypes.time_series.TimeSeries.start_time = Float(field_type=<class ‘float’>, default=0, required=True)
sample_period : tvb.datatypes.time_series.TimeSeries.sample_period = Float(field_type=<class ‘float’>, default=1.0, required=True)
sample_period_unit : tvb.datatypes.time_series.TimeSeries.sample_period_unit = Attr(field_type=<class ‘str’>, default=’ms’, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
The attribute is a list of values. Choices and type are reinterpreted as applying not to the list but to the elements of it
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.contrib.scripts.datatypes.time_series.TimeSeries, tvb.datatypes.time_series.TimeSeriesVolume
labels_ordering : tvb.contrib.scripts.datatypes.time_series.TimeSeriesVolume.labels_ordering = List(of=<class ‘str’>, default=(‘Time’, ‘x’, ‘y’, ‘z’), required=True)
title : tvb.contrib.scripts.datatypes.time_series.TimeSeriesVolume.title = Attr(field_type=<class ‘str’>, default=’Volume Time Series’, required=True)
volume : tvb.datatypes.time_series.TimeSeriesVolume.volume = Attr(field_type=<class ‘tvb.datatypes.volumes.Volume’>, default=None, required=True)
start_time : tvb.datatypes.time_series.TimeSeries.start_time = Float(field_type=<class ‘float’>, default=0, required=True)
sample_period : tvb.datatypes.time_series.TimeSeries.sample_period = Float(field_type=<class ‘float’>, default=1.0, required=True)
sample_period_unit : tvb.datatypes.time_series.TimeSeries.sample_period_unit = Attr(field_type=<class ‘str’>, default=’ms’, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
The attribute is a list of values. Choices and type are reinterpreted as applying not to the list but to the elements of it
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.basic.neotraits._core.HasTraits
Base time-series dataType.
title : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.title = Attr(field_type=<class ‘str’>, default=’Time Series’, required=True)
start_time : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.start_time = Float(field_type=<class ‘float’>, default=0, required=True)
sample_period : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.sample_period = Float(field_type=<class ‘float’>, default=1.0, required=True)
sample_period_unit : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.sample_period_unit = Attr(field_type=<class ‘str’>, default=’ms’, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Declares a float. This is different from Attr(field_type=float). The former enforces float subtypes. This allows any type that can be safely cast to the declared float type according to numpy rules.
Reading and writing this attribute is slower than a plain python attribute. In performance sensitive code you might want to use plain python attributes or even better local variables.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Declares a float. This is different from Attr(field_type=float). The former enforces float subtypes. This allows any type that can be safely cast to the declared float type according to numpy rules.
Reading and writing this attribute is slower than a plain python attribute. In performance sensitive code you might want to use plain python attributes or even better local variables.
Gather scientifically interesting summary information from an instance of this datatype.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesSensors
A time series associated with a set of EEG sensors.
title : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesEEG.title = Attr(field_type=<class ‘str’>, default=’EEG Time Series’, required=True)
sensors : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesEEG.sensors = Attr(field_type=<class ‘tvb.datatypes.sensors.SensorsEEG’>, default=None, required=True)
_default_labels_ordering : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesEEG._default_labels_ordering = List(of=<class ‘str’>, default=(‘Time’, ‘1’, ‘EEG Sensor’, ‘1’), required=True)
start_time : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.start_time = Float(field_type=<class ‘float’>, default=0, required=True)
sample_period : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.sample_period = Float(field_type=<class ‘float’>, default=1.0, required=True)
sample_period_unit : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.sample_period_unit = Attr(field_type=<class ‘str’>, default=’ms’, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesSensors
A time series associated with a set of MEG sensors.
title : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesMEG.title = Attr(field_type=<class ‘str’>, default=’MEG Time Series’, required=True)
sensors : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesMEG.sensors = Attr(field_type=<class ‘tvb.datatypes.sensors.SensorsMEG’>, default=None, required=True)
_default_labels_ordering : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesMEG._default_labels_ordering = List(of=<class ‘str’>, default=(‘Time’, ‘1’, ‘MEG Sensor’, ‘1’), required=True)
start_time : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.start_time = Float(field_type=<class ‘float’>, default=0, required=True)
sample_period : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.sample_period = Float(field_type=<class ‘float’>, default=1.0, required=True)
sample_period_unit : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.sample_period_unit = Attr(field_type=<class ‘str’>, default=’ms’, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries
A time-series associated with the regions of a connectivity.
title : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesRegion.title = Attr(field_type=<class ‘str’>, default=’Region Time Series’, required=True)
connectivity : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesRegion.connectivity = Attr(field_type=<class ‘tvb.datatypes.connectivity.Connectivity’>, default=None, required=True)
region_mapping_volume : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesRegion.region_mapping_volume = Attr(field_type=<class ‘tvb.datatypes.region_mapping.RegionVolumeMapping’>, default=None, required=False)
region_mapping : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesRegion.region_mapping = Attr(field_type=<class ‘tvb.datatypes.region_mapping.RegionMapping’>, default=None, required=False)
_default_labels_ordering : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesRegion._default_labels_ordering = List(of=<class ‘str’>, default=(‘Time’, ‘State Variable’, ‘Region’, ‘Mode’), required=True)
start_time : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.start_time = Float(field_type=<class ‘float’>, default=0, required=True)
sample_period : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.sample_period = Float(field_type=<class ‘float’>, default=1.0, required=True)
sample_period_unit : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.sample_period_unit = Attr(field_type=<class ‘str’>, default=’ms’, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Gather scientifically interesting summary information from an instance of this datatype.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesSensors
A time series associated with a set of Internal sensors.
title : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesSEEG.title = Attr(field_type=<class ‘str’>, default=’SEEG Time Series’, required=True)
sensors : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesSEEG.sensors = Attr(field_type=<class ‘tvb.datatypes.sensors.SensorsInternal’>, default=None, required=True)
_default_labels_ordering : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesSEEG._default_labels_ordering = List(of=<class ‘str’>, default=(‘Time’, ‘1’, ‘sEEG Sensor’, ‘1’), required=True)
start_time : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.start_time = Float(field_type=<class ‘float’>, default=0, required=True)
sample_period : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.sample_period = Float(field_type=<class ‘float’>, default=1.0, required=True)
sample_period_unit : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.sample_period_unit = Attr(field_type=<class ‘str’>, default=’ms’, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries
title : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesSensors.title = Attr(field_type=<class ‘str’>, default=’Sensor Time Series’, required=True)
start_time : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.start_time = Float(field_type=<class ‘float’>, default=0, required=True)
sample_period : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.sample_period = Float(field_type=<class ‘float’>, default=1.0, required=True)
sample_period_unit : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.sample_period_unit = Attr(field_type=<class ‘str’>, default=’ms’, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Gather scientifically interesting summary information from an instance of this datatype.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries
A time-series associated with a Surface.
title : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesSurface.title = Attr(field_type=<class ‘str’>, default=’Surface Time Series’, required=True)
surface : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesSurface.surface = Attr(field_type=<class ‘tvb.datatypes.surfaces.CorticalSurface’>, default=None, required=True)
_default_labels_ordering : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesSurface._default_labels_ordering = List(of=<class ‘str’>, default=(‘Time’, ‘State Variable’, ‘Vertex’, ‘Mode’), required=True)
start_time : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.start_time = Float(field_type=<class ‘float’>, default=0, required=True)
sample_period : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.sample_period = Float(field_type=<class ‘float’>, default=1.0, required=True)
sample_period_unit : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.sample_period_unit = Attr(field_type=<class ‘str’>, default=’ms’, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Gather scientifically interesting summary information from an instance of this datatype.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
Bases: tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries
A time-series associated with a Volume.
title : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesVolume.title = Attr(field_type=<class ‘str’>, default=’Volume Time Series’, required=True)
volume : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesVolume.volume = Attr(field_type=<class ‘tvb.datatypes.volumes.Volume’>, default=None, required=True)
_default_labels_ordering : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeriesVolume._default_labels_ordering = List(of=<class ‘str’>, default=(‘Time’, ‘X’, ‘Y’, ‘Z’), required=True)
start_time : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.start_time = Float(field_type=<class ‘float’>, default=0, required=True)
sample_period : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.sample_period = Float(field_type=<class ‘float’>, default=1.0, required=True)
sample_period_unit : tvb.contrib.scripts.datatypes.time_series_xarray.TimeSeries.sample_period_unit = Attr(field_type=<class ‘str’>, default=’ms’, required=True)
gid : tvb.basic.neotraits._core.HasTraits.gid = Attr(field_type=<class ‘uuid.UUID’>, default=None, required=True)
Gather scientifically interesting summary information from an instance of this datatype.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.
An Attr declares the following about the attribute it describes: * the type * a default value shared by all instances * if the value might be missing * documentation It will resolve to attributes on the instance.