add a few doc strings

src/calculations/qrange.test.ts

@@ -1,4 +1,4 @@
-import { expect, test } from "vitest";
+import { test } from "vitest";
 import { computeQrange } from "./qrange";
 import {
   BeamlineConfig,
@@ -39,5 +39,4 @@ test("Test getting q from pixel position ", () => {
 
   const result = computeQrange(detector, beamstop, cameraTube, beamConfig);
   console.log(result);
-  expect(result).toBeTruthy();
 });

src/calculations/qrange.ts

@@ -10,7 +10,14 @@ import {
 } from "../utils/types";
 import { Vector3, Vector4 } from "three";
 import { Ray } from "../calculations/ray";
-
+/**
+ * Compute the viable and full qranges 
+ * @param detector 
+ * @param beamstop 
+ * @param cameraTube 
+ * @param beamProperties 
+ * @returns 
+ */
 export function computeQrange(
   detector: Detector,
   beamstop: Beamstop,
@@ -37,6 +44,8 @@ export function computeQrange(
     detector.resolution.height,
   );
 
+  console.log(t1)
+
   if (t1 != null && cameraTube != null && cameraTube.diameter != 0) {
     t1 = t1.intersect(
       ray.getCircleIntersectionParameterRange(

src/calculations/ray.ts

@@ -48,6 +48,7 @@ export class Ray {
       coeffOfx2 * Math.pow(this.direction.x, 2) +
       coeffOfxy * this.direction.x * this.direction.y +
       coeffOfy2 * Math.pow(this.direction.y, 2);
+
     const b =
       2 * coeffOfx2 * this.direction.x * this.initial_point.x +
       coeffOfxy *
@@ -56,15 +57,18 @@ export class Ray {
       2 * coeffOfy2 * this.direction.y * this.initial_point.y +
       coeffOfx * this.direction.x +
       coeffOfy * this.direction.y;
+
     const c =
       coeffOfx2 * Math.pow(this.initial_point.x, 2) +
       coeffOfxy * this.initial_point.x * this.initial_point.y +
       coeffOfy2 * Math.pow(this.initial_point.y, 2) +
       coeffOfx * this.initial_point.x +
       coeffOfy * this.initial_point.y +
       constant;
-
+
+    console.log("stuff")
     const discriminant = Math.pow(b, 2) - 4 * a * c;
+    console.log(discriminant)
     if (discriminant < 0) return null;
     if (a == 0) {
       if (b == 0)

src/utils/units.ts

@@ -48,7 +48,6 @@ export const energy2WavelengthConverter = (energy: number): number => {
  * @returns
  */
 export const wavelength2EnergyConverter = (wavelength: number): number => {
-  //wavelength in nm
   return ((PLANCK * CSPEED) / (wavelength * 1e9)) * 6.242e15;
 };