Class: Edge

An edge in a network. Two modes: explicit (source+target set, scalar parameters in YAML) or template (no source/target, N×N matrix measure in HDF5). Both coexist in the same edges list.

URI: tvbo:Edge

 classDiagram
    class Edge
    click Edge href "./Edge.html"
      Edge : coupling
        
          
    
        
        
        Edge --> "0..1" Coupling : coupling
        click Coupling href "./Coupling.html"
    

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

        
      Edge : dimension_labels
        
          
    
        
        
        Edge --> "*" String : dimension_labels
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

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

        
      Edge : dynamics
        
          
    
        
        
        Edge --> "0..1" Dynamics : dynamics
        click Dynamics href "./Dynamics.html"
    

        
      Edge : events
        
          
    
        
        
        Edge --> "*" Event : events
        click Event href "./Event.html"
    

        
      Edge : format
        
          
    
        
        
        Edge --> "0..1" SparseFormat : format
        click SparseFormat href "../../enums/SparseFormat.html"
    

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

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

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

        
      Edge : source
        
          
    
        
        
        Edge --> "0..1" Integer : source
        click Integer href "../http://www.w3.org/2001/XMLSchema#integer.html"
    

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

        
      Edge : target
        
          
    
        
        
        Edge --> "0..1" Integer : target
        click Integer href "../http://www.w3.org/2001/XMLSchema#integer.html"
    

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

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

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

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

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

Class Properties

Property Value
Class URI tvbo:Edge

Slots

Name Cardinality and Range Description Inheritance
label 0..1
xsd:string		 direct
description 0..1
xsd:string		 direct
parameters *
Parameter		 direct
source 0..1
xsd:integer		 Source node ID (set for explicit edges, absent for template edges) direct
target 0..1
xsd:integer		 Target node ID (set for explicit edges, absent for template edges) direct
unit 0..1
xsd:string		 Unit for matrix values (template edges only) direct
format 0..1
SparseFormat		 Storage format in HDF5 (template edges only) direct
weighted 0..1
xsd:boolean		 Matrix entries carry weights (not just 0/1) direct
valid_diagonal 0..1
xsd:boolean		 Self-connections are meaningful direct
non_negative 0..1
xsd:boolean		 All values >= 0 direct
source_var 0..1
xsd:string		 Output variable from source node to use (e direct
target_var 0..1
xsd:string		 Input variable on target node to connect to (e direct
coupling 0..1
Coupling		 Coupling function for this edge direct
directed 0..1
xsd:boolean		 Whether the edge is directed direct
target_network 0..1
xsd:string		 Path or name of the Network whose nodes define the columns of a non-square (p… direct
dimension_labels *
xsd:string		 Ordered labels for the matrix columns (dim-1) when the matrix is non-square direct
dynamics 0..1
Dynamics		 Dynamics model for this edge direct
events *
Event		 Events attached to this edge (e direct

Usages

used by used in type used
Network edges range Edge

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Edge
description: 'An edge in a network. Two modes: explicit (source+target set, scalar
  parameters in YAML) or template (no source/target, N×N matrix measure in HDF5).
  Both coexist in the same edges list.'
from_schema: https://w3id.org/tvbo
slots:
- label
- description
- parameters
attributes:
  source:
    name: source
    description: Source node ID (set for explicit edges, absent for template edges)
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Edge
    - Observation
    - Dynamics
    range: integer
    required: false
  target:
    name: target
    description: Target node ID (set for explicit edges, absent for template edges)
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Edge
    range: integer
    required: false
  unit:
    name: unit
    description: Unit for matrix values (template edges only)
    from_schema: https://w3id.org/tvbo
    domain_of:
    - CommonCoordinateSpace
    - Edge
    - StateVariable
    - Parameter
    - Argument
    - DerivedParameter
    - DerivedVariable
    - Integrator
    - TimeSeries
    - NDArray
    - SpatialField
    range: string
  format:
    name: format
    description: Storage format in HDF5 (template edges only)
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Matrix
    - Edge
    - DataSource
    range: SparseFormat
  weighted:
    name: weighted
    description: Matrix entries carry weights (not just 0/1)
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: boolean(true)
    domain_of:
    - Edge
    range: boolean
  valid_diagonal:
    name: valid_diagonal
    description: Self-connections are meaningful
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: boolean(false)
    domain_of:
    - Edge
    range: boolean
  non_negative:
    name: non_negative
    description: All values >= 0
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: boolean(true)
    domain_of:
    - Edge
    range: boolean
  source_var:
    name: source_var
    description: Output variable from source node to use (e.g., 'x_out'). If not specified,
      uses first output variable from source dynamics.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Edge
    range: string
  target_var:
    name: target_var
    description: Input variable on target node to connect to (e.g., 'c_in'). If not
      specified, uses first coupling input from target dynamics.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Edge
    range: string
  coupling:
    name: coupling
    description: Coupling function for this edge. Can be a reference (by name) to
      coupling or inline definition. If not provided, uses experiment's default coupling.
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Network
    - Edge
    - SimulationExperiment
    range: Coupling
    required: false
    inlined: false
  directed:
    name: directed
    description: Whether the edge is directed. If false, represents a symmetric/bidirectional
      connection.
    from_schema: https://w3id.org/tvbo
    ifabsent: 'False'
    domain_of:
    - GraphGenerator
    - Edge
    range: boolean
  target_network:
    name: target_network
    description: Path or name of the Network whose nodes define the columns of a non-square
      (projection) matrix. For example, a gain matrix with shape (n_sensors, n_regions)
      references the brain parcellation network here.  Row labels come from the parent
      Network's own nodes.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Edge
    range: string
    required: false
  dimension_labels:
    name: dimension_labels
    description: Ordered labels for the matrix columns (dim-1) when the matrix is
      non-square.  Row labels (dim-0) are the parent Network's node labels.  Stored
      as HDF5 dimension scales in the companion file.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Edge
    range: string
    required: false
    multivalued: true
  dynamics:
    name: dynamics
    description: Dynamics model for this edge. When specified, the edge has its own
      state variables and ODE (EdgeModel with f in ND.jl). Uses the same Dynamics
      class as nodes — state_variables define edge states, derived_variables define
      observables, output defines what is visible for plotting/analysis. The coupling_function
      on Coupling still defines how vertex outputs map to edge outputs for aggregation
      at vertices.
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Network
    - Node
    - Edge
    - Continuation
    - SimulationExperiment
    range: Dynamics
    required: false
    inlined: false
  events:
    name: events
    description: Events attached to this edge (e.g., threshold-based line tripping).
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Node
    - Edge
    - Dynamics
    - SimulationExperiment
    range: Event
    multivalued: true
    inlined: true
class_uri: tvbo:Edge

Induced

name: Edge
description: 'An edge in a network. Two modes: explicit (source+target set, scalar
  parameters in YAML) or template (no source/target, N×N matrix measure in HDF5).
  Both coexist in the same edges list.'
from_schema: https://w3id.org/tvbo
attributes:
  source:
    name: source
    description: Source node ID (set for explicit edges, absent for template edges)
    from_schema: https://w3id.org/tvbo
    alias: source
    owner: Edge
    domain_of:
    - Edge
    - Observation
    - Dynamics
    range: integer
    required: false
  target:
    name: target
    description: Target node ID (set for explicit edges, absent for template edges)
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: target
    owner: Edge
    domain_of:
    - Edge
    range: integer
    required: false
  unit:
    name: unit
    description: Unit for matrix values (template edges only)
    from_schema: https://w3id.org/tvbo
    alias: unit
    owner: Edge
    domain_of:
    - CommonCoordinateSpace
    - Edge
    - StateVariable
    - Parameter
    - Argument
    - DerivedParameter
    - DerivedVariable
    - Integrator
    - TimeSeries
    - NDArray
    - SpatialField
    range: string
  format:
    name: format
    description: Storage format in HDF5 (template edges only)
    from_schema: https://w3id.org/tvbo
    alias: format
    owner: Edge
    domain_of:
    - Matrix
    - Edge
    - DataSource
    range: SparseFormat
  weighted:
    name: weighted
    description: Matrix entries carry weights (not just 0/1)
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: boolean(true)
    alias: weighted
    owner: Edge
    domain_of:
    - Edge
    range: boolean
  valid_diagonal:
    name: valid_diagonal
    description: Self-connections are meaningful
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: boolean(false)
    alias: valid_diagonal
    owner: Edge
    domain_of:
    - Edge
    range: boolean
  non_negative:
    name: non_negative
    description: All values >= 0
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: boolean(true)
    alias: non_negative
    owner: Edge
    domain_of:
    - Edge
    range: boolean
  source_var:
    name: source_var
    description: Output variable from source node to use (e.g., 'x_out'). If not specified,
      uses first output variable from source dynamics.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: source_var
    owner: Edge
    domain_of:
    - Edge
    range: string
  target_var:
    name: target_var
    description: Input variable on target node to connect to (e.g., 'c_in'). If not
      specified, uses first coupling input from target dynamics.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: target_var
    owner: Edge
    domain_of:
    - Edge
    range: string
  coupling:
    name: coupling
    description: Coupling function for this edge. Can be a reference (by name) to
      coupling or inline definition. If not provided, uses experiment's default coupling.
    from_schema: https://w3id.org/tvbo
    alias: coupling
    owner: Edge
    domain_of:
    - Network
    - Edge
    - SimulationExperiment
    range: Coupling
    required: false
    inlined: false
  directed:
    name: directed
    description: Whether the edge is directed. If false, represents a symmetric/bidirectional
      connection.
    from_schema: https://w3id.org/tvbo
    ifabsent: 'False'
    alias: directed
    owner: Edge
    domain_of:
    - GraphGenerator
    - Edge
    range: boolean
  target_network:
    name: target_network
    description: Path or name of the Network whose nodes define the columns of a non-square
      (projection) matrix. For example, a gain matrix with shape (n_sensors, n_regions)
      references the brain parcellation network here.  Row labels come from the parent
      Network's own nodes.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: target_network
    owner: Edge
    domain_of:
    - Edge
    range: string
    required: false
  dimension_labels:
    name: dimension_labels
    description: Ordered labels for the matrix columns (dim-1) when the matrix is
      non-square.  Row labels (dim-0) are the parent Network's node labels.  Stored
      as HDF5 dimension scales in the companion file.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: dimension_labels
    owner: Edge
    domain_of:
    - Edge
    range: string
    required: false
    multivalued: true
  dynamics:
    name: dynamics
    description: Dynamics model for this edge. When specified, the edge has its own
      state variables and ODE (EdgeModel with f in ND.jl). Uses the same Dynamics
      class as nodes — state_variables define edge states, derived_variables define
      observables, output defines what is visible for plotting/analysis. The coupling_function
      on Coupling still defines how vertex outputs map to edge outputs for aggregation
      at vertices.
    from_schema: https://w3id.org/tvbo
    alias: dynamics
    owner: Edge
    domain_of:
    - Network
    - Node
    - Edge
    - Continuation
    - SimulationExperiment
    range: Dynamics
    required: false
    inlined: false
  events:
    name: events
    description: Events attached to this edge (e.g., threshold-based line tripping).
    from_schema: https://w3id.org/tvbo
    alias: events
    owner: Edge
    domain_of:
    - Node
    - Edge
    - Dynamics
    - SimulationExperiment
    range: Event
    multivalued: true
    inlined: true
  label:
    name: label
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: label
    owner: Edge
    domain_of:
    - ParcellationTerminology
    - Dataset
    - Contact
    - Equation
    - Stimulus
    - Event
    - Parcellation
    - Tractogram
    - Matrix
    - Network
    - Node
    - Edge
    - Observation
    - Dynamics
    - StateVariable
    - Parameter
    - Function
    - FunctionCall
    - DerivedVariable
    - RandomStream
    - DataSource
    - OptimizationStage
    - Exploration
    - TuningObjective
    - Continuation
    - Coupling
    - RegionMapping
    - SimulationExperiment
    - SimulationStudy
    - TimeSeries
    - SoftwareEnvironment
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - DifferentialOperator
    - BoundaryCondition
    - PDESolver
    - PDE
    range: string
  description:
    name: description
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: description
    owner: Edge
    domain_of:
    - ClinicalScore
    - Equation
    - Stimulus
    - Event
    - Tractogram
    - Matrix
    - Network
    - GraphGenerator
    - File
    - Node
    - Edge
    - Observation
    - Dynamics
    - StateVariable
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - FunctionCall
    - Callable
    - DerivedParameter
    - DerivedVariable
    - RandomStream
    - DataSource
    - OptimizationStage
    - Exploration
    - UpdateRule
    - TuningObjective
    - Algorithm
    - BranchSwitch
    - Continuation
    - Integrator
    - Coupling
    - RegionMapping
    - SimulationExperiment
    - SimulationStudy
    - TimeSeries
    - SoftwareEnvironment
    - SoftwareRequirement
    - SoftwarePackage
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - BoundaryCondition
    - PDESolver
    - PDE
    range: string
  parameters:
    name: parameters
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: parameters
    owner: Edge
    domain_of:
    - Equation
    - Stimulus
    - Event
    - TemporalApplicableEquation
    - Network
    - GraphGenerator
    - Node
    - Edge
    - Observation
    - Dynamics
    - Distribution
    - Noise
    - Exploration
    - Discretization
    - BranchSwitch
    - Integrator
    - Coupling
    - PDE
    range: Parameter
    multivalued: true
    inlined: true
class_uri: tvbo:Edge