# Class: Stimulus 

<div data-search-exclude markdown="1">



URI: [tvbo:Stimulus](https://w3id.org/tvbo/Stimulus)





```{mermaid}
 classDiagram
    class Stimulus
    click Stimulus href "./Stimulus.html"
      Stimulus : dataLocation
        
          
    
        
        
        Stimulus --> "0..1" String : dataLocation
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

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

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

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

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

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

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

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

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

        
      
```




<!-- no inheritance hierarchy -->

## Class Properties

| Property | Value |
| --- | --- |
| Class URI | [tvbo:Stimulus](https://w3id.org/tvbo/Stimulus) |


## Slots

| Name | Cardinality and Range | Description | Inheritance |
| ---  | --- | --- | --- |
| [equation](../slots/equation.qmd) | 0..1 <br/> [Equation](../classes/Equation.qmd) |  | direct |
| [parameters](../slots/parameters.qmd) | * <br/> [Parameter](../classes/Parameter.qmd) |  | direct |
| [description](../slots/description.qmd) | 0..1 <br/> [xsd:string](http://www.w3.org/2001/XMLSchema#string) |  | direct |
| [dataLocation](../slots/dataLocation.qmd) | 0..1 <br/> [xsd:string](http://www.w3.org/2001/XMLSchema#string) | Add the location of the data file containing the parcellation terminology | direct |
| [duration](../slots/duration.qmd) | 0..1 <br/> [xsd:float](http://www.w3.org/2001/XMLSchema#float) |  | direct |
| [label](../slots/label.qmd) | 0..1 <br/> [xsd:string](http://www.w3.org/2001/XMLSchema#string) |  | direct |
| [regions](../slots/regions.qmd) | * <br/> [xsd:integer](http://www.w3.org/2001/XMLSchema#integer) |  | direct |
| [weighting](../slots/weighting.qmd) | * <br/> [xsd:float](http://www.w3.org/2001/XMLSchema#float) |  | direct |
| [noise](../slots/noise.qmd) | 0..1 <br/> [Noise](../classes/Noise.qmd) | Optional stochastic contribution to the stimulus | direct |





## Usages

| used by | used in | type | used |
| ---  | --- | --- | --- |
| [Dynamics](../classes/Dynamics.qmd) | [stimulus](../slots/stimulus.qmd) | range | [Stimulus](../classes/Stimulus.qmd) |
| [SimulationExperiment](../classes/SimulationExperiment.qmd) | [stimulation](../slots/stimulation.qmd) | range | [Stimulus](../classes/Stimulus.qmd) |












## Identifier and Mapping Information





### Schema Source


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




## Mappings

| Mapping Type | Mapped Value |
| ---  | ---  |
| self | tvbo:Stimulus |
| native | tvbo:Stimulus |






## LinkML Source

<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx -->

### Direct

<details>
```yaml
name: Stimulus
from_schema: https://w3id.org/tvbo
slots:
- equation
- parameters
- description
- dataLocation
- duration
- label
attributes:
  regions:
    name: regions
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Panel
    - Inset
    - Stimulus
    range: integer
    multivalued: true
  weighting:
    name: weighting
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Stimulus
    range: float
    multivalued: true
  noise:
    name: noise
    description: Optional stochastic contribution to the stimulus. Mirrors state_variables.noise
      on the Dynamics side. The stimulus value at each integration step is the sum
      of `equation`'s evaluation (deterministic, if set) and a draw from this Noise
      process. When only `noise` is set and `equation` is absent, the stimulus IS
      the noise (pure stochastic source — e.g. iid uniform driver for memory-capacity
      benchmarks; signal+noise paradigms for psychophysics).
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Stimulus
    - StateVariable
    - Integrator
    range: Noise
    required: false
    inlined: true
class_uri: tvbo:Stimulus

```
</details>

### Induced

<details>
```yaml
name: Stimulus
from_schema: https://w3id.org/tvbo
attributes:
  regions:
    name: regions
    from_schema: https://w3id.org/tvbo
    owner: Stimulus
    domain_of:
    - Panel
    - Inset
    - Stimulus
    range: integer
    multivalued: true
  weighting:
    name: weighting
    from_schema: https://w3id.org/tvbo
    rank: 1000
    owner: Stimulus
    domain_of:
    - Stimulus
    range: float
    multivalued: true
  noise:
    name: noise
    description: Optional stochastic contribution to the stimulus. Mirrors state_variables.noise
      on the Dynamics side. The stimulus value at each integration step is the sum
      of `equation`'s evaluation (deterministic, if set) and a draw from this Noise
      process. When only `noise` is set and `equation` is absent, the stimulus IS
      the noise (pure stochastic source — e.g. iid uniform driver for memory-capacity
      benchmarks; signal+noise paradigms for psychophysics).
    from_schema: https://w3id.org/tvbo
    rank: 1000
    owner: Stimulus
    domain_of:
    - Stimulus
    - StateVariable
    - Integrator
    range: Noise
    required: false
    inlined: true
  equation:
    name: equation
    from_schema: https://w3id.org/tvbo
    rank: 1000
    slot_uri: tvbo:Equation
    owner: Stimulus
    domain_of:
    - Stimulus
    - Event
    - ProcedureStep
    - Observation
    - StateVariable
    - Parameter
    - Function
    - FunctionCall
    - DerivedParameter
    - DerivedVariable
    - Noise
    - UpdateRule
    - DifferentialOperator
    - BoundaryCondition
    range: Equation
    inlined: true
  parameters:
    name: parameters
    from_schema: https://w3id.org/tvbo
    rank: 1000
    owner: Stimulus
    domain_of:
    - Equation
    - Stimulus
    - Event
    - ExperimentResultSidecar
    - 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: Stimulus
    domain_of:
    - CommonCoordinateSpace
    - Dataset
    - StudyLayout
    - StudyTemplate
    - StudyDirectory
    - StudyFile
    - ClinicalScore
    - SoftwarePackage
    - SoftwareRequirement
    - SoftwareEnvironment
    - Figure
    - Panel
    - Equation
    - Stimulus
    - Event
    - Tractogram
    - Matrix
    - ResultEntity
    - Activity
    - 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
    - ResultBinding
    - TimeSeries
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - BoundaryCondition
    - PDESolver
    - PDE
    - Reducer
    range: string
  dataLocation:
    name: dataLocation
    description: Add the location of the data file containing the parcellation terminology.
    from_schema: https://openminds.ebrains.eu/sands/BrainAtlas
    owner: Stimulus
    domain_of:
    - ParcellationTerminology
    - SoftwareRequirement
    - SoftwareEnvironment
    - Stimulus
    - Event
    - Matrix
    - Dynamics
    - RandomStream
    - RegionMapping
    - TimeSeries
    - NDArray
    - Mesh
    range: string
  duration:
    name: duration
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: float(1000)
    owner: Stimulus
    domain_of:
    - Stimulus
    - Event
    - InitialState
    - Integrator
    range: float
  label:
    name: label
    from_schema: https://w3id.org/tvbo
    rank: 1000
    slot_uri: rdfs:label
    owner: Stimulus
    domain_of:
    - ParcellationTerminology
    - Subject
    - Session
    - Dataset
    - Contact
    - SoftwareEnvironment
    - Figure
    - Panel
    - Inset
    - Layer
    - Colorbar
    - Rule
    - 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
class_uri: tvbo:Stimulus

```
</details></div>