OpenChemistry / OpenChemistry/stempy

HDF5 counting

Open
#259 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
26
Forks
12
Avg merge
1d 2h
Merged PRs (30d)
5

Description

In v3.1.0 I get this warning using an H5 file to count:

DeprecationWarning: Using a reader in electron_count() that is not a SectorThreadedReader or a SectorThreadedMultiPassReader is deprecated in stempy==1.1 and will be removed in stempy==1.2

Here is the code:

with h5py.File('filename.h5','r') as f0:
    sReader = stio.reader(f0)
    ee = stim.electron_count(sReader,dark0,number_of_samples=1200,
                                            xray_threshold_n_sigma=175,
                                            background_threshold_n_sigma=4.5)

Is there a reason to deprecate this function? Its useful to create an H5 file, process the frames, and then compare the counting. I.e. for #258 and #233

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the stim.electron_count and stio.reader entry points shown in the issue, then review how H5 files are processed for comparison with #258 and #233. Determine whether H5-backed readers should remain supported without this deprecation warning; done means the intended behavior and any required scope are documented and covered by relevant tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.