BrainStructure¶
from mcot.surface.cortical_mesh import BrainStructure
- class mcot.surface.cortical_mesh.BrainStructure(primary, secondary=None, hemisphere='both', geometry=None)[source]¶
Which brain structure does the parent object describe?
- __init__(primary, secondary=None, hemisphere='both', geometry=None)[source]¶
Creates a new brain structure.
- Parameters
primary – Name of the brain structure (e.g. cortex, thalamus)
secondary – Further specification of which part of the brain structure is described (e.g. ‘white’ or ‘pial’ for the cortex)
hemisphere – which hemisphere is the brain structure in (‘left’, ‘right’, or ‘both’)
geometry – does the parent object describe the ‘volume’ or the ‘surface’
Inheritance diagram
digraph inheritance663a6cc226 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "mcot.surface.cortical_mesh.BrainStructure" [URL="#mcot.surface.cortical_mesh.BrainStructure",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Which brain structure does the parent object describe?"]; }Methods
from_string
(value[, issurface])Parses a string to find out which brain structure is being described.
Attributes
cifti
Returns a description of the brain structure needed to define the surface in a CIFTI file.
gifti
Returns the keywords needed to define the surface in the meta information of a GIFTI file.
from_string¶
- classmethod BrainStructure.from_string(value, issurface=None)[source]¶
Parses a string to find out which brain structure is being described.
- Parameters
value – string to be parsed
issurface – defines whether the object describes the volume or surface of the brain structure (default: surface if the brain structure is the cortex volume otherwise)