API

The following classes and functions can be directly loaded from SOMptimised

• SOM

• LinearLearningStrategy

• ExponentialLearningStrategy

• LearningStrategy

• ConstantRadiusStrategy

• ExponentialRadiusStrategy

• NeighbourhoodStrategy

• euclidianMetric()

• chi2Metric()

• chi2MetricPenalised()

• chi2CigaleMetric()

• chi2CigaleMetricPenalised()

For instance, one can do

from SOMptimised import SOM
from SOMptimised import LinearLearningStrategy, ExponentialLearningStrategy, LearningStrategy
from SOMptimised import ConstantRadiusStrategy, ExponentialRadiusStrategy, NeighbourhoodStrategy
from SOMptimised import euclidianMetric, chi2Metric, chi2CigaleMetric, chi2MetricPenalised, chi2CigaleMetricPenalised

• Learning strategy submodule
  • How to include a custom learning strategy ?
  • API
• Metric submodule
  • How to include a custom metric ?
  • A note on normalisation
  • API
• Neighbourhood strategy submodule
  • How to implement a custom neighbourhood class ?
  • API
• API for the main som module