hcam-obsutils 0.0.2__py3-none-any.whl

hcam_obsutils/scripts/missbias.py

@@ -0,0 +1,140 @@
+import argparse
+from pathlib import Path
+from typing import Iterable
+
+from hipercam.hcam import Rhead as Hhead
+from hipercam.ucam import Rhead as Uhead
+
+HELP = """
+missbias reads all the runs in the directories specified and tries to work out if there
+are any non-biases without corresponding biases. This is a crude test and does not verify that
+runs identified as 'Bias' are what they say they are or that they are any good. As well as the
+directories specified, the script also looks for subdirectories called 'data'
+"""
+
+UCAM_RE = "run[0-9][0-9][0-9].xml"
+HCAM_RE = "run[0-9][0-9][0-9][0-9].fits"
+
+
+def is_bias(header: Hhead | Uhead) -> bool:
+    try:
+        # assume ucam first
+        target = header.header["TARGET"].lower()
+    except KeyError:
+        target = header.header["OBJECT"].lower()
+    return "bias" in target
+
+
+def headers(dirpath: str, hcam: bool = False) -> Iterable[Hhead | Uhead]:
+    """
+    Generator yielding header objects from all runs in dirpath.
+
+    ULTRACAM/ULTRASPEC Power ON/OFF runs are skipped.
+
+    Parameters
+    ----------
+    dirpath : str
+        Path to directory to search for runs.
+    hcam : bool
+        If True, process HiPERCAM runs, otherwise ULTRASPEC/ULTRACAM runs.
+
+    Yields
+    ------
+    header : Hhead or Uhead
+        Header object for each run found.
+    """
+    dirpath = Path(dirpath)
+    if dirpath.is_dir():
+        header_files = dirpath.glob(HCAM_RE) if hcam else dirpath.glob(UCAM_RE)
+        for fn in header_files:
+            fn = fn.with_suffix("")
+            header = Hhead(str(fn)) if hcam else Uhead(str(fn))
+            if not hcam and header.isPonoff():
+                continue
+            yield header
+
+
+def uhead_equal(h1: Uhead, h2: Uhead, fussy: bool = False) -> bool:
+    ok = (
+        (h1.xbin == h2.xbin)
+        and (h1.instrument == h2.instrument)
+        and (h1.ybin == h2.ybin)
+        and (len(h1.win) == len(h2.win))
+        and (h1.gainSpeed == h2.gainSpeed)
+        and (
+            h1.header.get("HVGAIN", None) == h2.header.get("HVGAIN", None)
+            if fussy
+            else True
+        )
+    )
+    if ok:
+        for window in h1.win:
+            if not any(w == window for w in h2.win):
+                ok = False
+                break
+    return ok
+
+
+def main():
+    parser = argparse.ArgumentParser(description=HELP)
+    parser.add_argument(
+        "-f",
+        "--fussy",
+        action="store_true",
+        default=False,
+        help="fussy tests ensure difference in avalanche gains are picked up, only important for ULTRASPEC",
+    )
+    parser.add_argument(
+        "-i",
+        "--include-caution",
+        default=False,
+        action="store_true",
+        help="include runs marked 'data caution' when listing runs without biasses",
+    )
+    parser.add_argument(
+        "--hcam",
+        action="store_true",
+        default=False,
+        help="process HiPERCAM runs rather than ULTRASPEC and/or ULTRACAMruns",
+    )
+    parser.add_argument(
+        "dirs",
+        nargs="+",
+        help="directories to search for runs, subdirectories called 'data' will also be searched",
+    )
+    args = parser.parse_args()
+
+    # accumulate a list of unique biases and non-biases
+    nonbiases = {}
+    biases = {}
+    dirs = set(["data"] + args.dirs)
+    for dirpath in sorted(dirs):
+        # all headers in this directory
+        for header in headers(dirpath, hcam=args.hcam):
+            # which dictionary to store in?
+            if is_bias(header):
+                destination = biases
+            else:
+                destination = nonbiases
+
+            # compare with already stored formats
+            new_format = True
+            for _, rold in destination.items():
+                if uhead_equal(header, rold, fussy=args.fussy):
+                    new_format = False
+                    break
+            if new_format:
+                destination[header.run] = header
+
+    # now see if each non-bias has a matching bias
+    for run, nhead in nonbiases.items():
+        if not args.include_caution and nhead.header["DTYPE"].lower() == "data caution":
+            continue
+
+        has_bias = False
+        for _, bhead in biases.items():
+            if uhead_equal(nhead, bhead, fussy=args.fussy):
+                has_bias = True
+                break
+        if not has_bias:
+            print(f"No bias found for run {run} in format:")

hcam_obsutils-0.0.2.dist-info/METADATA

@@ -0,0 +1,21 @@
+Metadata-Version: 2.4
+Name: hcam_obsutils
+Version: 0.0.2
+Summary: A collection of utility scripts for observing with HiPERCAM and ULTRACAM.
+Project-URL: Homepage, https://github.com/hipercam/hcam_obsutils
+Project-URL: Issues, https://github.com/hipercam/hcam_obsutils/issues
+Author-email: Stuart Littlefair <s.littlefair@sheffield.ac.uk>, Martin Dyer <m.j.dyer@sheffield.ac.uk>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Requires-Dist: astropy
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: trm-cline
+Description-Content-Type: text/markdown
+
+# HCAM Obsutils
+
+This is a package containing useful scripts for observing with the instruments HiPERCAM, ULTRACAM and ULTRASPEC.

hcam_obsutils-0.0.2.dist-info/RECORD

@@ -0,0 +1,8 @@
+hcam_obsutils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hcam_obsutils/scripts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hcam_obsutils/scripts/missbias.py,sha256=odpTJvF-uGAo9vBKUlz8VVMpVthOXlzwbipU1-kwx4E,4374
+hcam_obsutils-0.0.2.dist-info/METADATA,sha256=6UQH98r2baSYd5t8wZjLjN5m5xAg6fYa6XewuOJedHg,803
+hcam_obsutils-0.0.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+hcam_obsutils-0.0.2.dist-info/entry_points.txt,sha256=Eyri_5Qwg0RPWgrgLDal63i0aGP8zfP9xU9szGhOr5Q,65
+hcam_obsutils-0.0.2.dist-info/licenses/LICENSE,sha256=2bm9uFabQZ3Ykb_SaSU_uUbAj2-htc6WJQmS_65qD00,1073
+hcam_obsutils-0.0.2.dist-info/RECORD,,

hcam_obsutils-0.0.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

hcam_obsutils-0.0.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+missbias = hcam_obsutils.scripts.missbias:main

hcam_obsutils-0.0.2.dist-info/licenses/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2018 The Python Packaging Authority
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.