Trait nblast::QueryNeuron

source ·
pub trait QueryNeuron: Neuron {
    // Required methods
    fn query_dist_dots(
        &self,
        target: &impl TargetNeuron,
        use_alpha: bool
    ) -> Vec<DistDot>;
    fn self_hit(&self, score_calc: &ScoreCalc, use_alpha: bool) -> Precision;

    // Provided method
    fn query(
        &self,
        target: &impl TargetNeuron,
        use_alpha: bool,
        score_calc: &ScoreCalc
    ) -> Precision { ... }
}
Expand description

Trait for objects which can be used as queries (not necessarily as targets) with NBLAST. See TargetNeuron.

Required Methods§

source

fn query_dist_dots( &self, target: &impl TargetNeuron, use_alpha: bool ) -> Vec<DistDot>

Calculate the distance and (alpha-scaled) absolute dot products for point matches between this and a target neuron.

source

fn self_hit(&self, score_calc: &ScoreCalc, use_alpha: bool) -> Precision

The raw NBLAST score if this neuron was compared with itself using the given score function. Used for normalisation.

Provided Methods§

source

fn query( &self, target: &impl TargetNeuron, use_alpha: bool, score_calc: &ScoreCalc ) -> Precision

Calculate the raw NBLAST score by comparing this neuron to the given target neuron, using the given score function. The score function is applied to each point match distance and summed.

Implementors§