Skip to main content

micropolarizer array data utilities

Project description

micropolarray

Python open-source module for loading and using micropolarizer array and PolarCam images.

Installation

Run one of the following commands in your terminal:

pip install micropolarray

OR

pip install git+https://github.com/Hevil33/micropolarray_master

If an error message about wheels appear, launch it again. You can run the test.py script to verify the correct installation of the micopolarray package.

Features

  • Automatic polarization calculation
  • Fast and optimized operations on the micropolarizer array
  • Basic image cleaning (dark/flat subtraction)

Documentation

Documentation is hosted at ReadTheDocs and can be found HERE (html format).

Usage

Get the simple jupyter tutorial for a brief introduction.

After installation, you can import the library in your python application

import micropolarray as ml

The main class is MicropolImage(), which can be initialized from

  1. A numpy 2D array
  2. A list of .fits filenames
  3. Another MicropolImage()

Some useful member functions are :

MicropolImage()

  • .show()
  • .show_with_pol_params()
  • .rebin()
  • .demosaic()

Information on polarization is automatically calculated and stored in the class members as numpy arrays

MicropolImage()

  • .data
  • single_pol_subimages
  • .Stokes_vec
  • .I.data
  • .Q.data
  • .U.data
  • pB.data (polarized brightness)
  • AoLP.data (angle of linear polarization)
  • DoLP.data (degree of linear polarization)

Additional modules

micropolarray:

  • .processing
    • .congrid (experimental) : fast congrid operations
    • .convert : raw (binary) files to fits conversion
    • .new_demodulation : image demodulation and demodulation tensor calculation
    • .demosaic : fast image demosaicing
    • .nrgf : occulter finding and roi selection, nrgf filter
    • .rebin : fast image binning
    • .shift : image shifting
  • .cameras (experimental) : classes for sensor informations
  • .image : general image handling
  • .utils

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

micropolarray-1.2.14.tar.gz (49.7 kB view details)

Uploaded Source

Built Distribution

micropolarray-1.2.14-py3-none-any.whl (50.8 kB view details)

Uploaded Python 3

File details

Details for the file micropolarray-1.2.14.tar.gz.

File metadata

  • Download URL: micropolarray-1.2.14.tar.gz
  • Upload date:
  • Size: 49.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for micropolarray-1.2.14.tar.gz
Algorithm Hash digest
SHA256 9d032c886b21b926924ccb0e627cc763a16f6593a6ea106026b00eb993fb3aed
MD5 23ab6afd7231b693f506f3151f1cee50
BLAKE2b-256 fcf03447e53459e694fa37915ea3bb7a7b4f1f919580567e14a088c0b0944ccd

See more details on using hashes here.

File details

Details for the file micropolarray-1.2.14-py3-none-any.whl.

File metadata

File hashes

Hashes for micropolarray-1.2.14-py3-none-any.whl
Algorithm Hash digest
SHA256 7251a72251a428dfd5b34ff8252f9eec9f9dda4ca59d2dbd2b1a8d68b3f53a23
MD5 c2cc407f31c446b5dc6af199861d6d81
BLAKE2b-256 229e942054642ae189c33ac6ee30f0829145fccd20f07f5992743cd511b8ced7

See more details on using hashes here.

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