sciope.utilities.distancefunctions package

Submodules

sciope.utilities.distancefunctions.distance_base module

Distance functions base class

class sciope.utilities.distancefunctions.distance_base.DistanceBase(name, use_logger=False)

Bases: object

Base class for creating distance functions used by parameter inference algorithms. Must not be used directly! Each distance function type must implement the methods described herein:

• DistanceBase.compute()

abstract compute(data, sim)

Sub-classable method for calculating distances between fixed and simulated data. Each derived class must implement.

data[type]

[description]

sim[type]

[description]

sciope.utilities.distancefunctions.euclidean module

The Euclidean distance function

class sciope.utilities.distancefunctions.euclidean.EuclideanDistance(use_logger=False)

Bases: sciope.utilities.distancefunctions.distance_base.DistanceBase

Calculates Euclidean distance between two given datasets

• DistanceBase.compute()

compute(data, sim)

Summary

data[type]

[description]

sim[type]

[description]

[type]

[description]

sciope.utilities.distancefunctions.manhattan module

The Manhattan distance function

class sciope.utilities.distancefunctions.manhattan.ManhattanDistance(use_logger=False)

Bases: sciope.utilities.distancefunctions.distance_base.DistanceBase

Calculates Manhattan distance between two given datasets

• DistanceBase.compute()

compute(data, sim)

[summary]

data[type]

[description]

sim[type]

[description]

[type]

the cityblock distance calculated using scipy

sciope.utilities.distancefunctions.naive_squared module

The naive squared function: (a-b ** 2)

class sciope.utilities.distancefunctions.naive_squared.NaiveSquaredDistance(use_logger=False)

Bases: sciope.utilities.distancefunctions.distance_base.DistanceBase

Calculates squared element-wise distance between two given datasets

• DistanceBase.compute()

compute(data, sim)

[summary]

data[type]

[description]

sim[type]

[description]

[type]

the squared element-wise distance

Module contents