Welcome to mat-clustering’s documentation!

---

MAT-clustering: Clustering Methods for Multiple Aspect Trajectory Data Mining [MAT-Tools Framework]

---

[Publication] [Bibtex] [GitHub] [PyPi]

The present application offers a tool, to support the user in the data mining task of multiple aspect trajectories, specifically for clustering its complex data. It integrates into a unique platform the fragmented approaches available for multiple aspects trajectories and in general for multidimensional sequence classification into a unique web-based and python library system.

Created on Apr, 2024 Copyright (C) 2024, License GPL Version 3 or superior (see LICENSE file)

Main Modules

• Core Classes:

  1. TrajectoryClustering - Base class for trajectory clustering

  2. HSTrajectoryClustering - Hyperparameter search model for trajectory clustering

  3. SimilarityClustering - Similarity-based clustering for trajectory data

• Similarity-based clustering methods:

  1. TSAgglomerative - MAT Hierarchical Agglomerative Clustering

  2. TSBirch - MAT BIRCH Clustering

  3. TSDBSCAN - MAT DBSCAN Clustering

  4. TSKMeans - MAT K-Means Clustering

  5. TSKMedoids - MAT K-Medoids Clustering

  6. TSpectral - MAT Spectral Clustering

• CoClustering clustering methods: Under Development

• Hierarchical clustering methods: Under Development

Installation

Install directly from PyPi repository, or, download from github. (python >= 3.7 required)

    pip install mat-clustering

Citing

If you use mat-clustering please cite the following paper:

• Portela, T. T.; Machado, V. L.; Renso, C. Unified Approach to Trajectory Data Mining and Multi-Aspect Trajectory Analysis with MAT-Tools Framework. In: SIMPÓSIO BRASILEIRO DE BANCO DE DADOS (SBBD), 39. , 2024, Florianópolis/SC. [Bibtex]

Collaborate with us

Any contribution is welcome. This is an active project and if you would like to include your algorithm in matclustering, feel free to fork the project, open an issue and contact us.

Feel free to contribute in any form, such as scientific publications referencing matclustering, teaching material and workshop videos.

Related packages

This package is part of MAT-Tools Framework for Multiple Aspect Trajectory Data Mining, check the guide project:

• mat-tools: Reference guide for MAT-Tools Framework repositories

Change Log

This is a package under construction, see CHANGELOG.md

---

Module contents

Modules in MAT-clustering:

• Core Classes
  • Submodules
  • matclustering.core.AbstractTrajectoryClustering module
    • HSTrajectoryClustering
      • HSTrajectoryClustering.best_config
      • HSTrajectoryClustering.if_config()
      • HSTrajectoryClustering.prepare_input()
      • HSTrajectoryClustering.save()
      • HSTrajectoryClustering.test()
      • HSTrajectoryClustering.testing_report()
      • HSTrajectoryClustering.train()
      • HSTrajectoryClustering.training_report()
    • TrajectoryClustering
      • TrajectoryClustering.name
      • TrajectoryClustering.isverbose
      • TrajectoryClustering.save_results
      • TrajectoryClustering.config
      • TrajectoryClustering.model
      • TrajectoryClustering.report
      • TrajectoryClustering.test_report
      • TrajectoryClustering.add_config()
      • TrajectoryClustering.clear()
      • TrajectoryClustering.cluestering_report()
      • TrajectoryClustering.create()
      • TrajectoryClustering.duration()
      • TrajectoryClustering.fit()
      • TrajectoryClustering.grid_search()
      • TrajectoryClustering.message()
      • TrajectoryClustering.prepare_input()
      • TrajectoryClustering.save()
      • TrajectoryClustering.score()
      • TrajectoryClustering.summary()
  • matclustering.core.SimilarityClustering module
    • SimilarityClustering
      • SimilarityClustering.name
      • SimilarityClustering.metric
      • SimilarityClustering.X
      • SimilarityClustering.labels
      • SimilarityClustering.default_metric()
      • SimilarityClustering.prepare_input()
  • Module contents
• Similarity-based
  • Submodules
  • matclustering.methods.similarity.TSAgglomerative module
    • TSAgglomerative
      • TSAgglomerative.create()
      • TSAgglomerative.create()
      • TSAgglomerative.if_config()
  • matclustering.methods.similarity.TSBirch module
    • TSBirch
      • TSBirch.create()
      • TSBirch.create()
      • TSBirch.if_config()
  • matclustering.methods.similarity.TSDBSCAN module
    • TSDBSCAN
      • TSDBSCAN.create()
      • TSDBSCAN.if_config()
  • matclustering.methods.similarity.TSKMeans module
    • TSKMeans
      • TSKMeans.create()
      • TSKMeans.if_config()
  • matclustering.methods.similarity.TSKMedoids module
    • TSKMedoids
      • TSKMedoids.create()
      • TSKMedoids.fit()
      • TSKMedoids.if_config()
  • matclustering.methods.similarity.TSpectral module
    • TSpectral
      • TSpectral.create()
      • TSpectral.if_config()
  • Module contents
• CoClustering (Under Development)
  • Submodules
  • matclustering.methods.coclustering.OCoClus module
    • OCoClus
      • OCoClus.create()
      • OCoClus.fit()
      • OCoClus.if_config()
  • matclustering.methods.coclustering.SSOCoClus module
    • SSOCoClus
      • SSOCoClus.create()
      • SSOCoClus.fit()
      • SSOCoClus.if_config()
• Hierarchical (Under Development)
  • Subpackages
    • matclustering.methods.hierarchical.mattree namespace
      • Subpackages
        • matclustering.methods.hierarchical.mattree.algorithm namespace
          • Submodules
          • matclustering.methods.hierarchical.mattree.algorithm.TreeNodeObject module
            • TreeNodeObject
          • matclustering.methods.hierarchical.mattree.algorithm.check_label module
            • check_label()
          • matclustering.methods.hierarchical.mattree.algorithm.dashtree module
            • dashtree()
          • matclustering.methods.hierarchical.mattree.algorithm.graphic_tree module
            • generate_graphic_tree()
            • graphic_tree()
          • matclustering.methods.hierarchical.mattree.algorithm.set_level module
            • set_level()
        • matclustering.methods.hierarchical.mattree.metrics_evaluation namespace
          • Submodules
          • matclustering.methods.hierarchical.mattree.metrics_evaluation.eda module
            • eda()
            • eda_corr()
          • matclustering.methods.hierarchical.mattree.metrics_evaluation.entropy module
            • get_entropy()
          • matclustering.methods.hierarchical.mattree.metrics_evaluation.freq_matrix module
            • generate_freq_matrix()
          • matclustering.methods.hierarchical.mattree.metrics_evaluation.sankey module
            • sankey()
          • matclustering.methods.hierarchical.mattree.metrics_evaluation.similarity_matrix module
            • get_similarity_matrix()
      • Submodules
      • matclustering.methods.hierarchical.mattree.MATTree module
        • MATTree
          • MATTree.create()
          • MATTree.digraph()
          • MATTree.fit()
          • MATTree.if_config()
          • MATTree.prepare_input()
  • Module contents

Framework Documentation:

• MAT-Tools

---

Change Log

v0.1

• First release