Class: StateVariable

URI: tvbo:StateVariable

 classDiagram
    class StateVariable
    click StateVariable href "./StateVariable.html"
      StateVariable <|-- FieldStateVariable
        click FieldStateVariable href "./FieldStateVariable.html"
      
      StateVariable : boundaries
        
          
    
        
        
        StateVariable --> "0..1" Range : boundaries
        click Range href "./Range.html"
    

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

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

        
      StateVariable : derivative_initial_value
        
          
    
        
        
        StateVariable --> "0..1" Float : derivative_initial_value
        click Float href "../http://www.w3.org/2001/XMLSchema#float.html"
    

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

        
      StateVariable : distribution
        
          
    
        
        
        StateVariable --> "0..1" Distribution : distribution
        click Distribution href "./Distribution.html"
    

        
      StateVariable : domain
        
          
    
        
        
        StateVariable --> "0..1" Range : domain
        click Range href "./Range.html"
    

        
      StateVariable : equation
        
          
    
        
        
        StateVariable --> "0..1" Equation : equation
        click Equation href "./Equation.html"
    

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

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

        
      StateVariable : history
        
          
    
        
        
        StateVariable --> "0..1" TimeSeries : history
        click TimeSeries href "./TimeSeries.html"
    

        
      StateVariable : initial_value
        
          
    
        
        
        StateVariable --> "0..1" Float : initial_value
        click Float href "../http://www.w3.org/2001/XMLSchema#float.html"
    

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

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

        
      StateVariable : noise
        
          
    
        
        
        StateVariable --> "0..1" Noise : noise
        click Noise href "./Noise.html"
    

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

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

        
      StateVariable : unit
        
          
    
        
        
        StateVariable --> "0..1" UnitEnum : unit
        click UnitEnum href "../../enums/UnitEnum.html"
    

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

Inheritance

Class Properties

Property Value
Class URI tvbo:StateVariable

Slots

Name Cardinality and Range Description Inheritance
name 1
xsd:string		 direct
symbol 0..1
xsd:string		 direct
label 0..1
xsd:string		 direct
definition 0..1
xsd:string		 direct
domain 0..1
Range		 direct
description 0..1
xsd:string		 direct
equation 0..1
Equation		 direct
unit 0..1
UnitEnum		 Physical unit of measurement direct
variable_of_interest 0..1
xsd:boolean		 direct
coupling_variable 0..1
xsd:boolean		 Whether this state variable is transmitted to connected nodes through the cou… direct
equation_type 0..1
xsd:string		 Type of equation: ‘differential’ (default) means dx/dt = rhs, ‘algebraic’ mea… direct
equation_order 0..1
xsd:integer		 Order of the time derivative on the LHS direct
noise 0..1
Noise		 direct
stimulation_variable 0..1
xsd:boolean		 direct
boundaries 0..1
Range		 direct
initial_value 0..1
xsd:float		 direct
derivative_initial_value 0..1
xsd:float		 Initial value for the first time derivative, used when equation_order > 1 direct
distribution 0..1
Distribution		 Distribution for sampling initial conditions per node direct
history 0..1
TimeSeries		 direct

Usages

used by used in type used
Observation source range StateVariable
DerivedObservation source range StateVariable
Dynamics state_variables range StateVariable
Noise targets range StateVariable
TuningObjective target_variable range StateVariable
Coupling incoming_states range StateVariable
Coupling local_states range StateVariable

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: StateVariable
from_schema: https://w3id.org/tvbo
slots:
- name
- symbol
- label
- definition
- domain
- description
- equation
- unit
attributes:
  variable_of_interest:
    name: variable_of_interest
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: 'True'
    domain_of:
    - StateVariable
    range: boolean
  coupling_variable:
    name: coupling_variable
    description: Whether this state variable is transmitted to connected nodes through
      the coupling function. In TVB terms, this determines the cvar indices (state
      variables extracted from history and fed into the coupling function). The coupling
      function may override this via its incoming_states attribute.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: 'False'
    domain_of:
    - StateVariable
    range: boolean
  equation_type:
    name: equation_type
    description: 'Type of equation: ''differential'' (default) means dx/dt = rhs,
      ''algebraic'' means 0 = rhs or x ~ rhs (DAE constraint). Algebraic equations
      are used by ModelingToolkit.jl backend.'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: string(differential)
    domain_of:
    - StateVariable
    range: string
  equation_order:
    name: equation_order
    description: Order of the time derivative on the LHS. Default 1 means dx/dt =
      rhs (first-order ODE). Order 2 means d²x/dt² = rhs (second-order ODE), etc.
      Higher-order ODEs are automatically lowered to coupled first-order systems by
      backends like ModelingToolkit.jl via mtkcompile.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: int(1)
    domain_of:
    - StateVariable
    range: integer
  noise:
    name: noise
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - StateVariable
    - Integrator
    range: Noise
    inlined: true
  stimulation_variable:
    name: stimulation_variable
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - StateVariable
    range: boolean
  boundaries:
    name: boundaries
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - StateVariable
    range: Range
    inlined: true
  initial_value:
    name: initial_value
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: float(0.1)
    domain_of:
    - StateVariable
    - SpatialField
    range: float
  derivative_initial_value:
    name: derivative_initial_value
    description: Initial value for the first time derivative, used when equation_order
      > 1. For a second-order ODE d²x/dt² = f, this sets dx/dt(0). Required by ModelingToolkit.jl
      to fully specify higher-order initial value problems.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - StateVariable
    range: float
  distribution:
    name: distribution
    description: Distribution for sampling initial conditions per node. If present,
      initial_value is used as fallback/mean.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - StateVariable
    - Parameter
    - Coupling
    range: Distribution
    inlined: true
  history:
    name: history
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - StateVariable
    range: TimeSeries
    inlined: true
class_uri: tvbo:StateVariable

Induced

name: StateVariable
from_schema: https://w3id.org/tvbo
attributes:
  variable_of_interest:
    name: variable_of_interest
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: 'True'
    alias: variable_of_interest
    owner: StateVariable
    domain_of:
    - StateVariable
    range: boolean
  coupling_variable:
    name: coupling_variable
    description: Whether this state variable is transmitted to connected nodes through
      the coupling function. In TVB terms, this determines the cvar indices (state
      variables extracted from history and fed into the coupling function). The coupling
      function may override this via its incoming_states attribute.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: 'False'
    alias: coupling_variable
    owner: StateVariable
    domain_of:
    - StateVariable
    range: boolean
  equation_type:
    name: equation_type
    description: 'Type of equation: ''differential'' (default) means dx/dt = rhs,
      ''algebraic'' means 0 = rhs or x ~ rhs (DAE constraint). Algebraic equations
      are used by ModelingToolkit.jl backend.'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: string(differential)
    alias: equation_type
    owner: StateVariable
    domain_of:
    - StateVariable
    range: string
  equation_order:
    name: equation_order
    description: Order of the time derivative on the LHS. Default 1 means dx/dt =
      rhs (first-order ODE). Order 2 means d²x/dt² = rhs (second-order ODE), etc.
      Higher-order ODEs are automatically lowered to coupled first-order systems by
      backends like ModelingToolkit.jl via mtkcompile.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: int(1)
    alias: equation_order
    owner: StateVariable
    domain_of:
    - StateVariable
    range: integer
  noise:
    name: noise
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: noise
    owner: StateVariable
    domain_of:
    - StateVariable
    - Integrator
    range: Noise
    inlined: true
  stimulation_variable:
    name: stimulation_variable
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: stimulation_variable
    owner: StateVariable
    domain_of:
    - StateVariable
    range: boolean
  boundaries:
    name: boundaries
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: boundaries
    owner: StateVariable
    domain_of:
    - StateVariable
    range: Range
    inlined: true
  initial_value:
    name: initial_value
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: float(0.1)
    alias: initial_value
    owner: StateVariable
    domain_of:
    - StateVariable
    - SpatialField
    range: float
  derivative_initial_value:
    name: derivative_initial_value
    description: Initial value for the first time derivative, used when equation_order
      > 1. For a second-order ODE d²x/dt² = f, this sets dx/dt(0). Required by ModelingToolkit.jl
      to fully specify higher-order initial value problems.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: derivative_initial_value
    owner: StateVariable
    domain_of:
    - StateVariable
    range: float
  distribution:
    name: distribution
    description: Distribution for sampling initial conditions per node. If present,
      initial_value is used as fallback/mean.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: distribution
    owner: StateVariable
    domain_of:
    - StateVariable
    - Parameter
    - Coupling
    range: Distribution
    inlined: true
  history:
    name: history
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: history
    owner: StateVariable
    domain_of:
    - StateVariable
    range: TimeSeries
    inlined: true
  name:
    name: name
    from_schema: https://w3id.org/tvbo
    rank: 1000
    key: true
    alias: name
    owner: StateVariable
    domain_of:
    - BrainAtlas
    - CommonCoordinateSpace
    - ParcellationEntity
    - DBSProtocol
    - ClinicalScale
    - ClinicalScore
    - Event
    - Tractogram
    - GraphGenerator
    - File
    - StateValue
    - Observation
    - Dynamics
    - StateVariable
    - Distribution
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - FunctionCall
    - Callable
    - DerivedParameter
    - DerivedVariable
    - DataSource
    - OptimizationStage
    - Exploration
    - UpdateRule
    - Algorithm
    - Option
    - BranchSwitch
    - Continuation
    - Coupling
    - SoftwareEnvironment
    - SoftwareRequirement
    - SoftwarePackage
    range: string
    required: true
  symbol:
    name: symbol
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: symbol
    owner: StateVariable
    domain_of:
    - StateVariable
    - Parameter
    - DerivedParameter
    - DerivedVariable
    range: string
  label:
    name: label
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: label
    owner: StateVariable
    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
  definition:
    name: definition
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: definition
    owner: StateVariable
    domain_of:
    - Equation
    - StateVariable
    - Parameter
    - Function
    - DifferentialOperator
    range: string
  domain:
    name: domain
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: domain
    owner: StateVariable
    domain_of:
    - ClinicalScale
    - ClinicalScore
    - StateVariable
    - Distribution
    - Parameter
    - PDE
    range: Range
  description:
    name: description
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: description
    owner: StateVariable
    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
  equation:
    name: equation
    from_schema: https://w3id.org/tvbo
    rank: 1000
    slot_uri: tvbo:Equation
    alias: equation
    owner: StateVariable
    domain_of:
    - Stimulus
    - Event
    - Observation
    - StateVariable
    - Parameter
    - Function
    - FunctionCall
    - Case
    - DerivedParameter
    - DerivedVariable
    - Noise
    - UpdateRule
    - DifferentialOperator
    range: Equation
    inlined: true
  unit:
    name: unit
    description: Physical unit of measurement. Values are drawn from the QUDT ontology
      (http://qudt.org/vocab/unit/) with UO cross-references where available.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: unit
    owner: StateVariable
    domain_of:
    - CommonCoordinateSpace
    - Edge
    - StateVariable
    - Parameter
    - Argument
    - DerivedParameter
    - DerivedVariable
    - Integrator
    - TimeSeries
    - NDArray
    - SpatialField
    range: UnitEnum
class_uri: tvbo:StateVariable