Class: ClassReference

Reference to a class that can be instantiated and called. Used for external library classes (e.g., tvboptim.Bold, custom monitors). The class is instantiated with constructor_args, then called with call_args. Generalizable pattern: works for tvboptim, TVB, or any Python class.

URI: tvbo:class/ClassReference

 classDiagram
    class ClassReference
    click ClassReference href "./ClassReference.html"
      Callable <|-- ClassReference
        click Callable href "./Callable.html"
      
      ClassReference : call_args
        
          
    
        
        
        ClassReference --> "*" Argument : call_args
        click Argument href "./Argument.html"
    

        
      ClassReference : constructor_args
        
          
    
        
        
        ClassReference --> "*" Argument : constructor_args
        click Argument href "./Argument.html"
    

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

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

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

        
      ClassReference : software
        
          
    
        
        
        ClassReference --> "0..1" SoftwareRequirement : software
        click SoftwareRequirement href "./SoftwareRequirement.html"
    

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

        
      

Inheritance

• Callable
  • ClassReference

Slots

Name	Cardinality and Range	Description	Inheritance
constructor_args	* Argument	Arguments passed to init when instantiating the class	direct
call_args	* Argument	Arguments passed when calling the instance (call)	direct
warmup_source	0..1 xsd:string	Reference to transient simulation result for history initialization	direct
name	1 xsd:string		Callable
description	0..1 xsd:string		Callable
module	0..1 xsd:string		Callable
software	0..1 SoftwareRequirement		Callable

Usages

used by	used in	type	used
Observation	class_reference	range	ClassReference
DerivedObservation	class_reference	range	ClassReference
FunctionCall	class_call	range	ClassReference

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: ClassReference
description: 'Reference to a class that can be instantiated and called. Used for external
  library classes (e.g., tvboptim.Bold, custom monitors). The class is instantiated
  with constructor_args, then called with call_args. Generalizable pattern: works
  for tvboptim, TVB, or any Python class.'
from_schema: https://w3id.org/tvbo
is_a: Callable
attributes:
  constructor_args:
    name: constructor_args
    description: 'Arguments passed to __init__ when instantiating the class. Example:
      period=1000.0, downsample_period=4.0 for Bold monitor.'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - ClassReference
    range: Argument
    multivalued: true
    inlined: true
    inlined_as_list: true
  call_args:
    name: call_args
    description: 'Arguments passed when calling the instance (__call__). Usually the
      input data from simulation result. Example: result (simulation output array).'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - ClassReference
    range: Argument
    multivalued: true
    inlined: true
    inlined_as_list: true
  warmup_source:
    name: warmup_source
    description: Reference to transient simulation result for history initialization.
      Some monitors (e.g., Bold) require history from warmup simulation. Value should
      reference a simulation result name (e.g., 'result_init').
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Observation
    - ClassReference
    range: string

Induced

name: ClassReference
description: 'Reference to a class that can be instantiated and called. Used for external
  library classes (e.g., tvboptim.Bold, custom monitors). The class is instantiated
  with constructor_args, then called with call_args. Generalizable pattern: works
  for tvboptim, TVB, or any Python class.'
from_schema: https://w3id.org/tvbo
is_a: Callable
attributes:
  constructor_args:
    name: constructor_args
    description: 'Arguments passed to __init__ when instantiating the class. Example:
      period=1000.0, downsample_period=4.0 for Bold monitor.'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: constructor_args
    owner: ClassReference
    domain_of:
    - ClassReference
    range: Argument
    multivalued: true
    inlined: true
    inlined_as_list: true
  call_args:
    name: call_args
    description: 'Arguments passed when calling the instance (__call__). Usually the
      input data from simulation result. Example: result (simulation output array).'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: call_args
    owner: ClassReference
    domain_of:
    - ClassReference
    range: Argument
    multivalued: true
    inlined: true
    inlined_as_list: true
  warmup_source:
    name: warmup_source
    description: Reference to transient simulation result for history initialization.
      Some monitors (e.g., Bold) require history from warmup simulation. Value should
      reference a simulation result name (e.g., 'result_init').
    from_schema: https://w3id.org/tvbo
    alias: warmup_source
    owner: ClassReference
    domain_of:
    - Observation
    - ClassReference
    range: string
  name:
    name: name
    from_schema: https://w3id.org/tvbo
    rank: 1000
    key: true
    alias: name
    owner: ClassReference
    domain_of:
    - BrainAtlas
    - CommonCoordinateSpace
    - ParcellationEntity
    - DBSProtocol
    - ClinicalScale
    - ClinicalScore
    - Tractogram
    - File
    - Observation
    - Dynamics
    - StateVariable
    - Distribution
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - Callable
    - DerivedParameter
    - DerivedVariable
    - DataSource
    - OptimizationStage
    - Exploration
    - UpdateRule
    - Algorithm
    - Coupling
    - SoftwareEnvironment
    - SoftwareRequirement
    - SoftwarePackage
    range: string
    required: true
  description:
    name: description
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: description
    owner: ClassReference
    domain_of:
    - ClinicalScore
    - Equation
    - Stimulus
    - Tractogram
    - Matrix
    - Network
    - File
    - Node
    - Edge
    - Observation
    - Dynamics
    - StateVariable
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - Callable
    - DerivedParameter
    - DerivedVariable
    - RandomStream
    - DataSource
    - OptimizationStage
    - Exploration
    - UpdateRule
    - TuningObjective
    - Algorithm
    - Integrator
    - Coupling
    - RegionMapping
    - SimulationExperiment
    - SimulationStudy
    - TimeSeries
    - SoftwareEnvironment
    - SoftwareRequirement
    - SoftwarePackage
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - BoundaryCondition
    - PDESolver
    - PDE
    range: string
  module:
    name: module
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: module
    owner: ClassReference
    domain_of:
    - Callable
    range: string
  software:
    name: software
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: software
    owner: ClassReference
    domain_of:
    - Callable
    - SimulationExperiment
    range: SoftwareRequirement
    inlined: true