Class SignPolicy

Namespace

DotFly.Core.Models

Assembly

DotFly.Core.dll

Maps a neurotransmitter label to the sign of the presynaptic neuron's outgoing weights. The policy is applied once by the checkpoint builder and recorded in the checkpoint's provenance; kernels only ever see signed contact counts.

public sealed record SignPolicy : IEquatable<SignPolicy>

Inheritance

object

SignPolicy

Implements

IEquatable<SignPolicy>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Name

Human-readable name recorded in checkpoint provenance.

public string Name { get; }

Property Value

string

Shiu2024

Shiu et al. 2024 convention: acetylcholine +1; GABA and glutamate −1; dopamine, octopamine and serotonin +1. The FlyWire v630/v783 inputs ship the signed column precomputed, so this policy is documentary for those files; for MaleCNS histamine and unknown labels are neutral (0), matching the Xenova MaleCNS configuration.

public static SignPolicy Shiu2024 { get; }

Property Value

SignPolicy

Methods

Custom(string, ReadOnlySpan<sbyte>)

Creates a custom policy; the array is indexed by Neurotransmitter.

public static SignPolicy Custom(string name, ReadOnlySpan<sbyte> signs)

Parameters

name string

signs ReadOnlySpan<sbyte>

Returns

SignPolicy

Exceptions

ArgumentException

Wrong length or a sign outside {−1, 0, +1}.

Sign(Neurotransmitter)

Returns +1, −1 or 0 for the given transmitter.

public int Sign(Neurotransmitter nt)

Parameters

nt Neurotransmitter

Returns

int