Class: Surrogate

A permutation-significance test: re-evaluate a named statistic under n_perm fixed permutations of a field and report the per-element exceedance p-value. General (any permutation null — spatial nulls, FC significance, wave detection, …). Codegen emits (vmap(lambda p: stat(field[p]))(perms) <cmp> stat(field)).mean(axis over perms); the wrapped statistic is an ordinary symbolic derived variable, so only the permutation fold is structural.

URI: tvbo:Surrogate

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

        
      Surrogate : family_wise
        
          
    
        
        
        Surrogate --> "0..1" Boolean : family_wise
        click Boolean href "../http://www.w3.org/2001/XMLSchema#boolean.html"
    

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

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

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

Class Properties

Property	Value
Class URI	tvbo:Surrogate

Slots

Name	Cardinality and Range	Description	Inheritance
statistic	1 xsd:string	Name of the derived variable to re-evaluate under permutation	direct
permute	1 xsd:string	The symbol whose entries are permuted (the observation source, or a parameter…	direct
permutations	1 xsd:string	Name of the observer parameter holding the fixed `(n_perm, n)` permutation-…	direct
direction	0..1 xsd:string	Exceedance direction: `greater_equal` (fraction of permutations whose stati…	direct
family_wise	0..1 xsd:boolean	Apply a Westfall–Young family-wise (max-T) correction: collapse the permuted …	direct

Usages

used by	used in	type	used
DerivedVariable	surrogate	range	Surrogate

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Surrogate
description: 'A permutation-significance test: re-evaluate a named statistic under
  n_perm fixed permutations of a field and report the per-element exceedance p-value.
  General (any permutation null — spatial nulls, FC significance, wave detection,
  …). Codegen emits ``(vmap(lambda p: stat(field[p]))(perms) <cmp> stat(field)).mean(axis
  over perms)``; the wrapped statistic is an ordinary symbolic derived variable, so
  only the permutation fold is structural.'
from_schema: https://w3id.org/tvbo
attributes:
  statistic:
    name: statistic
    description: Name of the derived variable to re-evaluate under permutation.
    from_schema: https://w3id.org/tvbo
    domain_of:
    - AxisReduction
    - Surrogate
    range: string
    required: true
  permute:
    name: permute
    description: The symbol whose entries are permuted (the observation source, or
      a parameter such as an in-strength vector).
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Surrogate
    range: string
    required: true
  permutations:
    name: permutations
    description: Name of the observer parameter holding the fixed ``(n_perm, n)``
      permutation- index array (a produced/sourced constant, reused across the window
      and grid).
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - Surrogate
    range: string
    required: true
  direction:
    name: direction
    description: 'Exceedance direction: ``greater_equal`` (fraction of permutations
      whose statistic ≥ the observed) or ``less_equal`` (one-sided negative test).'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: string(greater_equal)
    domain_of:
    - Surrogate
    range: string
  family_wise:
    name: family_wise
    description: 'Apply a Westfall–Young family-wise (max-T) correction: collapse
      the permuted statistic to its extremum over the element axes, forming one family-wise
      null per permutation that every observed element is tested against. The extremum
      follows ``direction`` (``greater_equal`` → maximum, ``less_equal`` → minimum).
      Absent → the symmetric per-element test.'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: 'False'
    domain_of:
    - Surrogate
    range: boolean
class_uri: tvbo:Surrogate

Induced

name: Surrogate
description: 'A permutation-significance test: re-evaluate a named statistic under
  n_perm fixed permutations of a field and report the per-element exceedance p-value.
  General (any permutation null — spatial nulls, FC significance, wave detection,
  …). Codegen emits ``(vmap(lambda p: stat(field[p]))(perms) <cmp> stat(field)).mean(axis
  over perms)``; the wrapped statistic is an ordinary symbolic derived variable, so
  only the permutation fold is structural.'
from_schema: https://w3id.org/tvbo
attributes:
  statistic:
    name: statistic
    description: Name of the derived variable to re-evaluate under permutation.
    from_schema: https://w3id.org/tvbo
    owner: Surrogate
    domain_of:
    - AxisReduction
    - Surrogate
    range: string
    required: true
  permute:
    name: permute
    description: The symbol whose entries are permuted (the observation source, or
      a parameter such as an in-strength vector).
    from_schema: https://w3id.org/tvbo
    rank: 1000
    owner: Surrogate
    domain_of:
    - Surrogate
    range: string
    required: true
  permutations:
    name: permutations
    description: Name of the observer parameter holding the fixed ``(n_perm, n)``
      permutation- index array (a produced/sourced constant, reused across the window
      and grid).
    from_schema: https://w3id.org/tvbo
    rank: 1000
    owner: Surrogate
    domain_of:
    - Surrogate
    range: string
    required: true
  direction:
    name: direction
    description: 'Exceedance direction: ``greater_equal`` (fraction of permutations
      whose statistic ≥ the observed) or ``less_equal`` (one-sided negative test).'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: string(greater_equal)
    owner: Surrogate
    domain_of:
    - Surrogate
    range: string
  family_wise:
    name: family_wise
    description: 'Apply a Westfall–Young family-wise (max-T) correction: collapse
      the permuted statistic to its extremum over the element axes, forming one family-wise
      null per permutation that every observed element is tested against. The extremum
      follows ``direction`` (``greater_equal`` → maximum, ``less_equal`` → minimum).
      Absent → the symmetric per-element test.'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: 'False'
    owner: Surrogate
    domain_of:
    - Surrogate
    range: boolean
class_uri: tvbo:Surrogate