Python style clean-up

- style by VS code
- added more type hints

python/prd_generator.py

@@ -2,7 +2,7 @@
 import math
 import random
 import numpy
-
+from collections.abc import Iterator
 import prd
 
 # these are constants for now
@@ -13,40 +13,47 @@
 NUMBER_OF_EVENTS = 1000
 COUNT_RATE = 500
 
+
 # single ring as example
-def get_scanner_info():
+def get_scanner_info() -> prd.ScannerInformation:
     radius = RADIUS
     angles = [2 * math.pi * i / 10 for i in range(10)]
     detectors = [
         prd.Detector(x=x, y=y, z=0, id=i)
-        for i, (x,y) in enumerate(
-            (radius*math.sin(angle), radius*math.cos(angle)) for angle in angles
+        for i, (x, y) in enumerate(
+            (radius * math.sin(angle), radius * math.cos(angle)) for angle in angles
         )
     ]
     # TOF info (in mm)
-    tofBinEdges = numpy.linspace(-RADIUS, RADIUS, NUMBER_OF_TOF_BINS+1, dtype='float32')
-    energyBinEdges = numpy.linspace(430, 650, NUMBER_OF_ENERGY_BINS+1, dtype='float32')
+    tofBinEdges = numpy.linspace(
+        -RADIUS, RADIUS, NUMBER_OF_TOF_BINS + 1, dtype="float32"
+    )
+    energyBinEdges = numpy.linspace(
+        430, 650, NUMBER_OF_ENERGY_BINS + 1, dtype="float32"
+    )
     return prd.ScannerInformation(
         detectors=detectors,
         tof_bin_edges=tofBinEdges,
-        tof_resolution=9.4, # in mm
-        energy_bin_edges = energyBinEdges,
-        energy_resolution_at_511 = .11, # as fraction of 511
-        listmode_time_block_duration = 1 # ms
+        tof_resolution=9.4,  # in mm
+        energy_bin_edges=energyBinEdges,
+        energy_resolution_at_511=0.11,  # as fraction of 511
+        listmode_time_block_duration=1,  # ms
     )
 
-def get_header():
-    subject=prd.Subject(id="123456")
-    institution=prd.Institution(
+
+def get_header() -> prd.Header:
+    subject = prd.Subject(id="123456")
+    institution = prd.Institution(
         name="Diamond Light Source",
         address="Harwell Science and Innovation Campus, Didcot, Oxfordshire, OX11 0DE, UK",
-        )
+    )
     return prd.Header(
-        exam = prd.ExamInformation(subject=subject, institution=institution),
+        exam=prd.ExamInformation(subject=subject, institution=institution),
         scanner=get_scanner_info(),
     )
 
-def get_events(header: prd.Header, num_events):
+
+def get_events(header: prd.Header, num_events: int) -> Iterator[prd.CoincidenceEvent]:
     detector_count = header.scanner.number_of_detectors()
     for _ in range(num_events):
         yield prd.CoincidenceEvent(
@@ -57,16 +64,19 @@ def get_events(header: prd.Header, num_events):
             tof_idx=random.randrange(0, NUMBER_OF_TOF_BINS),
         )
 
+
 if __name__ == "__main__":
     # numpy random number generator
     rng = numpy.random.default_rng()
 
     with prd.BinaryPrdExperimentWriter(sys.stdout.buffer) as writer:
-    #with prd.NDJsonPrdExperimentWriter(sys.stdout) as writer:
+        # with prd.NDJsonPrdExperimentWriter(sys.stdout) as writer:
         header = get_header()
         writer.write_header(header)
         for t in range(NUMBER_OF_TIME_BLOCKS):
             num_prompts_this_block = rng.poisson(COUNT_RATE)
             prompts_this_block = list(get_events(header, num_prompts_this_block))
             # Normally we'd write multiple blocks, but here we have just one, so let's write a tuple with just one element
-            writer.write_time_blocks((prd.TimeBlock(id=t, prompt_events=prompts_this_block),))
+            writer.write_time_blocks(
+                (prd.TimeBlock(id=t, prompt_events=prompts_this_block),)
+            )