From de68a870031fbb89bc2f0c38600d26ceded4f0f8 Mon Sep 17 00:00:00 2001
From: James Beilsten-Edmands
 <30625594+jbeilstenedmands@users.noreply.github.com>
Date: Mon, 20 Jan 2025 15:14:16 +0000
Subject: [PATCH] Update some comments

---
 include/dx2/beam.h     | 13 +++++++++++++
 include/dx2/detector.h |  8 ++++----
 2 files changed, 17 insertions(+), 4 deletions(-)

diff --git a/include/dx2/beam.h b/include/dx2/beam.h
index 8891a0f..f5e6d39 100644
--- a/include/dx2/beam.h
+++ b/include/dx2/beam.h
@@ -6,6 +6,19 @@
 using Eigen::Vector3d;
 using json = nlohmann::json;
 
+/*
+This file defines a set of Beam classes.
+
+BeamBase defines most of the class attributes except the wavelength.
+
+The two subclasses are MonochromaticBeam and PolychromaticBeam,
+which define a single wavelength or wavelength range respectively.
+
+MonochromaticBeam is subclassed further into MonoXrayBeam and
+MonoElectronBeam, these simply set the correct probe name
+when serializing/deserializing to/from json.
+*/
+
 class BeamBase {
 // A base class for beam objects
 public:
diff --git a/include/dx2/detector.h b/include/dx2/detector.h
index 0009446..6a657e6 100644
--- a/include/dx2/detector.h
+++ b/include/dx2/detector.h
@@ -8,9 +8,6 @@ using json = nlohmann::json;
 using Eigen::Matrix3d;
 using Eigen::Vector3d;
 
-// End goal would be to separate everything out by detector panel on data
-// as well as model side?
-
 double attenuation_length(double mu, double t0,
                                    Vector3d s1,
                                    Vector3d fast,
@@ -27,7 +24,10 @@ double attenuation_length(double mu, double t0,
 }
 
 class Panel {
-// A class to represent a single-panel detector i.e. non-hierarchical
+// A class to represent a single "panel" of a detector (i.e. what data are
+// considered to be described by a single set of panel parameters for the
+// purposes of data processing, which may consist of several real detector
+// modules).
 public:
     Panel()=default;
     Panel(json panel_data);