Skip to main content

Solar Annotator

CodeFactor PyPI version

A tool for annotating solar images with themes.

Install

It's best to install in a clean virtual environment to avoid package conflicts or incorrect versions.

On a Mac or Linux machine:

python -m venv venv
source venv/bin/activate
pip install solarannotator

On a Windows machine:

py -m venv venv
.\venv\Scripts\activate
py -m pip install solarannotator

For more details visit the Packaging guide.

Running and usage

Execute from the terminal after installing by running inside your virtual environment. SolarAnnotator

This launches the main software: Screenshot of tool

On the left hand side, you will see a preview that can be maniuplated with the controls below. It allows for viewing different SUVI channels with different configurations, e.g. one color versus three color. The preview controls allow you to select the minimum and maximum percentile shown as well as scale the image by raising all pixels to the selected power.

You interact by drawing on the preview image to create new regions in the thematic map. You can also relabel those patches by left-clicking in the thematic map with a new theme selected. Finally, you can see boundaries of regions from the thematic map back in the preview image by right clicking the thematic map.

Future

This tool is still under development. There are many features coming.

  • Ability to scale a single color image
  • Ability to scale in a three color image
  • Right click on a region in the thematic map and see its boundary in the preview
  • Left click on a region in the thematic map to re-annotate all the contiguous pixels
  • Undo annotations
  • Differentiate save and save as
  • Add color legend to radio buttons
  • Redo annotations, after ctrl-z
  • Overlay HEK and other pre-determined annotations
  • Multiple normalization options
  • Robustify the thematic map io for better metadata passing, also use SunPy maps
  • Add a help guide
  • Add an ability to load a template when you create a new date

Metadata

Release files for solarannotator 1.0.1

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

Source distribution (sdist)

Source distribution for solarannotator 1.0.1
File Size Uploaded
solarannotator-1.0.1.tar.gz 15.4 kB Details

Built distribution (wheel)

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

Total release size: 31.0 kB

Release files / solarannotator-1.0.1.tar.gz

Download URL solarannotator-1.0.1.tar.gz
Size 15.4 kB
Tags Source
SHA-256 checksum
How to use checksums
1e1ff6d7e981b0bc61ca08833be0e8bbb7ba0aff6c5e414fa1baecb467db51e1
BLAKE2b-256 checksum
How to use checksums
e4a532d33b64f62f1ee8b572d357aa987463e3c3a24682c9a7bf0e32d194e164
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.17

Release files / solarannotator-1.0.1-py3-none-any.whl

Download URL solarannotator-1.0.1-py3-none-any.whl
Size 15.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8fd26644f0da364dffef0335a51dd1740f1fa69c405d5f9770e83fe1dca75a7a
BLAKE2b-256 checksum
How to use checksums
921df501b15e7ed546cab1f4029462cdce4c847edb4cce1fbb3b6809e7dfc4aa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.17

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files

1.0.0

2 release files

0.3.1

1 release file

0.3.0

1 release file

0.2.15

2 release files

0.2.14

1 release file

0.2.13

2 release files

0.2.12

2 release files

0.2.10

1 release file

0.2.9

1 release file

0.2.8

1 release file

0.2.7

1 release file

0.2.6

1 release file

0.2.5

1 release file

0.2.4

1 release file

0.2.2

1 release file

0.2

1 release file

0.1

1 release file

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