Skip to main content

MRF: Multi-Resolution Filtering

Multi-Resolution Filtering: a method for isolating faint, extended emission in Dragonfly data and other low resolution images.

Documentation

Please read the documentation and tutorial at https://mrfiltering.readthedocs.io/en/latest/.

Applications

  • Subtract compact objects from low-resolution images (such as Dragonfly) to reveal low surface brightness features.
  • Characterize and subtract stellar halos in Dragonfly image.
  • Download corresponding high resolution image (HSC, CFHT) of given Dragonfly image.

Examples

This example shows the tidal feature of NGC 5907, described in van Dokkum et al. (2019). The images presented there used this algorithm. Full resolution Dragonfly images and MRF results can be found here. Check this notebook for more details in how to do MRF using this Python package! :rocket:

MRF on NGC 5907

This example shows how powerful MRF is in revealing low surface brightness features. The ultra-diffuse galaxy M101-DF3 is revealed by MRF after subtracting compact objects and bright star halos according to van Dokkum et al. (2019). Check this notebook for more details.

MRF on M101-DF3

You can also use this script to run the MRF task. Take NGC 5907 as an example:

python mrf-task.py n5907_df_g.fits ngc5907_cfht_g.fits ngc5907_cfht_r.fits ngc5907-task.yaml --galcat='gal_cat_n5907.txt' --output='n5907_g'

Installation

mkdir <install dir>
cd <install dir>
git clone git@github.com:AstroJacobLi/mrf.git
cd mrf
python setup.py install

If you don't have git configured, you can also download the zip file directly from https://github.com/AstroJacobLi/mrf/archive/master.zip, then unzip it and install in the same way.

To test whether mrf is installed successfully, import mrf in Python:

import mrf, os
print(os.path.isfile(os.path.join(mrf.__path__[0], 'iraf/macosx/x_images.e')))

True means you have installed mrf successfully! Bravo!

If you need to use lanczos or cubic interpolation, you must have galsim installed. You will also need unagi to download HSC images. Python>=3 is needed, but you can try whether mrf still works under python2. Check out the dependence of mrf depends from requirements.txt.

Citation

mrf is a free software made available under the MIT License by Pieter van Dokkum (initial development) and Jiaxuan Li (implementation, maintenance, and documentation). If you use this package in your work, please cite van Dokkum et al. (2019).

Acknowledgement

Many scripts and snippets are from kungpao (written by Song Huang). Johnny Greco kindly shared his idea of the code structure. Roberto Abraham found the first few bugs of this package and provided useful solutions. Here we appreciate their help!

Copyright 2019 Pieter van Dokkum and Jiaxuan Li.

Metadata

Release files for mrf 1.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mrf 1.0.4
File Size Uploaded
mrf-1.0.4.tar.gz 14.7 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for mrf 1.0.4
File Interpreter ABI Platform
mrf-1.0.4-py3-none-any.whl Python 3 none any Details

Total release size: 22.8 MB

Release files / mrf-1.0.4.tar.gz

Download URL mrf-1.0.4.tar.gz
Size 14.7 MB
Tags Source
SHA-256 checksum
How to use checksums
b09cb2e88819775aebc3879de1fc4884ebe4e578e5838e11c28d463f45b34e33
BLAKE2b-256 checksum
How to use checksums
b546c177189fc80f1a623ee7c5499320fdb6c99f8f8cf997accdfbecbeaa8fde
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.4.2 requests/2.19.1 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.26.0 CPython/3.7.0

Release files / mrf-1.0.4-py3-none-any.whl

Download URL mrf-1.0.4-py3-none-any.whl
Size 8.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
8464c27e25a4f248c93b37eb30dd14afbd0efd6e73974337f80404215e01eafe
BLAKE2b-256 checksum
How to use checksums
1528f3f2aa1b844c7a21419945c6cf762bf0aa0a0feda3986796bf9585c27343
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.4.2 requests/2.19.1 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.26.0 CPython/3.7.0

Release history Release notifications | RSS feed

This release

1.0.4 This release

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page