Source code for tvb.datatypes.volumes
# -*- coding: utf-8 -*-
# TheVirtualBrain-Scientific Package. This package holds all simulators, and
# analysers necessary to run brain-simulations. You can use it stand alone or
# in conjunction with TheVirtualBrain-Framework Package. See content of the
# documentation-folder for more details. See also http://www.thevirtualbrain.org
# (c) 2012-2023, Baycrest Centre for Geriatric Care ("Baycrest") and others
# This program is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software Foundation,
# either version 3 of the License, or (at your option) any later version.
# This program is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
# PARTICULAR PURPOSE. See the GNU General Public License for more details.
# You should have received a copy of the GNU General Public License along with this
# program. If not, see <http://www.gnu.org/licenses/>.
# When using The Virtual Brain for scientific publications, please cite it as explained here:
The Volume datatypes.
.. moduleauthor:: Stuart A. Knock <Stuart@tvb.invalid>
from tvb.basic.neotraits.api import HasTraits, Attr, NArray
Data defined on a regular grid in three dimensions.
origin = NArray(label="Volume origin coordinates")
voxel_size = NArray(label="Voxel size") # need a triplet, xyz
voxel_unit = Attr(str, label="Voxel Measure Unit", default="mm")
[docs] def summary_info(self):
"Volume type": self.__class__.__name__,
"Voxel size": self.voxel_size,