simonsobs / simonsobs/sotodlib

hkdb.load_hk does not trim data to match requested time range

Open
#1,658 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
19
Forks
23
Avg merge
1d 5h
Merged PRs (30d)
14

Description

Currently it will return all data found in any frames that overlap [start, end), which is a superset of all data in [start, end).

Relying on current behavior to provide buffers on either end is not good practice ... so I think the new default behavior should be to trim the data vectors.

We can leave in an option for not trimming, which might have tiny efficiency and potentially help bridge gap for scripts that rely on current behavior / results.

(Reported by @JB-Lloyd )

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 at hkdb.load_hk and trace how frames overlapping [start, end) are selected and how their data vectors are returned. Add regression coverage for trimming to the requested range and verify that an option preserves the existing untrimmed behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.