Skip to content

Commit

Permalink
Update some comments
Browse files Browse the repository at this point in the history
  • Loading branch information
jbeilstenedmands committed Jan 20, 2025
1 parent 3898dc0 commit de68a87
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 4 deletions.
13 changes: 13 additions & 0 deletions include/dx2/beam.h
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
8 changes: 4 additions & 4 deletions include/dx2/detector.h
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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);
Expand Down

0 comments on commit de68a87

Please sign in to comment.