class SpatialPatternData(MappedType):
"""
Equation for space variation.
"""
spatial = equations.FiniteSupportEquation(label="Spatial Equation",
order=2)
class SpatialPattern(types_mapped.MappedType):
"""
Equation for space variation.
"""
spatial = equations.FiniteSupportEquation(label="Spatial Equation",
order=2)
space = None
_spatial_pattern = None
def _find_summary_info(self):
"""
Gather scientifically interesting summary information from an instance of this DataType.
"""
return {
"Type": self.__class__.__name__,
"Spatial equation": self.spatial.__class__.__name__,
"Spatial parameters": self.spatial.parameters
}
def _get_spatial_pattern(self):
"""
Return a discrete representation of the spatial pattern.
"""
return self._spatial_pattern
def _set_spatial_pattern(self, x):
"""
Generate a discrete representation of the spatial pattern.
The argument x represents a distance, or effective distance, for each node in the space.
"""
self.spatial.pattern = x
self._spatial_pattern = numpy.sum(self.spatial.pattern,
axis=1)[:, numpy.newaxis]
spatial_pattern = property(fget=_get_spatial_pattern,
fset=_set_spatial_pattern)
def configure_space(self, distance):
"""
Stores the distance vector as an attribute of the spatiotemporal pattern
and uses it to generate the spatial pattern vector.
Depending on equations used and interpretation distance can be an actual
physical distance, on a surface, geodesic distance (along the surface)
away for some focal point, or a per node weighting...
"""
# Set the discrete representation of space.
self.space = distance
self.spatial_pattern = self.space
class LocalConnectivity(types_mapped.MappedType):
"""
A sparse matrix for representing the local connectivity within the Cortex.
"""
_ui_name = "Local connectivity"
surface = surfaces.CorticalSurface(label="Surface", order=1)
matrix = types_mapped.SparseMatrix(order=-1)
equation = equations.FiniteSupportEquation(label="Spatial",
required=False,
default=equations.Gaussian,
order=2)
cutoff = basic.Float(
label="Cutoff distance (mm)",
default=40.0,
doc="Distance at which to truncate the evaluation in mm.",
order=3)
def compute(self):
"""
Compute current Matrix.
"""
LOG.info("Mapping geodesic distance through the LocalConnectivity.")
#Start with data being geodesic_distance_matrix, then map it through equation
self.equation.pattern = self.matrix_gdist.data
#Then replace original data with result...
self.matrix_gdist.data = self.equation.pattern
#Homogenise spatial discretisation effects across the surface
nv = self.matrix_gdist.shape[0]
ind = numpy.arange(nv, dtype=int)
pos_mask = self.matrix_gdist.data > 0.0
neg_mask = self.matrix_gdist.data < 0.0
pos_con = self.matrix_gdist.copy()
neg_con = self.matrix_gdist.copy()
pos_con.data[neg_mask] = 0.0
neg_con.data[pos_mask] = 0.0
pos_contrib = pos_con.sum(axis=1)
pos_contrib = numpy.array(pos_contrib).squeeze()
neg_contrib = neg_con.sum(axis=1)
neg_contrib = numpy.array(neg_contrib).squeeze()
pos_mean = pos_contrib.mean()
neg_mean = neg_contrib.mean()
if ((pos_mean != 0.0 and any(pos_contrib == 0.0))
or (neg_mean != 0.0 and any(neg_contrib == 0.0))):
msg = "Cortical mesh is too coarse for requested LocalConnectivity."
LOG.warning(msg)
bad_verts = ()
if pos_mean != 0.0:
bad_verts = bad_verts + numpy.nonzero(pos_contrib == 0.0)
if neg_mean != 0.0:
bad_verts = bad_verts + numpy.nonzero(neg_contrib == 0.0)
LOG.debug("Problem vertices are: %s" % str(bad_verts))
pos_hf = numpy.zeros(shape=pos_contrib.shape)
pos_hf[pos_contrib != 0] = pos_mean / pos_contrib[pos_contrib != 0]
neg_hf = numpy.zeros(shape=neg_contrib.shape)
neg_hf[neg_contrib != 0] = neg_mean / neg_contrib[neg_contrib != 0]
pos_hf_diag = scipy.sparse.csc_matrix((pos_hf, (ind, ind)),
shape=(nv, nv))
neg_hf_diag = scipy.sparse.csc_matrix((neg_hf, (ind, ind)),
shape=(nv, nv))
homogenious_conn = (pos_hf_diag * pos_con) + (neg_hf_diag * neg_con)
#Then replace unhomogenised result with the spatially homogeneous one...
if not homogenious_conn.has_sorted_indices:
homogenious_conn.sort_indices()
self.matrix = homogenious_conn
def _validate_before_store(self):
"""
Overrides MappedType._validate_before_store to use a custom error for missing matrix.
"""
# Sparse Matrix is required so we should check if there is any data stored for it
if self.matrix is None:
msg = ("LocalConnectivity can not be stored because it "
"has no SparseMatrix attached.")
raise exceptions.ValidationException(msg)
super(LocalConnectivity, self)._validate_before_store()
@staticmethod
def from_file(source_file="local_connectivity_16384.mat", instance=None):
if instance is None:
result = LocalConnectivity()
else:
result = instance
source_full_path = try_get_absolute_path("tvb_data.local_connectivity",
source_file)
reader = FileReader(source_full_path)
result.matrix = reader.read_array(matlab_data_name="LocalCoupling")
return result
def get_min_max_values(self):
"""
Retrieve the minimum and maximum values from the metadata.
:returns: (minimum_value, maximum_value)
"""
metadata = self.get_metadata('matrix')
return metadata[self.METADATA_ARRAY_MIN], metadata[
self.METADATA_ARRAY_MAX]
def _find_summary_info(self):
"""
Gather scientifically interesting summary information from an instance
of this datatype.
"""
return self.get_info_about_array('matrix', [
self.METADATA_ARRAY_MAX, self.METADATA_ARRAY_MIN,
self.METADATA_ARRAY_MEAN, self.METADATA_ARRAY_SHAPE
])
def compute_sparse_matrix(self):
"""
NOTE: Before calling this method, the surface field
should already be set on the local connectivity.
Computes the sparse matrix for this local connectivity.
"""
if self.surface is None:
raise AttributeError(
'Require surface to compute local connectivity.')
self.matrix_gdist = surfaces.gdist.local_gdist_matrix(
self.surface.vertices.astype(numpy.float64),
self.surface.triangles.astype(numpy.int32),
max_distance=self.cutoff)
self.compute()
# Avoid having a large data-set in memory.
self.matrix_gdist = None
def test_finitesupportequation(self):
dt = equations.FiniteSupportEquation()
assert dt.parameters == {}
def test_finitesupportequation(self):
dt = equations.FiniteSupportEquation()
self.assertEqual(dt.parameters, {})
self.assertEqual(dt.ui_equation, '')
class LocalConnectivityData(MappedType):
"""
A sparse matrix for representing the local connectivity within the Cortex.
"""
_ui_name = "Local connectivity"
surface = CorticalSurfaceData(label="Surface", order=1)
matrix = SparseMatrix(order=-1)
equation = equations.FiniteSupportEquation(
label="Spatial",
required=False,
default=equations.Gaussian,
order=2)
cutoff = basic.Float(
label="Cutoff distance (mm)",
default=40.0,
doc="Distance at which to truncate the evaluation in mm.",
order=3)
def compute(self):
"""
Compute current Matrix.
"""
LOG.info("Mapping geodesic distance through the LocalConnectivity.")
#Start with data being geodesic_distance_matrix, then map it through equation
self.equation.pattern = self.matrix_gdist.data
#Then replace original data with result...
self.matrix_gdist.data = self.equation.pattern
#Homogenise spatial discretisation effects across the surface
nv = self.matrix_gdist.shape[0]
ind = numpy.arange(nv, dtype=int)
pos_mask = self.matrix_gdist.data > 0.0
neg_mask = self.matrix_gdist.data < 0.0
pos_con = self.matrix_gdist.copy()
neg_con = self.matrix_gdist.copy()
pos_con.data[neg_mask] = 0.0
neg_con.data[pos_mask] = 0.0
pos_contrib = pos_con.sum(axis=1)
pos_contrib = numpy.array(pos_contrib).squeeze()
neg_contrib = neg_con.sum(axis=1)
neg_contrib = numpy.array(neg_contrib).squeeze()
pos_mean = pos_contrib.mean()
neg_mean = neg_contrib.mean()
if ((pos_mean != 0.0 and any(pos_contrib == 0.0)) or
(neg_mean != 0.0 and any(neg_contrib == 0.0))):
msg = "Cortical mesh is too coarse for requested LocalConnectivity."
LOG.warning(msg)
bad_verts = ()
if pos_mean != 0.0:
bad_verts = bad_verts + numpy.nonzero(pos_contrib == 0.0)
if neg_mean != 0.0:
bad_verts = bad_verts + numpy.nonzero(neg_contrib == 0.0)
LOG.debug("Problem vertices are: %s" % str(bad_verts))
pos_hf = numpy.zeros(shape=pos_contrib.shape)
pos_hf[pos_contrib != 0] = pos_mean / pos_contrib[pos_contrib != 0]
neg_hf = numpy.zeros(shape=neg_contrib.shape)
neg_hf[neg_contrib != 0] = neg_mean / neg_contrib[neg_contrib != 0]
pos_hf_diag = sparse.csc_matrix((pos_hf, (ind, ind)), shape=(nv, nv))
neg_hf_diag = sparse.csc_matrix((neg_hf, (ind, ind)), shape=(nv, nv))
homogenious_conn = (pos_hf_diag * pos_con) + (neg_hf_diag * neg_con)
#Then replace unhomogenised result with the spatially homogeneous one...
if not homogenious_conn.has_sorted_indices:
homogenious_conn.sort_indices()
self.matrix = homogenious_conn
def _validate_before_store(self):
"""
Overrides MappedType._validate_before_store to use a custom error for missing matrix.
"""
# Sparse Matrix is required so we should check if there is any data stored for it
if self.matrix is None:
msg = ("LocalConnectivity can not be stored because it "
"has no SparseMatrix attached.")
raise exceptions.ValidationException(msg)
super(LocalConnectivityData, self)._validate_before_store()
