Class: Event

A discrete or continuous event that modifies the system during simulation. Generalizes Stimulus: can represent external inputs (stimulus type), threshold-triggered state changes (continuous/discrete type), or time-scheduled interventions (preset_time type). Attaches to components (nodes/edges) or to the experiment level.

URI: tvbo:class/Event

 classDiagram
    class Event
    click Event href "./Event.html"
      Event : affect
        
          
    
        
        
        Event --> "0..1" Equation : affect
        click Equation href "./Equation.html"
    

        
      Event : affect_negative
        
          
    
        
        
        Event --> "0..1" Equation : affect_negative
        click Equation href "./Equation.html"
    

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

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

        
      Event : condition
        
          
    
        
        
        Event --> "0..1" Equation : condition
        click Equation href "./Equation.html"
    

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

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

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

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

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

        
      Event : event_type
        
          
    
        
        
        Event --> "0..1" EventType : event_type
        click EventType href "../../enums/EventType.html"
    

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

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

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

        
      Event : regions
        
          
    
        
        
        Event --> "*" Integer : regions
        click Integer href "../http://www.w3.org/2001/XMLSchema#integer.html"
    

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

        
      Event : trigger_times
        
          
    
        
        
        Event --> "*" Float : trigger_times
        click Float href "../http://www.w3.org/2001/XMLSchema#float.html"
    

        
      Event : weighting
        
          
    
        
        
        Event --> "*" Float : weighting
        click Float href "../http://www.w3.org/2001/XMLSchema#float.html"
    

        
      

Slots

Name	Cardinality and Range	Description	Inheritance
name	1 xsd:string		direct
label	0..1 xsd:string		direct
description	0..1 xsd:string		direct
parameters	* Parameter		direct
event_type	0..1 EventType	Type of event trigger mechanism	direct
condition	0..1 Equation	Condition function	direct
condition_states	* xsd:string	State variable symbols accessible in the condition function	direct
condition_parameters	* xsd:string	Parameter symbols accessible in the condition function	direct
affect	0..1 Equation	Affect function: what happens when the event triggers	direct
affect_states	* xsd:string	State variable symbols modifiable in the affect function	direct
affect_parameters	* xsd:string	Parameter symbols modifiable in the affect function	direct
affect_negative	0..1 Equation	Affect on downcrossing (continuous events only)	direct
trigger_times	* xsd:float	Predetermined trigger times for preset_time events	direct
target_component	0..1 xsd:string	Component to attach this event to	direct
equation	0..1 Equation	Stimulus equation for stimulus-type events	direct
regions	* xsd:integer	Target regions for stimulus-type events	direct
weighting	* xsd:float	Per-region weighting for stimulus-type events	direct
duration	0..1 xsd:float	Duration of stimulus-type events	direct

Usages

used by	used in	type	used
Node	events	range	Event
Edge	events	range	Event
Dynamics	events	range	Event
SimulationExperiment	events	range	Event

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Event
description: 'A discrete or continuous event that modifies the system during simulation.
  Generalizes Stimulus: can represent external inputs (stimulus type), threshold-triggered
  state changes (continuous/discrete type), or time-scheduled interventions (preset_time
  type). Attaches to components (nodes/edges) or to the experiment level.'
from_schema: https://w3id.org/tvbo
slots:
- name
- label
- description
- parameters
attributes:
  event_type:
    name: event_type
    description: Type of event trigger mechanism.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: stimulus
    domain_of:
    - Event
    range: EventType
  condition:
    name: condition
    description: 'Condition function. For continuous events: triggers when expression
      crosses zero. For discrete events: triggers when expression evaluates to true.
      Not used for preset_time or stimulus types.'
    from_schema: https://w3id.org/tvbo
    domain_of:
    - ConditionalBlock
    - Event
    - Case
    range: Equation
    inlined: true
  condition_states:
    name: condition_states
    description: State variable symbols accessible in the condition function. For
      edges, can include source/destination vertex outputs.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Event
    range: string
    multivalued: true
  condition_parameters:
    name: condition_parameters
    description: Parameter symbols accessible in the condition function.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Event
    range: string
    multivalued: true
  affect:
    name: affect
    description: 'Affect function: what happens when the event triggers. Can modify
      state variables and/or parameters. For stimulus type, this is the stimulus equation.'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Event
    range: Equation
    inlined: true
  affect_states:
    name: affect_states
    description: State variable symbols modifiable in the affect function.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Event
    range: string
    multivalued: true
  affect_parameters:
    name: affect_parameters
    description: Parameter symbols modifiable in the affect function.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Event
    range: string
    multivalued: true
  affect_negative:
    name: affect_negative
    description: Affect on downcrossing (continuous events only). If not specified,
      uses the same affect for both crossings.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Event
    range: Equation
    inlined: true
  trigger_times:
    name: trigger_times
    description: Predetermined trigger times for preset_time events. The solver will
      step exactly to these times.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Event
    range: float
    multivalued: true
  target_component:
    name: target_component
    description: Component to attach this event to. Can be a node label, edge label,
      or 'all_edges'/'all_vertices' for broadcast. If not specified, event is experiment-level.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Event
    range: string
  equation:
    name: equation
    description: Stimulus equation for stimulus-type events. Legacy compatibility
      with Stimulus class.
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Stimulus
    - Event
    - Observation
    - StateVariable
    - Parameter
    - Function
    - FunctionCall
    - Case
    - DerivedParameter
    - DerivedVariable
    - Noise
    - UpdateRule
    - DifferentialOperator
    range: Equation
    inlined: true
  regions:
    name: regions
    description: Target regions for stimulus-type events.
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Stimulus
    - Event
    range: integer
    multivalued: true
  weighting:
    name: weighting
    description: Per-region weighting for stimulus-type events.
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Stimulus
    - Event
    range: float
    multivalued: true
  duration:
    name: duration
    description: Duration of stimulus-type events.
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Stimulus
    - Event
    - InitialState
    - Integrator
    range: float

Induced

name: Event
description: 'A discrete or continuous event that modifies the system during simulation.
  Generalizes Stimulus: can represent external inputs (stimulus type), threshold-triggered
  state changes (continuous/discrete type), or time-scheduled interventions (preset_time
  type). Attaches to components (nodes/edges) or to the experiment level.'
from_schema: https://w3id.org/tvbo
attributes:
  event_type:
    name: event_type
    description: Type of event trigger mechanism.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: stimulus
    alias: event_type
    owner: Event
    domain_of:
    - Event
    range: EventType
  condition:
    name: condition
    description: 'Condition function. For continuous events: triggers when expression
      crosses zero. For discrete events: triggers when expression evaluates to true.
      Not used for preset_time or stimulus types.'
    from_schema: https://w3id.org/tvbo
    alias: condition
    owner: Event
    domain_of:
    - ConditionalBlock
    - Event
    - Case
    range: Equation
    inlined: true
  condition_states:
    name: condition_states
    description: State variable symbols accessible in the condition function. For
      edges, can include source/destination vertex outputs.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: condition_states
    owner: Event
    domain_of:
    - Event
    range: string
    multivalued: true
  condition_parameters:
    name: condition_parameters
    description: Parameter symbols accessible in the condition function.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: condition_parameters
    owner: Event
    domain_of:
    - Event
    range: string
    multivalued: true
  affect:
    name: affect
    description: 'Affect function: what happens when the event triggers. Can modify
      state variables and/or parameters. For stimulus type, this is the stimulus equation.'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: affect
    owner: Event
    domain_of:
    - Event
    range: Equation
    inlined: true
  affect_states:
    name: affect_states
    description: State variable symbols modifiable in the affect function.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: affect_states
    owner: Event
    domain_of:
    - Event
    range: string
    multivalued: true
  affect_parameters:
    name: affect_parameters
    description: Parameter symbols modifiable in the affect function.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: affect_parameters
    owner: Event
    domain_of:
    - Event
    range: string
    multivalued: true
  affect_negative:
    name: affect_negative
    description: Affect on downcrossing (continuous events only). If not specified,
      uses the same affect for both crossings.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: affect_negative
    owner: Event
    domain_of:
    - Event
    range: Equation
    inlined: true
  trigger_times:
    name: trigger_times
    description: Predetermined trigger times for preset_time events. The solver will
      step exactly to these times.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: trigger_times
    owner: Event
    domain_of:
    - Event
    range: float
    multivalued: true
  target_component:
    name: target_component
    description: Component to attach this event to. Can be a node label, edge label,
      or 'all_edges'/'all_vertices' for broadcast. If not specified, event is experiment-level.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: target_component
    owner: Event
    domain_of:
    - Event
    range: string
  equation:
    name: equation
    description: Stimulus equation for stimulus-type events. Legacy compatibility
      with Stimulus class.
    from_schema: https://w3id.org/tvbo
    alias: equation
    owner: Event
    domain_of:
    - Stimulus
    - Event
    - Observation
    - StateVariable
    - Parameter
    - Function
    - FunctionCall
    - Case
    - DerivedParameter
    - DerivedVariable
    - Noise
    - UpdateRule
    - DifferentialOperator
    range: Equation
    inlined: true
  regions:
    name: regions
    description: Target regions for stimulus-type events.
    from_schema: https://w3id.org/tvbo
    alias: regions
    owner: Event
    domain_of:
    - Stimulus
    - Event
    range: integer
    multivalued: true
  weighting:
    name: weighting
    description: Per-region weighting for stimulus-type events.
    from_schema: https://w3id.org/tvbo
    alias: weighting
    owner: Event
    domain_of:
    - Stimulus
    - Event
    range: float
    multivalued: true
  duration:
    name: duration
    description: Duration of stimulus-type events.
    from_schema: https://w3id.org/tvbo
    alias: duration
    owner: Event
    domain_of:
    - Stimulus
    - Event
    - InitialState
    - Integrator
    range: float
  name:
    name: name
    from_schema: https://w3id.org/tvbo
    rank: 1000
    key: true
    alias: name
    owner: Event
    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
  label:
    name: label
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: label
    owner: Event
    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: Event
    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: Event
    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