Class: Coupling

URI: tvbo:Coupling

 classDiagram
    class Coupling
    click Coupling href "./Coupling.html"
      Coupling : aggregation
        
          
    
        
        
        Coupling --> "0..1" String : aggregation
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      Coupling : coupling_function
        
          
    
        
        
        Coupling --> "0..1" Equation : coupling_function
        click Equation href "./Equation.html"
    

        
      Coupling : delayed
        
          
    
        
        
        Coupling --> "0..1" Boolean : delayed
        click Boolean href "../http://www.w3.org/2001/XMLSchema#boolean.html"
    

        
      Coupling : description
        
          
    
        
        
        Coupling --> "0..1" String : description
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      Coupling : distribution
        
          
    
        
        
        Coupling --> "0..1" String : distribution
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      Coupling : incoming_states
        
          
    
        
        
        Coupling --> "*" StateVariable : incoming_states
        click StateVariable href "./StateVariable.html"
    

        
      Coupling : inner_coupling
        
          
    
        
        
        Coupling --> "0..1" Coupling : inner_coupling
        click Coupling href "./Coupling.html"
    

        
      Coupling : label
        
          
    
        
        
        Coupling --> "0..1" String : label
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      Coupling : local_states
        
          
    
        
        
        Coupling --> "*" StateVariable : local_states
        click StateVariable href "./StateVariable.html"
    

        
      Coupling : name
        
          
    
        
        
        Coupling --> "1" String : name
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      Coupling : parameters
        
          
    
        
        
        Coupling --> "*" Parameter : parameters
        click Parameter href "./Parameter.html"
    

        
      Coupling : post_expression
        
          
    
        
        
        Coupling --> "0..1" Equation : post_expression
        click Equation href "./Equation.html"
    

        
      Coupling : pre_expression
        
          
    
        
        
        Coupling --> "0..1" Equation : pre_expression
        click Equation href "./Equation.html"
    

        
      Coupling : region_mapping
        
          
    
        
        
        Coupling --> "0..1" RegionMapping : region_mapping
        click RegionMapping href "./RegionMapping.html"
    

        
      Coupling : regional_connectivity
        
          
    
        
        
        Coupling --> "0..1" Network : regional_connectivity
        click Network href "./Network.html"
    

        
      Coupling : sparse
        
          
    
        
        
        Coupling --> "0..1" Boolean : sparse
        click Boolean href "../http://www.w3.org/2001/XMLSchema#boolean.html"
    

        
      

Slots

Name	Cardinality and Range	Description	Inheritance
name	1 xsd:string		direct
label	0..1 xsd:string		direct
parameters	* Parameter		direct
description	0..1 xsd:string		direct
coupling_function	0..1 Equation	Mathematical function defining the coupling	direct
sparse	0..1 xsd:boolean	Whether the coupling uses sparse representations	direct
pre_expression	0..1 Equation	Pre-processing expression applied before coupling	direct
post_expression	0..1 Equation	Post-processing expression applied after coupling	direct
incoming_states	* StateVariable	References to state variables from connected nodes (source)	direct
local_states	* StateVariable	References to state variables from local node (target)	direct
delayed	0..1 xsd:boolean	Whether coupling includes transmission delays	direct
inner_coupling	0..1 Coupling	For hierarchical coupling: inner coupling applied at regional level	direct
region_mapping	0..1 RegionMapping	For hierarchical coupling: vertex-to-region mapping for aggregation	direct
regional_connectivity	0..1 Network	For hierarchical coupling: region-to-region connectivity with weights and del…	direct
aggregation	0..1 xsd:string or  xsd:string or  Function	For hierarchical coupling: aggregation method (‘sum’, ‘mean’, ‘max’) or custo…	direct
distribution	0..1 xsd:string or  xsd:string or  Function	For hierarchical coupling: distribution method (‘broadcast’, ‘weighted’) or c…	direct

Usages

used by	used in	type	used
Network	coupling	range	Coupling
Edge	coupling	range	Coupling
Coupling	inner_coupling	range	Coupling
SimulationExperiment	coupling	range	Coupling

Identifier and Mapping Information

Schema Source

• from schema: https://w3id.org/tvbo

Mappings

Mapping Type	Mapped Value
self	tvbo:Coupling
native	tvbo:Coupling

LinkML Source

Direct

name: Coupling
from_schema: https://w3id.org/tvbo
slots:
- name
- label
- parameters
- description
slot_usage:
  name:
    name: name
    ifabsent: Linear
attributes:
  coupling_function:
    name: coupling_function
    description: Mathematical function defining the coupling
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Coupling
    range: Equation
    inlined: true
  sparse:
    name: sparse
    description: Whether the coupling uses sparse representations
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: 'False'
    domain_of:
    - Coupling
    range: boolean
  pre_expression:
    name: pre_expression
    description: Pre-processing expression applied before coupling
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Coupling
    range: Equation
    inlined: true
  post_expression:
    name: post_expression
    description: Post-processing expression applied after coupling
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Coupling
    range: Equation
    inlined: true
  incoming_states:
    name: incoming_states
    description: References to state variables from connected nodes (source)
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Coupling
    range: StateVariable
    multivalued: true
  local_states:
    name: local_states
    description: References to state variables from local node (target)
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Coupling
    range: StateVariable
    multivalued: true
  delayed:
    name: delayed
    description: Whether coupling includes transmission delays
    from_schema: https://w3id.org/tvbo
    ifabsent: 'True'
    domain_of:
    - Integrator
    - Coupling
    range: boolean
  inner_coupling:
    name: inner_coupling
    description: 'For hierarchical coupling: inner coupling applied at regional level'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Coupling
    range: Coupling
    inlined: true
  region_mapping:
    name: region_mapping
    description: 'For hierarchical coupling: vertex-to-region mapping for aggregation'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Coupling
    range: RegionMapping
    inlined: true
  regional_connectivity:
    name: regional_connectivity
    description: 'For hierarchical coupling: region-to-region connectivity with weights
      and delays'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Coupling
    range: Network
    inlined: true
  aggregation:
    name: aggregation
    description: 'For hierarchical coupling: aggregation method (''sum'', ''mean'',
      ''max'') or custom Function'
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Observation
    - Coupling
    any_of:
    - range: string
    - range: Function
  distribution:
    name: distribution
    description: 'For hierarchical coupling: distribution method (''broadcast'', ''weighted'')
      or custom Function'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Coupling
    any_of:
    - range: string
    - range: Function
class_uri: tvbo:Coupling

Induced

name: Coupling
from_schema: https://w3id.org/tvbo
slot_usage:
  name:
    name: name
    ifabsent: Linear
attributes:
  coupling_function:
    name: coupling_function
    description: Mathematical function defining the coupling
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: coupling_function
    owner: Coupling
    domain_of:
    - Coupling
    range: Equation
    inlined: true
  sparse:
    name: sparse
    description: Whether the coupling uses sparse representations
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: 'False'
    alias: sparse
    owner: Coupling
    domain_of:
    - Coupling
    range: boolean
  pre_expression:
    name: pre_expression
    description: Pre-processing expression applied before coupling
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: pre_expression
    owner: Coupling
    domain_of:
    - Coupling
    range: Equation
    inlined: true
  post_expression:
    name: post_expression
    description: Post-processing expression applied after coupling
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: post_expression
    owner: Coupling
    domain_of:
    - Coupling
    range: Equation
    inlined: true
  incoming_states:
    name: incoming_states
    description: References to state variables from connected nodes (source)
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: incoming_states
    owner: Coupling
    domain_of:
    - Coupling
    range: StateVariable
    multivalued: true
  local_states:
    name: local_states
    description: References to state variables from local node (target)
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: local_states
    owner: Coupling
    domain_of:
    - Coupling
    range: StateVariable
    multivalued: true
  delayed:
    name: delayed
    description: Whether coupling includes transmission delays
    from_schema: https://w3id.org/tvbo
    ifabsent: 'True'
    alias: delayed
    owner: Coupling
    domain_of:
    - Integrator
    - Coupling
    range: boolean
  inner_coupling:
    name: inner_coupling
    description: 'For hierarchical coupling: inner coupling applied at regional level'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: inner_coupling
    owner: Coupling
    domain_of:
    - Coupling
    range: Coupling
    inlined: true
  region_mapping:
    name: region_mapping
    description: 'For hierarchical coupling: vertex-to-region mapping for aggregation'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: region_mapping
    owner: Coupling
    domain_of:
    - Coupling
    range: RegionMapping
    inlined: true
  regional_connectivity:
    name: regional_connectivity
    description: 'For hierarchical coupling: region-to-region connectivity with weights
      and delays'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: regional_connectivity
    owner: Coupling
    domain_of:
    - Coupling
    range: Network
    inlined: true
  aggregation:
    name: aggregation
    description: 'For hierarchical coupling: aggregation method (''sum'', ''mean'',
      ''max'') or custom Function'
    from_schema: https://w3id.org/tvbo
    alias: aggregation
    owner: Coupling
    domain_of:
    - Observation
    - Coupling
    range: string
    any_of:
    - range: string
    - range: Function
  distribution:
    name: distribution
    description: 'For hierarchical coupling: distribution method (''broadcast'', ''weighted'')
      or custom Function'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: distribution
    owner: Coupling
    domain_of:
    - Coupling
    range: string
    any_of:
    - range: string
    - range: Function
  name:
    name: name
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: Linear
    key: true
    alias: name
    owner: Coupling
    domain_of:
    - BrainAtlas
    - CommonCoordinateSpace
    - ParcellationEntity
    - DBSProtocol
    - ClinicalScale
    - ClinicalScore
    - Tractogram
    - File
    - Observation
    - Dynamics
    - StateVariable
    - Distribution
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - Callable
    - DerivedParameter
    - DerivedVariable
    - DataSource
    - OptimizationStage
    - Exploration
    - UpdateRule
    - Algorithm
    - Coupling
    - SoftwareEnvironment
    - SoftwareRequirement
    - SoftwarePackage
    range: string
    required: true
  label:
    name: label
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: label
    owner: Coupling
    domain_of:
    - ParcellationTerminology
    - Dataset
    - Contact
    - Equation
    - Stimulus
    - Parcellation
    - Tractogram
    - Matrix
    - Network
    - Node
    - Edge
    - Observation
    - Dynamics
    - StateVariable
    - Parameter
    - Function
    - DerivedVariable
    - RandomStream
    - DataSource
    - OptimizationStage
    - Exploration
    - TuningObjective
    - Coupling
    - RegionMapping
    - SimulationExperiment
    - SimulationStudy
    - TimeSeries
    - SoftwareEnvironment
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - DifferentialOperator
    - BoundaryCondition
    - PDESolver
    - PDE
    range: string
  parameters:
    name: parameters
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: parameters
    owner: Coupling
    domain_of:
    - Equation
    - Stimulus
    - TemporalApplicableEquation
    - Node
    - Edge
    - Observation
    - Dynamics
    - Distribution
    - Noise
    - Exploration
    - Integrator
    - Coupling
    - PDE
    range: Parameter
    multivalued: true
    inlined: true
  description:
    name: description
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: description
    owner: Coupling
    domain_of:
    - ClinicalScore
    - Equation
    - Stimulus
    - Tractogram
    - Matrix
    - Network
    - File
    - Node
    - Edge
    - Observation
    - Dynamics
    - StateVariable
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - Callable
    - DerivedParameter
    - DerivedVariable
    - RandomStream
    - DataSource
    - OptimizationStage
    - Exploration
    - UpdateRule
    - TuningObjective
    - Algorithm
    - Integrator
    - Coupling
    - RegionMapping
    - SimulationExperiment
    - SimulationStudy
    - TimeSeries
    - SoftwareEnvironment
    - SoftwareRequirement
    - SoftwarePackage
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - BoundaryCondition
    - PDESolver
    - PDE
    range: string
class_uri: tvbo:Coupling