Code Monkey home page Code Monkey logo

sldtk's Introduction

The Solar Limb Darkening Toolkit

SLDTk is a commandline program for fast and robust modelling and correction of limb darkening in solar images. It is not yet ready for primetime, but I would love to hear your feedback and ideas for how to make SLDTk better.

Getting Started

Prerequisites

SLDTk is written for Python 3. The following packages are required:

  • numpy>=1
  • opencv-python>=3
  • matplotlib>=2

Note that in addition to opencv-python, the underlying OpenCV library must be installed. There are currently plans to include an optional dependency on scikit-image for systems without OpenCV.

Installation

SLDTk can be installed using pip:

$ pip install sldtk

Usage

$ sldtk -i IMAGE [optional arguments]

The program takes a range of optional arguments for everything from detection threshold to output directory. A complete list can be seen by calling

$ sldtk -h

Features

For now, the codebase provides the best source of information on SLDTk's features and implementation specific details, as auto-generation of the documentation is still in the works.

Input Formats

Currently only images in the jpg and png formats are supported.

Detection

The position and size of the solar disk is automatically determined using computer vision. The disk is subsequently unwrapped and cleaned of outliers (e.g. sunspots and facula) before an average intensity profile is derived.

Modelling

A pluggable modelling system allows user specified models (e.g. a 2nd degree polynomial) to be fitted to the intensity profile of the solar disk, and the results to be plotted together with the original profile for visual analysis. Reference models with known coefficients can also be overlaid on the produced graph.

Correction

Using a fitted model, the solar disk is flat-field corrected to a user selectable bias point. The result can further be fed back into the pipeline to assess its flatness, with a linear model fitted and plotted together with the corrected intensity profile.

Contributing

Do you have an idea for how to make SLDTk better? Have you found a bug? Head over to the issue tracker to open a new issue or contribute to an existing discussion.

If you are interested in contributing to the codebase, fork SLDTk on GitHub to get started. You can install the project in development mode by using $ pip install -e . from the cloned project root.

Have you found a solution to an existing issue or added a new feature? Pull requests are always welcome.

License

SLDTk is released under the MIT open source license. Please see LICENSE.txt for details.

Acknowledgments

The Solar Limb Darkening Toolkit began as an experimental physics project together with Matt Wingham and Sam Heron at Aberystwyth University in the fall of 2017. It is written and maintained by Ariel Ladegaard.

sldtk's People

Contributors

landingellipse avatar legendin avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.