Skip to main content

Point Spread Function calculations for fluorescence microscopy

Psf is a Python library to calculate Point Spread Functions (PSF) for fluorescence microscopy.

This library is no longer actively developed.

Authors:

Christoph Gohlke, Oliver Holub

Organization:

Laboratory for Fluorescence Dynamics. University of California, Irvine

License:

3-clause BSD

Version:

2019.10.14

Requirements

Revisions

2019.10.14

Support Python 3.8.

2019.4.22

Fix setup requirements. Fix compiler warning.

2019.1.1

Update copyright year.

References

  1. Electromagnetic diffraction in optical systems. II. Structure of the image field in an aplanatic system. B Richards and E Wolf. Proc R Soc Lond A, 253 (1274), 358-379, 1959.

  2. Focal volume optics and experimental artifacts in confocal fluorescence correlation spectroscopy. S T Hess, W W Webb. Biophys J (83) 2300-17, 2002.

  3. Electromagnetic description of image formation in confocal fluorescence microscopy. T D Viser, S H Wiersma. J Opt Soc Am A (11) 599-608, 1994.

  4. Photon counting histogram: one-photon excitation. B Huang, T D Perroud, R N Zare. Chem Phys Chem (5), 1523-31, 2004. Supporting information: Calculation of the observation volume profile.

  5. Gaussian approximations of fluorescence microscope point-spread function models. B Zhang, J Zerubia, J C Olivo-Marin. Appl. Optics (46) 1819-29, 2007.

  6. The SVI-wiki on 3D microscopy, deconvolution, visualization and analysis. https://svi.nl/NyquistRate

  7. Theory of Confocal Microscopy: Resolution and Contrast in Confocal Microscopy. http://www.olympusfluoview.com/theory/resolutionintro.html

Examples

>>> import psf
>>> args = dict(shape=(32, 32), dims=(4, 4), ex_wavelen=488, em_wavelen=520,
...             num_aperture=1.2, refr_index=1.333,
...             pinhole_radius=0.55, pinhole_shape='round')
>>> obsvol = psf.PSF(psf.GAUSSIAN | psf.CONFOCAL, **args)
>>> print('%.5f, %.5f' % obsvol.sigma.ou)
2.58832, 1.37059
>>> obsvol = psf.PSF(psf.ISOTROPIC | psf.CONFOCAL, **args)
>>> obsvol[0, :3]
array([ 1.     ,  0.51071,  0.04397])
>>> # save the image plane to file
>>> obsvol.slice(0).tofile('_test_slice.bin')
>>> # save a full 3D PSF volume to file
>>> obsvol.volume().tofile('_test_volume.bin')

Refer to the psf_example.py file in the source distribution for more.

Metadata

Release files for psf 2019.10.14

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

Source distribution (sdist)

Source distribution for psf 2019.10.14
File Size Uploaded Provenance Actions
psf-2019.10.14.tar.gz 22.8 kB Without provenance Details for psf-2019.10.14.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for psf 2019.10.14
File Actions
psf-2019.10.14-cp38-cp38-win_amd64.whl CPython 3.8 CPython 3.8 Windows x86-64 Details for psf-2019.10.14-cp38-cp38-win_amd64.whl
psf-2019.10.14-cp38-cp38-win32.whl CPython 3.8 CPython 3.8 Windows x86-32 Details for psf-2019.10.14-cp38-cp38-win32.whl
psf-2019.10.14-cp37-cp37m-win_amd64.whl CPython 3.7 CPython 3.7 pymalloc Windows x86-64 Details for psf-2019.10.14-cp37-cp37m-win_amd64.whl
psf-2019.10.14-cp37-cp37m-win32.whl CPython 3.7 CPython 3.7 pymalloc Windows x86-32 Details for psf-2019.10.14-cp37-cp37m-win32.whl
psf-2019.10.14-cp36-cp36m-win_amd64.whl CPython 3.6 CPython 3.6 pymalloc Windows x86-64 Details for psf-2019.10.14-cp36-cp36m-win_amd64.whl
psf-2019.10.14-cp36-cp36m-win32.whl CPython 3.6 CPython 3.6 pymalloc Windows x86-32 Details for psf-2019.10.14-cp36-cp36m-win32.whl
psf-2019.10.14-cp35-cp35m-win_amd64.whl CPython 3.5 CPython 3.5 pymalloc Windows x86-64 Details for psf-2019.10.14-cp35-cp35m-win_amd64.whl
psf-2019.10.14-cp35-cp35m-win32.whl CPython 3.5 CPython 3.5 pymalloc Windows x86-32 Details for psf-2019.10.14-cp35-cp35m-win32.whl
psf-2019.10.14-cp27-cp27m-win_amd64.whl CPython 2.7 CPython 2.7 pymalloc Windows x86-64 Details for psf-2019.10.14-cp27-cp27m-win_amd64.whl
psf-2019.10.14-cp27-cp27m-win32.whl CPython 2.7 CPython 2.7 pymalloc Windows x86-32 Details for psf-2019.10.14-cp27-cp27m-win32.whl

Total release size: 312.8 kB

Release files / psf-2019.10.14.tar.gz

Download URL psf-2019.10.14.tar.gz
Size 22.8 kB
Tags Source
SHA-256 checksum
How to use checksums
af5e58b38463132ae2cb12c0b43d702fa81f888eb0d3dd4ee5c4e91c3077a623
BLAKE2b-256 checksum
How to use checksums
2bdeb87674ac38c9e8c76fbaaa5812d101eeefb3eaee7c2041aec60fa50a688e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

Release files / psf-2019.10.14-cp38-cp38-win_amd64.whl

Download URL psf-2019.10.14-cp38-cp38-win_amd64.whl
Size 31.1 kB
Tags CPython 3.8 Windows x86-64
SHA-256 checksum
How to use checksums
f52c20f75607bbcfde0c95fb63423b763fdaa637c920a17e2e4e4c43f049a703
BLAKE2b-256 checksum
How to use checksums
42a84993884374702b917c711fc41aed22d2e7e1661d5257d2bc46addb7dc1c5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

Release files / psf-2019.10.14-cp38-cp38-win32.whl

Download URL psf-2019.10.14-cp38-cp38-win32.whl
Size 27.8 kB
Tags CPython 3.8 Windows x86-32
SHA-256 checksum
How to use checksums
409293dac0b61faf879907a72dab2022b95ec5f74feea05de78384f2b3a7afdc
BLAKE2b-256 checksum
How to use checksums
b9fc6e379bcb6a154fb9fd5284ebeac152dd6527a402801399923be611731276
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

Release files / psf-2019.10.14-cp37-cp37m-win_amd64.whl

Download URL psf-2019.10.14-cp37-cp37m-win_amd64.whl
Size 31.1 kB
Tags CPython 3.7 CPython 3.7 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
45a3aa7e1f5b4d68b0e2ac6ed21d4d48e01b7893b87ca687f14ba22e78c1e1fe
BLAKE2b-256 checksum
How to use checksums
327d6f91000f9c0669cc01b5492d383a16d711b9a97f347f864bbdee3edb09a3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

Release files / psf-2019.10.14-cp37-cp37m-win32.whl

Download URL psf-2019.10.14-cp37-cp37m-win32.whl
Size 27.8 kB
Tags CPython 3.7 CPython 3.7 pymalloc Windows x86-32
SHA-256 checksum
How to use checksums
78af64d3f142a132198d76802bba0ccbf22784a17914e94a92ab6de21c49d053
BLAKE2b-256 checksum
How to use checksums
21f3b4d61afdf0961b2ac578797e5a401d9ddd07f7451976b392e52adc7b849a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

Release files / psf-2019.10.14-cp36-cp36m-win_amd64.whl

Download URL psf-2019.10.14-cp36-cp36m-win_amd64.whl
Size 30.9 kB
Tags CPython 3.6 CPython 3.6 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
b2e6af418ab0510d57fb23a00230691957f5c8c7f1f07591e34986b0b8afcf58
BLAKE2b-256 checksum
How to use checksums
6b7f76949a21edfe90cf274bae042f17240b9f1eac082e83b1196316b3cb556d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

Release files / psf-2019.10.14-cp36-cp36m-win32.whl

Download URL psf-2019.10.14-cp36-cp36m-win32.whl
Size 27.6 kB
Tags CPython 3.6 CPython 3.6 pymalloc Windows x86-32
SHA-256 checksum
How to use checksums
7a1743f7f0e036dbfe576812a668c071655fa7756269dcd219748dbdb2d0eabb
BLAKE2b-256 checksum
How to use checksums
d949a380daf0562aea80486cba0fb327d5915d0ad45a185f2ec43d2049305fae
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

Release files / psf-2019.10.14-cp35-cp35m-win_amd64.whl

Download URL psf-2019.10.14-cp35-cp35m-win_amd64.whl
Size 30.9 kB
Tags CPython 3.5 CPython 3.5 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
ea193cc66dc1b6a3d390d3f46af2782fd8b1793e1b4269356eb0b4bc66d83b83
BLAKE2b-256 checksum
How to use checksums
41cbf57f1fda2ce76bf35c6876b1d0c152b1bc65a2c84e71d8fb95f67e80b05b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

Release files / psf-2019.10.14-cp35-cp35m-win32.whl

Download URL psf-2019.10.14-cp35-cp35m-win32.whl
Size 27.6 kB
Tags CPython 3.5 CPython 3.5 pymalloc Windows x86-32
SHA-256 checksum
How to use checksums
b7921be443675e3b53bea541b7cd19279b1d38d5e7eaaaf126940e9b3830e5cd
BLAKE2b-256 checksum
How to use checksums
1bfa92f5afedffd64a2afcaf5168da336b3d9921813342544ccbf644e21b0032
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

Release files / psf-2019.10.14-cp27-cp27m-win_amd64.whl

Download URL psf-2019.10.14-cp27-cp27m-win_amd64.whl
Size 28.5 kB
Tags CPython 2.7 CPython 2.7 pymalloc Windows x86-64
SHA-256 checksum
How to use checksums
d49512e03c3785a9fa6194bef3833d4845e6e65236c9f127ab320b941ec119db
BLAKE2b-256 checksum
How to use checksums
519a713df8949914333bbcfbea8a9aff632a0ca4c9cd9ea9db3dac9e3f6914ef
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

Release files / psf-2019.10.14-cp27-cp27m-win32.whl

Download URL psf-2019.10.14-cp27-cp27m-win32.whl
Size 26.7 kB
Tags CPython 2.7 CPython 2.7 pymalloc Windows x86-32
SHA-256 checksum
How to use checksums
66ae0f5d6073335d0c72467c49c544afcc3e96394365857aaf50e379da45c999
BLAKE2b-256 checksum
How to use checksums
076f713fdd00908b75f18c3c4514f93992079112cc813a6e5b6951a243b3e593
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

Security for psf 2019.10.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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