pymof 0.6.0

Mass ratio variance-based outlier factor (MOF)

pymof

Updated by Mr. Supakit Sroynam ([e-mail]) and Krung Sinapiromsaran ([e-mail])
Department of Mathematics and Computer Science, Faculty of Science, Chulalongkorn University
Version 0.2: 23 September 2024
Version 0.3: 9 October 2024
Version 0.4: 12 October 2024
Version 0.5: 8 January 2025 version 0.6: 27 November 2025

Mass-ratio-variance based outlier factor

Latest news

1. Implementing new methods in WMOF() for detecting anomaly in data stream.
2. Documents are editted with more methods.

Introduction

An outlier in a finite dataset is a data point that stands out from the rest. It is often isolaed, unliked normal data points, which tend to cluster together. To identify outliers, the Mass-ratio-variance based Outlier Factor (MOF) was developed and implemented. MOF works by calculating a score of each data point based on the density of itself with respect to other data points. Outliers always have fewer nearby data points so their mass-ratio (a density ratio if the same volumes are used) will be different from normal points. This MOF algorithm does not require any extra settings.

Citation

If you use this package in your research, please consider citing these two papers.

BibTex for the package:

@inproceedings{changsakul2021mass,
  title={Mass-ratio-variance based Outlier Factor},
  author={Changsakul, Phichapop and Boonsiri, Somjai and Sinapiromsaran, Krung},
  booktitle={2021 18th International Joint Conference on Computer Science and Software Engineering (JCSSE)},
  pages={1--5},
  year={2021},
  organization={IEEE}
}
@INPROCEEDINGS{10613697,
  author={Fan, Zehong and Luangsodsai, Arthorn and Sinapiromsaran, Krung},
  booktitle={2024 21st International Joint Conference on Computer Science and Software Engineering (JCSSE)}, 
  title={Mass-Ratio-Average-Absolute-Deviation Based Outlier Factor for Anomaly Scoring}, 
  year={2024},
  volume={},
  number={},
  pages={488-493},
  keywords={Industries;Software algorithms;Process control;Quality control;Nearest neighbor methods;Fraud;Computer security;Anomaly scoring;Statistical dispersion;Mass-ratio distribution;Local outlier factor;Mass-ratio variance outlier factor},
  doi={10.1109/JCSSE61278.2024.10613697}}

Installation

To install pymof, type the following command in the terminal

pip install pymof            # normal install
pip install --upgrade pymof  # or update if needed

Use on jupyter notebook

To make sure that the installed package can be called. A user must include the package path before import as

import sys
sys.path.append('/path/to/lib/python3.xx/site-packages')

Required Dependencies :

• Python 3.9 or higher
• numpy>=1.23
• numba>=0.56.0
• scipy>=1.8.0
• scikit-learn>=1.2.0
• matplotlib>=3.5

Documentation

---

Mass-ratio-variance based Outlier Factor (MOF)

The outlier score of each data point is calculated using the Mass-ratio-variance based Outlier Factor (MOF). MOF quantifies the global deviation of a data point's density relative to the rest of the dataset. This global perspective is crucial because an outlier's score depends on its overall isolation from all other data points. By analyzing the variance of the mass ratio, MOF can effectively identify data points with significantly lower density compared to their neighbors, indicating their outlier status.

MOF()

Initialize a model object MOF

    Parameters :
    Return :
            self : object
                    object of MOF model

MOF.fit(Data, Window = 10000, KeepMassRatio = True)

Fit data to MOF model

    Parameters :
            Data  : numpy array of shape (n_points, d_dimensions)
                    The input samples.
            Window : integer (int)
                    window size for calculation.
                    default window size is 10000.
            KeepMassRatio : boolean
                    All points' mass ratio are kept when an argument is True. 
                    Beware of exploding memory since calculation with window size = n.
                    Can be set to False for memory efficient.
                    default KeepMassRatio size is True.
    Return :
            self  : object
                    fitted estimator

MOF.visualize()

Visualize data points with MOF's scores
Note cannot visualize data points having a dimension greather than 3

    Parameters :
    Return :
            decision_scores_ : numpy array of shape (n_samples)
                    decision score for each point

MOF attributes

Attributes	Type	Details
MOF.Data	numpy array of shape (n_points, d_dimensions)	input data for scoring
MOF.decision_scores_	numpy array of shape (n_samples)	decision score for each point
MOF.MassRatio	numpy array of shape (n_samples, n_samples-1)	mass ratio for each pair of points (exclude self pair)

Sample usage

# This example is from MOF paper.
from pymof import MOF
import numpy as np
import matplotlib.pyplot as plt
data = np.array([[0.0, 1.0], [1.0, 1.0], [2.0, 1.0], [3.0, 1.0],
                 [0.0, 0.0], [1.0, 0.0], [2.0, 0.0], [3.0, 0.0],
                 [0.0,-1.0], [1.0,-1.0], [2.0,-1.0], [3.0,-1.0], [8.0, 4.0]
                ])
model = MOF()
model.fit(data)
scores = model.decision_scores_
print(scores)
model.visualize()

# Create a figure and axes
fig, ax = plt.subplots()
data = model.MassRatio
# Iterate over each row and create a boxplot
for i in range(data.shape[0]):
    row = data[i, :]
    mask = np.isnan(row)
    ax.boxplot(row[~mask], positions=[i + 1], vert=False, widths=0.5)
# Set labels and title
ax.set_xlabel("MOF")
ax.set_ylabel("Data points")
ax.set_title("Boxplot of MassRatio distribution")
# Show the plot
plt.grid(True)
plt.show()

Output

[0.12844997, 0.06254347, 0.08142683, 0.20940997, 0.03981233, 0.0212412 , 0.025438  , 0.08894882, 0.11300615, 0.0500218, 0.05805704, 0.17226989, 2.46193377]

3D sample

# This example demonstrates  the usage of MOF
import numpy as np
from pymof import MOF
data = np.array([[-2.30258509,  7.01040212,  5.80242044],
                 [ 0.09531018,  7.13894636,  5.91106761],
                 [ 0.09531018,  7.61928251,  5.80242044],
                 [ 0.09531018,  7.29580291,  6.01640103],
                 [-2.30258509, 12.43197678,  5.79331844],
                 [ 1.13140211,  9.53156118,  7.22336862],
                 [-2.30258509,  7.09431783,  5.79939564],
                 [ 0.09531018,  7.50444662,  5.82037962],
                 [ 0.09531018,  7.8184705,   5.82334171],
                 [ 0.09531018,  7.25212482,  5.91106761]])
model = MOF()
model.fit(data)
scores = model.decision_scores_
print(scores)
model.visualize()

Output

[0.34541068 0.11101711 0.07193073 0.07520904 1.51480377 0.94558894 0.27585581 0.06242823 0.2204504  0.02247725]

---

Mass-Ratio-Average-Absolute-Deviation Based Outlier Factor (MAOF)

Mass-Ratio-Average-Absolute-Deviation Based Outlier Factor for Anomaly Scoring (MAOF) This research extends the mass-ratio-variance outlier factor algorithm (MOF) by exploring other alternative statistical dispersions beyond the traditional variance such as range, interquartile range (IQR), average absolute deviation (AAD), and convex combination of IQR and AAD.

MAOF()

Initialize a model object MAOF

    Parameters :
    Return :
            self : object
                    object of MAOF model

MAOF.fit(Data, Window = 10000, Function_name = "AAD", Weight_Lambda = 0.5, KeepMassRatio = True)

Fit data to MAOF model

    Parameters :
            Data  : numpy array of shape (n_points, d_dimensions)
                    The input samples.
            Window  : int
                    number of points for each calculation.
                    default window size is 10000.
            Function_name : string
                    A type of statistical dispersion that use for scoring.
                    Function_name can be 'AAD','IQR', 'Range','Weight'.
                    default function is 'AAD'
            Weight_Lambda : float
                    0.0 <= Weight_Lambda <= 1.0
                    A Value of lambda that use in weight-scoring function.
                    score = λ AAD + (1- λ) IQR
                    default weight is 0.5
            KeepMassRatio : boolean
                    All points' mass ratio are kept when an argument is True.
                    Beware of exploding memory since calculation with window size = n.
                    Can be set to False for memory efficient.
                    default KeepMassRatio size is True.
            
    Return :
            self  : object
                    fitted estimator

MAOF attributes

Attributes	Type	Details
MAOF.Data	numpy array of shape (n_points, d_dimensions)	input data for scoring
MAOF.decision_scores_	numpy array of shape (n_samples)	decision score for each point
MAOF.MassRatio	numpy array of shape (n_samples, n_samples-1)	mass ratio for each pair of points (exclude self pair)

Sample usage

# This example demonstrates  the usage of MAOF
from pymof import MAOF
import numpy as np
data = np.array([[-2.30258509,  7.01040212,  5.80242044],
                 [ 0.09531018,  7.13894636,  5.91106761],
                 [ 0.09531018,  7.61928251,  5.80242044],
                 [ 0.09531018,  7.29580291,  6.01640103],
                 [-2.30258509, 12.43197678,  5.79331844],
                 [ 1.13140211,  9.53156118,  7.22336862],
                 [-2.30258509,  7.09431783,  5.79939564],
                 [ 0.09531018,  7.50444662,  5.82037962],
                 [ 0.09531018,  7.8184705,   5.82334171],
                 [ 0.09531018,  7.25212482,  5.91106761]])
model = MAOF()
model.fit(data)
scores = model.decision_scores_
print(scores)

Output

[0.46904762 0.26202234 0.2191358  0.22355477 0.97854203 0.79770723 0.40823045 0.20513423 0.38110915 0.12616108]

---

Windowing mass-ratio-variance based outlier factor (WMOF)

This algorithm is an extension of the mass-ratio-variance outlier factor algorithm (MOF). WMOF operates on overlapping windows of fixed size, specified by the user. The use of overlapping windows ensures that anomalies occurring at window boundaries are not missed. For each window, the MOF score is computed for all data points within the window.

WMOF(window=1000, overlap_ratio=0.2)

Initialize a WMOF model object

    Parameters :
            window : integer (int)
                    The number of points for each calculation
                    default window size is 1000.
            overlap_ratio : float
                    0.0 <= overlap_ratio <= 0.5
                    The overlap ratio between window frames.
                    default ratio is 0.2
    Return :
            self : object
                    object of WMOF model

WMOF.fit(data)

Fit data to the WMOF model

    Parameters :
            data : numpy array of shape (n_samples, n_features)
                    The input samples.
    Return :
            self  : object
                    fitted estimator

WMOF.fit_score(x)

Fit a data point to the WMOF model for streaming data

    Parameters :
            x : numpy array of shape (1, n_features)
                    A new input data point.
    Return :
            score : numpy array of shape ((1 - overlap_ratio) * window)
                    A batch of decision scores for the current window.

WMOF.fit_last_score()

Fit the remaining data points in the WMOF model for streaming data

    Parameters :
    Return :
            score : numpy array of shape ((1 - overlap_ratio) * window,)
                    decision scores for the remaining points in the last window.

WMOF.detectAnomaly(theshold)

Detect data points that have WMOF scores greater than a threshold value

    Parameters :
            threshold : float
                    A threshold value for detecting anomaly points
    Return :
            idx : numpy array of shape (n_samples,)
                    An index array of anomaly points in data

WMOF.detectStream(scores, tau = None, n = 0.01)

Detect anomaly data points for streaming data

    Parameters :
            scores : numpy array of shape (n_samples,)
                    decision scores for the current window.
            tau : float
                    A threshold value for detecting anomaly points.
                    default tau is None, the threshold is determined by 'n'.
            n : float or int
                    If float (0.01 <= n <= 0.49), it is the percentage of anomaly data points
                    to select (e.g., 0.01 means the top 1% of scores).
                    If int, it is the exact number of anomaly data points to select.
                    default n is 0.01
    Return :
            idx : numpy array of shape (n_samples,)
                    An index array of anomaly points in the current window of data.

WMOF attributes

Attributes	Type	Details
WMOF.data	numpy array	input data for scoring
WMOF.window_size	integer	number of points for each calculation
WMOF.overlap_ratio	float	overlap ratio between window frame
WMOF.decision_scores_	numpy array	decision score for each point
WMOF.anomaly	numpy array	index of anomaly points in data

Sample usage

The first example

# This example demonstrates the usage of WMOF
from pymof import WMOF
import numpy as np
data = np.array([[-2.30258509,  7.01040212,  5.80242044],
                 [ 0.09531018,  7.13894636,  5.91106761],
                 [ 0.09531018,  7.61928251,  5.80242044],
                 [ 0.09531018,  7.29580291,  6.01640103],
                 [-2.30258509, 12.43197678,  5.79331844],
                 [ 1.13140211,  9.53156118,  7.22336862],
                 [-2.30258509,  7.09431783,  5.79939564],
                 [ 0.09531018,  7.50444662,  5.82037962],
                 [ 0.09531018,  7.8184705,   5.82334171],
                 [ 0.09531018,  7.25212482,  5.91106761]])
model = WMOF()
model.fit(data)
scores = model.decision_scores_
print(scores)

anomaly = model.detectAnomaly(0.8)
print(anomaly)

Output

[0.34541068 0.11101711 0.07193073 0.07520904 1.51480377 0.94558894 0.27585581 0.06242823 0.2204504  0.02247725]
[4 5]

The second example

# This example demonstrates the usage of WMOF for streaming data
from pymof import WMOF
import numpy as np

data = np.array([[-2.30258509,  7.01040212,  5.80242044],
                 [ 0.09531018,  7.13894636,  5.91106761],
                 [ 0.09531018,  7.61928251,  5.80242044],
                 [ 0.09531018,  7.29580291,  6.01640103],
                 [-2.30258509, 12.43197678,  5.79331844],
                 [ 1.13140211,  9.53156118,  7.22336862],
                 [-2.30258509,  7.09431783,  5.79939564],
                 [ 0.09531018,  7.50444662,  5.82037962],
                 [ 0.09531018,  7.81847505,   5.82334171],
                 [ 1.35486018,  2.96845045,   0.13642751],
                 [ 2.96845054,  1.35486018,   5.82334171],
                 [ 0.09531018,  7.25212482,  5.91106761]])
model = WMOF(window=6)
scores = np.array([])

for i in data:
    new_scores = model.fit_score(i)
    scores = np.append(scores, new_scores)

    if len(new_scores) != 0:
        anomaly = model.detectStream(new_scores, n=0.25)
        print(anomaly)

new_scores = model.fit_last_score()
scores = np.append(scores, new_scores)
print(scores)

Output

[4]
[0]
[0.20444444 0.0384     0.1576     0.01937778 0.5104     0.1496
 0.09884444 0.06111111 0.02871111 0.02469136 0.01388889 0.01388889]