Skip to main content

A python package for data denoising and reconstruction

Project description

YONDER

A pYthON package for Data dEnoising and Reconstruction

Main paper:J-PLUS: A catalogue of globular cluster candidates around the M81/M82/NGC3077 triplet of galaxies

You can get the docs here!

YONDER is a package that uses singular value decomposition to perform low-rank data denoising and reconstruction. It takes a tabular data matrix and an error matrix as input and returns a denoised version of the original dataset as output. The approach enables a more accurate data analysis in the presence of uncertainties. Consequently, this package can be used as a simple toolbox to perform astronomical data cleaning.

How to install YONDER

The YONDER can be installed via the PyPI and pip:

pip install yonder

If you download the repository, you can also install it in the yonder directory:

git clone https://github.com/pengchzn/yonder
cd yonder
python setup.py install

How to use YONDER

Here is a simple example for the use of YONDER

from yonder import yonder
import numpy as np

#import the data
X = pd.read_csv('./datasets/Xobs.csv')
Xsd = pd.read_csv('./datasets/Xsd.csv')

# put the data into the algorithm
# Get the value
U, S, V = yonder.yonder(X, Xsd, 2)

# Get the denoised data
result = U @ S @ V.T

After the YONDER procedure, you can connect any additional algorithms or models to the denoised data.

You can test the test example in this notebook locally by yourself! If you are new to Python or don’t know how to run YONDER locally, you can click here to create a new Colaboratory notebook, so you can run YONDER in the cloud!

Requirements

  • python 3

  • numpy >= 1.21.0

  • Scipy >= 1.7.0

YONDER primarily uses the most recent version of Scipy for single value decomposition. Make sure your Scipy installation is up to date before using YONDER.

References

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yonder-1.1.tar.gz (16.3 kB view hashes)

Uploaded Source

Built Distribution

yonder-1.1-py3-none-any.whl (16.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page