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.16.tar.gz (50.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

micropolarray-1.2.16-py3-none-any.whl (51.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for micropolarray-1.2.16.tar.gz
Algorithm Hash digest
SHA256 69b9dc1055b60aeda5287043b5718a0a11df535404d78f419c96bc8b84af6cb0
MD5 cc445e3a49236aef866a90bccf712fca
BLAKE2b-256 85193a784ac804612f1eaef4cdae343abc2b8220556ad3c7b3f9986c9c986b44

See more details on using hashes here.

File details

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

File metadata

  • Download URL: micropolarray-1.2.16-py3-none-any.whl
  • Upload date:
  • Size: 51.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.10

File hashes

Hashes for micropolarray-1.2.16-py3-none-any.whl
Algorithm Hash digest
SHA256 8015d5a898bfa3219b4c13e0cccae97ad6ae884a9e9b8827c637b1e93aae0868
MD5 9cafe95e867608e9abd7ac6e3e5395a7
BLAKE2b-256 4cc8cfd1dc1154d24225c9ace2ed5bf1865dab3d625541f0d97326d0b9e62eed

See more details on using hashes here.

Supported by

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