Skip to main content

FRET

Project description

ndx-fret

PyPI version

NWB extension for storing Fluorescence Resonance Energy Transfer (FRET) experimental data. A collaboration with Jaeger Lab, Emory University and The Kavli Foundation.

Python Installation

pip install ndx-fret

Python Usage

from pynwb import NWBFile, NWBHDF5IO
from pynwb.device import Device
from pynwb.ophys import OpticalChannel
from ndx_fret import FRET, FRETSeries

from datetime import datetime
import numpy as np

nwb = NWBFile('session_description', 'identifier', datetime.now().astimezone())

# Create and add device
device = Device(name='Device')
nwb.add_device(device)

# Create optical channels
opt_ch_d = OpticalChannel(
    name='optical_channel',
    description='optical_channel_description',
    emission_lambda=529.
)
opt_ch_a = OpticalChannel(
    name='optical_channel',
    description='optical_channel_description',
    emission_lambda=633.
)

# Create FRET
fs_d = FRETSeries(
    name='donor',
    fluorophore='mCitrine',
    optical_channel=opt_ch_d,
    device=device,
    description='description of donor series',
    data=np.random.randn(100, 10, 10),
    rate=200.,
    unit='no unit'
)
fs_a = FRETSeries(
    name='acceptor',
    fluorophore='mKate2',
    optical_channel=opt_ch_a,
    device=device,
    description='description of acceptor series',
    data=np.random.randn(100, 10, 10),
    rate=200.,
    unit='no unit'
)

fret = FRET(
    name='FRET',
    excitation_lambda=482.,
    donor=fs_d,
    acceptor=fs_a
)
nwb.add_acquisition(fret)

# Write nwb file
with NWBHDF5IO('test_fret.nwb', 'w') as io:
    io.write(nwb)
    print('NWB file written')

# Read nwb file and check its content
with NWBHDF5IO('test_fret.nwb', 'r', load_namespaces=True) as io:
    nwb = io.read()
    print(nwb)

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

ndx-fret-0.2.1.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

ndx_fret-0.2.1-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file ndx-fret-0.2.1.tar.gz.

File metadata

  • Download URL: ndx-fret-0.2.1.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/49.6.0.post20200814 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.7

File hashes

Hashes for ndx-fret-0.2.1.tar.gz
Algorithm Hash digest
SHA256 b5eb8eb1135ea41c4c9cf2a8ba8c20aae4b3f23188d974b69d4ffb667ca10752
MD5 8fc110cfeebb09a05ab39acfb2305d38
BLAKE2b-256 93cae10b0299120b2ad1ac4b10cfa85f8480c2e71a3eee0f863d6f2f156d7449

See more details on using hashes here.

Provenance

File details

Details for the file ndx_fret-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: ndx_fret-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/49.6.0.post20200814 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.7

File hashes

Hashes for ndx_fret-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 507c47871a8738feb90c0fc628ae8b640cc09d8795e35f08c03ead6c4ae020f0
MD5 cdd9d773e4032dc320a87b2204acd215
BLAKE2b-256 1a57d46e0603523b894559fd47f6b277d32a98f1d6bffa4d8489df3e384e81a5

See more details on using hashes here.

Provenance

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