Class: Function

A function with explicit input → transformation → output flow. Can be equation-based (symbolic) or software-based (callable). In a pipeline, functions are chained: output of one becomes input of next.

URI: tvbo:Function

 classDiagram
    class Function
    click Function href "./Function.html"
      Function <|-- LossFunction
        click LossFunction href "./LossFunction.html"
      
      Function : acronym
        
          
    
        
        
        Function --> "0..1" String : acronym
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      Function : aggregate
        
          
    
        
        
        Function --> "0..1" Aggregation : aggregate
        click Aggregation href "./Aggregation.html"
    

        
      Function : apply_on_dimension
        
          
    
        
        
        Function --> "0..1" DimensionType : apply_on_dimension
        click DimensionType href "../../enums/DimensionType.html"
    

        
      Function : arguments
        
          
    
        
        
        Function --> "*" Argument : arguments
        click Argument href "./Argument.html"
    

        
      Function : callable
        
          
    
        
        
        Function --> "0..1" Callable : callable
        click Callable href "./Callable.html"
    

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

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

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

        
      Function : input
        
          
    
        
        
        Function --> "0..1" Function : input
        click Function href "./Function.html"
    

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

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

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

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

        
      Function : output_equation
        
          
    
        
        
        Function --> "0..1" Equation : output_equation
        click Equation href "./Equation.html"
    

        
      Function : requirements
        
          
    
        
        
        Function --> "*" SoftwareRequirement : requirements
        click SoftwareRequirement href "./SoftwareRequirement.html"
    

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

        
      Function : time_range
        
          
    
        
        
        Function --> "0..1" Range : time_range
        click Range href "./Range.html"
    

        
      

Inheritance

• Function
  • LossFunction

Slots

Name	Cardinality and Range	Description	Inheritance
name	1 xsd:string		direct
acronym	0..1 xsd:string		direct
label	0..1 xsd:string		direct
equation	0..1 Equation		direct
definition	0..1 xsd:string		direct
description	0..1 xsd:string		direct
requirements	* SoftwareRequirement		direct
input	0..1 Function	Simple input reference: name of previous function’s output in pipeline	direct
output	0..1 xsd:string	Name for this function’s output (referenced by subsequent functions)	direct
iri	0..1 xsd:string		direct
arguments	* Argument	Parameters/arguments for the function	direct
output_equation	0..1 Equation	Output transformation equation (if equation-based)	direct
source_code	0..1 xsd:string		direct
callable	0..1 Callable	Software implementation reference (if software-based)	direct
apply_on_dimension	0..1 DimensionType	Which dimension to apply the transformation on	direct
aggregate	0..1 Aggregation	How to aggregate the result across dimensions	direct
time_range	0..1 Range	Time range for generated TimeSeries (for kernel generators)	direct

Usages

used by	used in	type	used
Dynamics	functions	range	Function
Function	input	range	Function
LossFunction	input	range	Function
FunctionCall	function	range	Function
Noise	function	range	Function
DataSource	preprocessing	range	Function
Coupling	aggregation	any_of[range]	Function
Coupling	distribution	any_of[range]	Function
SimulationExperiment	functions	range	Function
PDE	functions	range	Function

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Function
description: 'A function with explicit input → transformation → output flow. Can be
  equation-based (symbolic) or software-based (callable). In a pipeline, functions
  are chained: output of one becomes input of next.'
from_schema: https://w3id.org/tvbo
slots:
- name
- acronym
- label
- equation
- definition
- description
- requirements
attributes:
  input:
    name: input
    description: 'Simple input reference: name of previous function''s output in pipeline.
      For multi-argument functions, use arguments with value references instead.'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Function
    range: Function
    inlined: false
  output:
    name: output
    description: Name for this function's output (referenced by subsequent functions)
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Dynamics
    - Function
    - FunctionCall
    range: string
  iri:
    name: iri
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Dynamics
    - Function
    range: string
  arguments:
    name: arguments
    description: Parameters/arguments for the function
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Function
    - FunctionCall
    - AlgorithmInclude
    range: Argument
    multivalued: true
    inlined: true
    inlined_as_list: true
  output_equation:
    name: output_equation
    description: Output transformation equation (if equation-based)
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Function
    range: Equation
    inlined: true
  source_code:
    name: source_code
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Function
    range: string
  callable:
    name: callable
    description: Software implementation reference (if software-based)
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Function
    - FunctionCall
    range: Callable
    inlined: true
  apply_on_dimension:
    name: apply_on_dimension
    description: Which dimension to apply the transformation on
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Function
    - FunctionCall
    range: DimensionType
  aggregate:
    name: aggregate
    description: How to aggregate the result across dimensions. E.g., aggregate.over=node
      computes per-row (per-node) with keepdims. The type field controls whether to
      reduce (mean/sum) or keep dimensions (none).
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Function
    - LossFunction
    - FunctionCall
    range: Aggregation
    inlined: true
  time_range:
    name: time_range
    description: Time range for generated TimeSeries (for kernel generators). Equation
      is evaluated at each time point.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Function
    range: Range
    inlined: true
class_uri: tvbo:Function

Induced

name: Function
description: 'A function with explicit input → transformation → output flow. Can be
  equation-based (symbolic) or software-based (callable). In a pipeline, functions
  are chained: output of one becomes input of next.'
from_schema: https://w3id.org/tvbo
attributes:
  input:
    name: input
    description: 'Simple input reference: name of previous function''s output in pipeline.
      For multi-argument functions, use arguments with value references instead.'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: input
    owner: Function
    domain_of:
    - Function
    range: Function
    inlined: false
  output:
    name: output
    description: Name for this function's output (referenced by subsequent functions)
    from_schema: https://w3id.org/tvbo
    alias: output
    owner: Function
    domain_of:
    - Dynamics
    - Function
    - FunctionCall
    range: string
  iri:
    name: iri
    from_schema: https://w3id.org/tvbo
    alias: iri
    owner: Function
    domain_of:
    - Dynamics
    - Function
    range: string
  arguments:
    name: arguments
    description: Parameters/arguments for the function
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: arguments
    owner: Function
    domain_of:
    - Function
    - FunctionCall
    - AlgorithmInclude
    range: Argument
    multivalued: true
    inlined: true
    inlined_as_list: true
  output_equation:
    name: output_equation
    description: Output transformation equation (if equation-based)
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: output_equation
    owner: Function
    domain_of:
    - Function
    range: Equation
    inlined: true
  source_code:
    name: source_code
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: source_code
    owner: Function
    domain_of:
    - Function
    range: string
  callable:
    name: callable
    description: Software implementation reference (if software-based)
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: callable
    owner: Function
    domain_of:
    - Function
    - FunctionCall
    range: Callable
    inlined: true
  apply_on_dimension:
    name: apply_on_dimension
    description: Which dimension to apply the transformation on
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: apply_on_dimension
    owner: Function
    domain_of:
    - Function
    - FunctionCall
    range: DimensionType
  aggregate:
    name: aggregate
    description: How to aggregate the result across dimensions. E.g., aggregate.over=node
      computes per-row (per-node) with keepdims. The type field controls whether to
      reduce (mean/sum) or keep dimensions (none).
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: aggregate
    owner: Function
    domain_of:
    - Function
    - LossFunction
    - FunctionCall
    range: Aggregation
    inlined: true
  time_range:
    name: time_range
    description: Time range for generated TimeSeries (for kernel generators). Equation
      is evaluated at each time point.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: time_range
    owner: Function
    domain_of:
    - Function
    range: Range
    inlined: true
  name:
    name: name
    from_schema: https://w3id.org/tvbo
    rank: 1000
    key: true
    alias: name
    owner: Function
    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
  acronym:
    name: acronym
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: acronym
    owner: Function
    domain_of:
    - ClinicalScale
    - ClinicalScore
    - Observation
    - Function
    range: string
  label:
    name: label
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: label
    owner: Function
    domain_of:
    - ParcellationTerminology
    - Dataset
    - Contact
    - Equation
    - Stimulus
    - Parcellation
    - Tractogram
    - Matrix
    - Network
    - Node
    - Edge
    - Observation
    - Dynamics
    - StateVariable
    - Parameter
    - Function
    - DerivedVariable
    - RandomStream
    - DataSource
    - OptimizationStage
    - Exploration
    - TuningObjective
    - Coupling
    - RegionMapping
    - SimulationExperiment
    - SimulationStudy
    - TimeSeries
    - SoftwareEnvironment
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - DifferentialOperator
    - BoundaryCondition
    - PDESolver
    - PDE
    range: string
  equation:
    name: equation
    from_schema: https://w3id.org/tvbo
    rank: 1000
    slot_uri: tvbo:Equation
    alias: equation
    owner: Function
    domain_of:
    - Stimulus
    - Observation
    - StateVariable
    - Distribution
    - Parameter
    - Function
    - Case
    - DerivedParameter
    - DerivedVariable
    - Noise
    - UpdateRule
    - DifferentialOperator
    range: Equation
    inlined: true
  definition:
    name: definition
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: definition
    owner: Function
    domain_of:
    - Equation
    - StateVariable
    - Parameter
    - Function
    - DifferentialOperator
    range: string
  description:
    name: description
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: description
    owner: Function
    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
  requirements:
    name: requirements
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: requirements
    owner: Function
    domain_of:
    - Function
    - SoftwareEnvironment
    - PDESolver
    range: SoftwareRequirement
    multivalued: true
class_uri: tvbo:Function