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 : interpolate_delays
        
          
    
        
        
        Coupling --> "0..1" Boolean : interpolate_delays
        click Boolean href "../http://www.w3.org/2001/XMLSchema#boolean.html"
    

        
      Coupling : iri
        
          
    
        
        
        Coupling --> "0..1" Uriorcurie : iri
        click Uriorcurie href "../http://www.w3.org/2001/XMLSchema#anyURI.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 : observed
        
          
    
        
        
        Coupling --> "*" DerivedVariable : observed
        click DerivedVariable href "./DerivedVariable.html"
    

        
      Coupling : outsym
        
          
    
        
        
        Coupling --> "*" String : outsym
        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"
    

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

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

Class Properties

Property Value
Class URI tvbo:Coupling

Slots

Name Cardinality and Range Description Inheritance
name 1
xsd:string		 Globally unique identifier for the entity direct
label 0..1
xsd:string		 direct
iri 0..1
xsd:anyURI		 Optional stable IRI (or compact URI) for this entity in an external ontology … 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 (source) nodes direct
local_states *
StateVariable		 References to state variables from the local (target) node direct
delayed 0..1
xsd:boolean		 Whether coupling includes transmission delays direct
interpolate_delays 0..1
xsd:boolean		 For delayed coupling: read delayed states by linear interpolation between the… direct
vectorized 0..1
xsd:boolean		 Opt in to the vectorized matmul fast path for a source-only coupling — one wh… direct
symmetry 0..1
xsd:string		 Edge symmetry type for NetworkDynamics direct
outsym *
xsd:string		 Output symbol names for the edge model direct
observed *
DerivedVariable		 Observable functions computed from edge inputs and parameters after simulatio… 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 
Function		 For hierarchical coupling: aggregation method (‘sum’, ‘mean’, ‘max’) or custo… direct
distribution 0..1
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
- iri
- 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 (source) nodes. Auto-populated
      from state_variables with coupling_variable=true when omitted. Used by name
      in pre_expression.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Coupling
    range: StateVariable
    multivalued: true
    inlined: false
  local_states:
    name: local_states
    description: References to state variables from the local (target) node. Used
      by name in pre_expression.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Coupling
    range: StateVariable
    multivalued: true
    inlined: false
  delayed:
    name: delayed
    description: Whether coupling includes transmission delays
    from_schema: https://w3id.org/tvbo
    ifabsent: 'True'
    domain_of:
    - Integrator
    - Coupling
    range: boolean
  interpolate_delays:
    name: interpolate_delays
    description: 'For delayed coupling: read delayed states by linear interpolation
      between the two bracketing history time-steps instead of snapping each delay
      to the nearest integer step. Removes sub-step quantisation error and makes the
      coupling differentiable w.r.t. the continuous delay — hence w.r.t. conduction
      speed v (delay = tract_length / v) — so v can be gradient-optimised. Default
      false preserves exact nearest-step behaviour (tvboptim roll strategy).'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: 'False'
    domain_of:
    - Coupling
    range: boolean
  vectorized:
    name: vectorized
    description: 'Opt in to the vectorized matmul fast path for a source-only coupling
      — one whose pre_expression depends only on source states (e.g. the angle-addition
      decomposition [sin(theta_j), cos(theta_j)]). The W-reduction then becomes a
      single ``pre @ weights`` matmul instead of materialising the dense per-edge
      tensor. ONLY valid for INSTANTANEOUS coupling on a SYMMETRIC connectome (W ==
      Wᵀ): the matmul contracts W while the per-edge path contracts Wᵀ, so the two
      agree only when W is symmetric. Default false keeps the always-correct per-edge
      reduction (and delays are inherently per-edge, so this flag is ignored when
      delayed=true).'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: 'False'
    domain_of:
    - Coupling
    range: boolean
  symmetry:
    name: symmetry
    description: 'Edge symmetry type for NetworkDynamics.jl EdgeModel: ''directed''
      (default), ''antisymmetric'', or ''symmetric''. AntiSymmetric edges flip sign
      for the reverse direction.'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: string(directed)
    domain_of:
    - Coupling
    range: string
  outsym:
    name: outsym
    description: Output symbol names for the edge model. E.g. ['P'] for a scalar power
      flow, ['Fx', 'Fy'] for 2D forces. Maps directly to outsym in ND.jl EdgeModel.
      If not specified, derived from coupling variables of the connected vertex dynamics.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Coupling
    range: string
    multivalued: true
  observed:
    name: observed
    description: 'Observable functions computed from edge inputs and parameters after
      simulation. Maps to obsf/obssym in ND.jl EdgeModel. Example: absolute force
      magnitude computed from force components.'
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Dynamics
    - Coupling
    range: DerivedVariable
    multivalued: true
    inlined: true
  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
    domain_of:
    - StateVariable
    - Parameter
    - Noise
    - Prior
    - 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
    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'
    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
    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
    owner: Coupling
    domain_of:
    - Coupling
    range: Equation
    inlined: true
  incoming_states:
    name: incoming_states
    description: References to state variables from connected (source) nodes. Auto-populated
      from state_variables with coupling_variable=true when omitted. Used by name
      in pre_expression.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    owner: Coupling
    domain_of:
    - Coupling
    range: StateVariable
    multivalued: true
    inlined: false
  local_states:
    name: local_states
    description: References to state variables from the local (target) node. Used
      by name in pre_expression.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    owner: Coupling
    domain_of:
    - Coupling
    range: StateVariable
    multivalued: true
    inlined: false
  delayed:
    name: delayed
    description: Whether coupling includes transmission delays
    from_schema: https://w3id.org/tvbo
    ifabsent: 'True'
    owner: Coupling
    domain_of:
    - Integrator
    - Coupling
    range: boolean
  interpolate_delays:
    name: interpolate_delays
    description: 'For delayed coupling: read delayed states by linear interpolation
      between the two bracketing history time-steps instead of snapping each delay
      to the nearest integer step. Removes sub-step quantisation error and makes the
      coupling differentiable w.r.t. the continuous delay — hence w.r.t. conduction
      speed v (delay = tract_length / v) — so v can be gradient-optimised. Default
      false preserves exact nearest-step behaviour (tvboptim roll strategy).'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: 'False'
    owner: Coupling
    domain_of:
    - Coupling
    range: boolean
  vectorized:
    name: vectorized
    description: 'Opt in to the vectorized matmul fast path for a source-only coupling
      — one whose pre_expression depends only on source states (e.g. the angle-addition
      decomposition [sin(theta_j), cos(theta_j)]). The W-reduction then becomes a
      single ``pre @ weights`` matmul instead of materialising the dense per-edge
      tensor. ONLY valid for INSTANTANEOUS coupling on a SYMMETRIC connectome (W ==
      Wᵀ): the matmul contracts W while the per-edge path contracts Wᵀ, so the two
      agree only when W is symmetric. Default false keeps the always-correct per-edge
      reduction (and delays are inherently per-edge, so this flag is ignored when
      delayed=true).'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: 'False'
    owner: Coupling
    domain_of:
    - Coupling
    range: boolean
  symmetry:
    name: symmetry
    description: 'Edge symmetry type for NetworkDynamics.jl EdgeModel: ''directed''
      (default), ''antisymmetric'', or ''symmetric''. AntiSymmetric edges flip sign
      for the reverse direction.'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: string(directed)
    owner: Coupling
    domain_of:
    - Coupling
    range: string
  outsym:
    name: outsym
    description: Output symbol names for the edge model. E.g. ['P'] for a scalar power
      flow, ['Fx', 'Fy'] for 2D forces. Maps directly to outsym in ND.jl EdgeModel.
      If not specified, derived from coupling variables of the connected vertex dynamics.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    owner: Coupling
    domain_of:
    - Coupling
    range: string
    multivalued: true
  observed:
    name: observed
    description: 'Observable functions computed from edge inputs and parameters after
      simulation. Maps to obsf/obssym in ND.jl EdgeModel. Example: absolute force
      magnitude computed from force components.'
    from_schema: https://w3id.org/tvbo
    owner: Coupling
    domain_of:
    - Dynamics
    - Coupling
    range: DerivedVariable
    multivalued: true
    inlined: true
  inner_coupling:
    name: inner_coupling
    description: 'For hierarchical coupling: inner coupling applied at regional level'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    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
    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
    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
    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
    owner: Coupling
    domain_of:
    - StateVariable
    - Parameter
    - Noise
    - Prior
    - Coupling
    range: string
    any_of:
    - range: string
    - range: Function
  name:
    name: name
    description: Globally unique identifier for the entity.
    from_schema: https://w3id.org/tvbo/common
    slot_uri: schema:name
    ifabsent: Linear
    identifier: true
    owner: Coupling
    domain_of:
    - BrainAtlas
    - CommonCoordinateSpace
    - ParcellationEntity
    - DBSProtocol
    - ClinicalScale
    - ClinicalScore
    - SoftwarePackage
    - SoftwareRequirement
    - SoftwareEnvironment
    - Event
    - Tractogram
    - MeasureSpec
    - NamedArray
    - GraphGenerator
    - Binding
    - ProcedureStep
    - File
    - StateValue
    - Observation
    - Dynamics
    - StateVariable
    - Distribution
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - FunctionCall
    - Callable
    - DerivedParameter
    - DerivedVariable
    - DataSource
    - OptimizationStage
    - Exploration
    - Inference
    - Prior
    - Likelihood
    - UpdateRule
    - Algorithm
    - Option
    - BranchSwitch
    - Continuation
    - Coupling
    range: string
    required: true
  label:
    name: label
    from_schema: https://w3id.org/tvbo
    rank: 1000
    slot_uri: rdfs:label
    owner: Coupling
    domain_of:
    - ParcellationTerminology
    - Subject
    - Session
    - Dataset
    - Contact
    - SoftwareEnvironment
    - Equation
    - Stimulus
    - Event
    - Parcellation
    - Tractogram
    - Matrix
    - Phenotype
    - Network
    - Node
    - Edge
    - Observation
    - Dynamics
    - StateVariable
    - Parameter
    - Function
    - FunctionCall
    - DerivedVariable
    - RandomStream
    - DataSource
    - OptimizationStage
    - Exploration
    - ExplorationAxis
    - FreeParameter
    - Inference
    - AlgorithmStage
    - TuningObjective
    - Continuation
    - Coupling
    - RegionMapping
    - SimulationExperiment
    - SimulationStudy
    - TimeSeries
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - DifferentialOperator
    - BoundaryCondition
    - PDESolver
    - PDE
    range: string
  iri:
    name: iri
    description: Optional stable IRI (or compact URI) for this entity in an external
      ontology or knowledge base. Used to load metadata from an external source; not
      required when the entity is fully self-contained (equations, parameters, etc.
      defined in the file itself).
    from_schema: https://w3id.org/tvbo
    rank: 1000
    slot_uri: dcterms:identifier
    owner: Coupling
    domain_of:
    - Parcellation
    - Tractogram
    - ReferenceFingerprint
    - GraphGenerator
    - Reference
    - Dynamics
    - Function
    - Coupling
    range: uriorcurie
  parameters:
    name: parameters
    from_schema: https://w3id.org/tvbo
    rank: 1000
    owner: Coupling
    domain_of:
    - Equation
    - Stimulus
    - Event
    - TemporalApplicableEquation
    - Network
    - GraphGenerator
    - Node
    - Edge
    - Observation
    - Analysis
    - Dynamics
    - Distribution
    - Noise
    - Exploration
    - Discretization
    - BranchSwitch
    - Integrator
    - Coupling
    - PDE
    range: Parameter
    multivalued: true
    inlined: true
  description:
    name: description
    from_schema: https://w3id.org/tvbo
    rank: 1000
    slot_uri: dcterms:description
    owner: Coupling
    domain_of:
    - Dataset
    - ClinicalScore
    - SoftwarePackage
    - SoftwareRequirement
    - SoftwareEnvironment
    - Equation
    - Stimulus
    - Event
    - Tractogram
    - Matrix
    - Phenotype
    - MeasureSpec
    - NamedArray
    - Network
    - GraphGenerator
    - ProcedureStep
    - File
    - Node
    - Edge
    - Observation
    - Dynamics
    - StateVariable
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - FunctionCall
    - Callable
    - DerivedParameter
    - DerivedVariable
    - RandomStream
    - DataSource
    - OptimizationStage
    - Exploration
    - ExplorationAxis
    - FreeParameter
    - Inference
    - Prior
    - Likelihood
    - UpdateRule
    - AlgorithmStage
    - TuningObjective
    - Algorithm
    - BranchSwitch
    - Continuation
    - Integrator
    - Coupling
    - RegionMapping
    - SimulationExperiment
    - Study
    - TimeSeries
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - BoundaryCondition
    - PDESolver
    - PDE
    range: string
class_uri: tvbo:Coupling