Class: Reference

A small typed pointer to another TVBO entity (Network, Mesh, Observation, …). The iri identifies the target via the registry; the optional field is a dotted-path subkey resolved by attribute walk on the loaded target (e.g. field: 'weight_alpha' picks the weight_alpha named edge matrix on a Network; field: 'mesh.faces' picks the mesh face array). Used uniformly anywhere a TVBO entity needs to point at a sub-array of another entity without inlining the data.

URI: tvbo:Reference

 classDiagram
    class Reference
    click Reference href "./Reference.html"
      Reference : field
        
          
    
        
        
        Reference --> "0..1" String : field
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      Reference : iri
        
          
    
        
        
        Reference --> "1" Uriorcurie : iri
        click Uriorcurie href "../http://www.w3.org/2001/XMLSchema#anyURI.html"
    

        
      

Class Properties

Property	Value
Class URI	tvbo:Reference

Slots

Name	Cardinality and Range	Description	Inheritance
iri	1 xsd:anyURI	CURIE or full IRI of the referenced TVBO entity	direct
field	0..1 xsd:string	Optional dotted-path subkey into the referenced entity (e	direct

Usages

used by	used in	type	used
Observation	aux_data	range	Reference

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Reference
description: 'A small typed pointer to another TVBO entity (Network, Mesh, Observation,
  …). The ``iri`` identifies the target via the registry; the optional ``field`` is
  a dotted-path subkey resolved by attribute walk on the loaded target (e.g. ``field:
  ''weight_alpha''`` picks the ``weight_alpha`` named edge matrix on a Network; ``field:
  ''mesh.faces''`` picks the mesh face array). Used uniformly anywhere a TVBO entity
  needs to point at a sub-array of another entity without inlining the data.'
from_schema: https://w3id.org/tvbo
attributes:
  iri:
    name: iri
    description: CURIE or full IRI of the referenced TVBO entity.
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Parcellation
    - Tractogram
    - ReferenceFingerprint
    - GraphGenerator
    - Reference
    - Dynamics
    - Function
    - Coupling
    range: uriorcurie
    required: true
  field:
    name: field
    description: Optional dotted-path subkey into the referenced entity (e.g. ``weight_alpha``
      for a Network's named edge matrix, ``mesh.faces`` for the face array, or ``nodes.ef_alpha``
      for a per-node scalar field). Resolved by attribute walk at load time.
    from_schema: https://w3id.org/tvbo
    domain_of:
    - ReferenceFingerprint
    - Reference
    range: string
class_uri: tvbo:Reference

Induced

name: Reference
description: 'A small typed pointer to another TVBO entity (Network, Mesh, Observation,
  …). The ``iri`` identifies the target via the registry; the optional ``field`` is
  a dotted-path subkey resolved by attribute walk on the loaded target (e.g. ``field:
  ''weight_alpha''`` picks the ``weight_alpha`` named edge matrix on a Network; ``field:
  ''mesh.faces''`` picks the mesh face array). Used uniformly anywhere a TVBO entity
  needs to point at a sub-array of another entity without inlining the data.'
from_schema: https://w3id.org/tvbo
attributes:
  iri:
    name: iri
    description: CURIE or full IRI of the referenced TVBO entity.
    from_schema: https://w3id.org/tvbo
    owner: Reference
    domain_of:
    - Parcellation
    - Tractogram
    - ReferenceFingerprint
    - GraphGenerator
    - Reference
    - Dynamics
    - Function
    - Coupling
    range: uriorcurie
    required: true
  field:
    name: field
    description: Optional dotted-path subkey into the referenced entity (e.g. ``weight_alpha``
      for a Network's named edge matrix, ``mesh.faces`` for the face array, or ``nodes.ef_alpha``
      for a per-node scalar field). Resolved by attribute walk at load time.
    from_schema: https://w3id.org/tvbo
    owner: Reference
    domain_of:
    - ReferenceFingerprint
    - Reference
    range: string
class_uri: tvbo:Reference