more notes

DiamondLightSource · Nov 17, 2023 · feb8cdf · feb8cdf
1 parent 54ab67d
commit feb8cdf
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 6 deletions.
diff --git a/src/calculations/numericRange.ts b/src/calculations/numericRange.ts
@@ -16,7 +16,7 @@ export default class NumericRange {
     }
   }
   /**
-   * Returns true if a value falls inside the numeric range
+   * Returns true if the input value falls inside the numeric range
    * @param value a number
    * @returns
    */
@@ -68,7 +68,7 @@ export default class NumericRange {
   }
 
   /**
-   * Returns a 
+   * Returns a new numeric range with the function applied elementwise
    * @param func A function to apply to both the min and max of the range
    * @returns A new Numeric range with the call back applied
    */

diff --git a/src/calculations/qrange.ts b/src/calculations/qrange.ts
@@ -10,8 +10,8 @@ import { Ray } from "../calculations/ray";
 import NumericRange from "./numericRange";
 
 /**
- * Compute the viable and full qranges
- * @param detector
+ * Compute the viable and full qranges 
+ * @param detector Detector object with data on how the detector e
  * @param beamstop
  * @param cameraTube
  * @param beamProperties
@@ -92,8 +92,6 @@ export function computeQrange(
   const ptMin = ray.getPoint(t1.min);
   const ptMax = ray.getPoint(t1.max);
 
-  // works as intended up to here
-
   const detProps: DetectorProperties = {
     ...detector,
     origin: new Vector3(