Welcome to the pylocus documentation !¶
pylocus is a Python package designed to solve general localization problems, \(min_X L(X)\), where \(X\) is a \(N\) x \(d\) matrix of coordinates of a point set and \(L(X)\) is a cost function adapted to the problem at hand.
The goal is to find the best location of all or some points in \(X\). Usually, the cost function penalizes the difference between measured and reconstructed signals, such as range, direction or other modalities.
Note that for now, this documentation is written as a convenient entry point to understand the code structure. For detailed instructions on how to use particular function, please dig into the source code.
Source code is on GitHub : https://github.com/LCAV/pylocus.
Get it¶
pylocus is available from PyPi and Python 3.6 compatible. If you already have pip installed, simply run :
$ pip install pylocus
Contribute¶
If you want to contribute to this project, you may fork our GitHub main repository repository : https://github.com/LCAV/pylocus and submit a pull request from a new branch type/description, where type can be fix, feature, doc, or various.
Module contents¶
This is an overview of the most important elements and entry-points of this library.
Point Setups
pylocus.point_set.PointSet |
|
pylocus.point_set.HeterogenousSet |
Distance Algorithms
pylocus.algorithms.procrustes |
|
pylocus.algorithms.reconstruct_mds |
|
pylocus.algorithms.reconstruct_srls |
|
pylocus.algorithms.reconstruct_dwmds |
|
pylocus.algorithms.reconstruct_acd |
|
pylocus.algorithms.reconstruct_sdp |
Angle and Distance Algorithms
pylocus.algorithms.reconstruct_emds |
|
pylocus.algorithms.reconstruct_cdm |
Useful basics
pylocus.basics |
|
pylocus.basics_angles |