Implement particle filtering for neuland simulation #1083

SimonL2718 · 2024-10-28T15:02:24Z

New features:

Allow filtering for certain particles during digitization. Setup is done within neulandAna.cxx executable.

Checklist:

Rebased against dev branch
My name is in the resp. CONTRIBUTORS/AUTHORS file
Followed the pull request guidlines and the Git workflow
Followed the seven rules of great commit messages

YanzhaoW · 2024-10-28T15:51:15Z

Hi @jose-luis-rs . @SimonL2718 is a bachelor student from my group. Could you add him to the contributors such that the CI workflow could run?

YanzhaoW

Hi, Simon

I leave some comments. Please fix them.

YanzhaoW · 2024-10-28T15:52:40Z

CMakeLists.txt

@@ -549,6 +549,7 @@ if(NOT MODULE)
    add_subdirectory(tracking)
    add_subdirectory(passive)
    add_subdirectory(tcal)
+    add_subdirectory(r3bgen)


Maybe don't change it here.

Should it be with the entries for r3bbase and r3bdata or somewhere else entirely?

Hi, just revert back to the dev version. (between music and lumon).

YanzhaoW · 2024-10-28T15:57:06Z

neuland/digitizing/NeulandPointFilter.h

+    void SetFilter(R3B::Neuland::BitSetParticle filtered_particles, double minimum_allowed_energy);
+    [[nodiscard]] auto GetFilter() const -> R3B::Neuland::BitSetParticle { return filtered_particles_; }
+    [[nodiscard]] auto GetMinimumAllowedEnergy() const -> double { return minimum_allowed_energy_; }
+    auto ShouldNeulandPointBeFiltered(const R3BNeulandPoint& neuland_point) -> bool;


The function name is too long. Your input parameter already contains NeulandPoint type and you don't need to mention it again in the function name.

Suggested change

auto ShouldNeulandPointBeFiltered(const R3BNeulandPoint& neuland_point) -> bool;

auto CheckFiltered(const R3BNeulandPoint& neuland_point) -> bool;

YanzhaoW · 2024-10-28T15:57:49Z

neuland/digitizing/NeulandPointFilter.h

+    // energy in GeV
+    double minimum_allowed_energy_ = 0;


Put the comments in the same line.

Suggested change

// energy in GeV

double minimum_allowed_energy_ = 0;

double minimum_allowed_energy_ = 0; // energy in GeV

YanzhaoW · 2024-10-28T16:12:13Z

neuland/executables/neulandSim.cxx

+    auto const neutron_PID = 2112;
+    auto const Sn_p = int{ 50 };
+    auto const Sn_z = int{ 123 };
+    auto const BeamEnergyAtTarget = 883.;


Suggested change

auto const neutron_PID = 2112;

auto const Sn_p = int{ 50 };

auto const Sn_z = int{ 123 };

auto const BeamEnergyAtTarget = 883.;

constexpr auto neutron_PID = 2112;

constexpr auto Sn_p = 50;

constexpr auto Sn_z = 123;

constexpr auto BeamEnergyAtTarget = 883.;

YanzhaoW · 2024-10-28T16:14:26Z

neuland/simulation/R3BNeuland.cxx

+constexpr auto seconds_to_nanoseconds = 1e9;
+static constexpr double BirkdP = 1.032;
+static constexpr double BirkC1 = 0.013 / BirkdP;
+static constexpr double BirkC2 = 9.6e-6 / (BirkdP * BirkdP);


Suggested change

constexpr auto seconds_to_nanoseconds = 1e9;

static constexpr double BirkdP = 1.032;

static constexpr double BirkC1 = 0.013 / BirkdP;

static constexpr double BirkC2 = 9.6e-6 / (BirkdP * BirkdP);

constexpr auto seconds_to_nanoseconds = 1e9;

constexpr auto BirkdP = 1.032;

constexpr auto BirkC1 = 0.013 / BirkdP;

constexpr auto BirkC2 = 9.6e-6 / (BirkdP * BirkdP);

YanzhaoW · 2024-10-28T16:14:57Z

neuland/simulation/R3BNeuland.cxx

 {
    // Apply Birk's law ( Adapted from G3BIRK/Geant3)
    if (charge != 0 && length > 0)
    {
-        Double_t birkC1Mod = BirkC1;
+        double birkC1Mod = BirkC1;


Suggested change

double birkC1Mod = BirkC1;

constexpr auto birkC1Mod = BirkC1;

YanzhaoW · 2024-10-28T16:29:02Z

r3bdata/neulandData/R3BNeulandPoint.h

        : FairMCPoint(point)
        , fLightYield(lightYield)
+        , particle_id_(particle_id)
+        , parent_particle_id_(parent_particle_id)


Use curly brackets:

Suggested change

: FairMCPoint(point)

, fLightYield(lightYield)

, particle_id_(particle_id)

, parent_particle_id_(parent_particle_id)

: FairMCPoint { point }

, fLightYield{ lightYield }

, particle_id_{ particle_id }

, parent_particle_id_{ parent_particle_id}

Should I change this for other construction methods of NeulandPoints aswell or just this one in particular?

Yes, better change the other construction methods of neuland points.

YanzhaoW

Here are some tips to fix the warnings from Clang-tidy

YanzhaoW · 2024-11-01T15:18:26Z

r3bdata/neulandData/R3BNeulandPoint.h

+                    const Double_t lightYield,
+                    const int particle_id,
+                    const int parent_particle_id)


We could just tell static analyser to ignore this warning by adding NOLINTBEGIN and NOLINTEND

// NOLINTBEGIN R3BNeulandPoint(const Int_t trackID, const Int_t detID, const TVector3& pos, const TVector3& mom, const Double_t tof, const Double_t length, const Double_t eLoss, const UInt_t EventId, const Double_t lightYield, const int particle_id, const int parent_particle_id) // NOLINTEND

YanzhaoW · 2024-11-01T15:20:43Z

neuland/test/digitizing/testNeulandPointFilter.cxx

+        constexpr auto neutron_pid = 2112;
+        constexpr auto eLoss_proton = 0.7;
+        constexpr auto eLoss_neutron = 0.3;
+        TVector3 sample_vector;


Suggested change

TVector3 sample_vector;

const auto sample_vector = TVector3{};

NOTE: you should always use following style to initialize a variable:

auto var_name = Type {}; // const auto if necessary

YanzhaoW · 2024-11-01T15:21:41Z

neuland/test/digitizing/testNeulandPointFilter.cxx

+
+        NeulandPointFilter filter;
+
+        R3BNeulandPoint protonPoint(0, 0, sample_vector, sample_vector, 0., 0., eLoss_proton, 0, 0., proton_pid, 0);


Suggested change

R3BNeulandPoint protonPoint(0, 0, sample_vector, sample_vector, 0., 0., eLoss_proton, 0, 0., proton_pid, 0);

const auto protonPoint = R3BNeulandPoint {0, 0, sample_vector, sample_vector, 0., 0., eLoss_proton, 0, 0., proton_pid, 0};

YanzhaoW · 2024-11-01T15:22:08Z

neuland/test/digitizing/testNeulandPointFilter.cxx

+        NeulandPointFilter filter;
+
+        R3BNeulandPoint protonPoint(0, 0, sample_vector, sample_vector, 0., 0., eLoss_proton, 0, 0., proton_pid, 0);
+        R3BNeulandPoint neutronPoint(0, 0, sample_vector, sample_vector, 0., 0., eLoss_neutron, 0, 0., neutron_pid, 0);


Suggested change

R3BNeulandPoint neutronPoint(0, 0, sample_vector, sample_vector, 0., 0., eLoss_neutron, 0, 0., neutron_pid, 0);

const auto neutronPoint = R3BNeulandPoint {0, 0, sample_vector, sample_vector, 0., 0., eLoss_neutron, 0, 0., neutron_pid, 0};

YanzhaoW · 2024-11-01T15:25:23Z

To fix the clang-format issue, just click its "Details", find the file names, go there and use "Space f m" to autoformat the file in neovim.

YanzhaoW · 2024-11-14T22:46:34Z

r3bdata/neulandData/R3BNeulandPoint.h

    R3BNeulandPoint()
        : FairMCPoint{}


Suggested change

R3BNeulandPoint()

: FairMCPoint{}

R3BNeulandPoint()

YanzhaoW · 2024-11-14T22:48:47Z

r3bdata/neulandData/R3BNeulandPoint.h

@@ -42,21 +42,21 @@ class R3BNeulandPoint : public FairMCPoint
                    const Double_t lightYield,


Just disable this warning by:

// NOLINTBEGIN R3BNeulandPoint(const Int_t trackID, const Int_t detID, const TVector3& pos, const TVector3& mom, const Double_t tof, const Double_t length, const Double_t eLoss, const UInt_t EventId, const int particle_id, const int parent_particle_id) // NOLINTEND

jose-luis-rs · 2024-12-01T11:29:31Z

Hi, this branch was squashed in #1084

jose-luis-rs · 2024-12-03T14:29:32Z

Please @SimonL2718 reopen this PR. It should be approved by the NeuLAND WG before merging.

YanzhaoW · 2024-12-03T21:43:07Z

Please see this #1086 for the further discussion.

YanzhaoW reviewed Oct 28, 2024

View reviewed changes

YanzhaoW reviewed Nov 1, 2024

View reviewed changes

YanzhaoW reviewed Nov 14, 2024

View reviewed changes

YanzhaoW mentioned this pull request Nov 28, 2024

code for main exp R3BRootGroup/asyeos#28

Merged

4 tasks

Implement particle filtering via NeulandPointFilter

e652eda

SimonL2718 force-pushed the slonzenbranch branch from f84289d to e652eda Compare December 1, 2024 11:53

jose-luis-rs merged commit e34265b into R3BRootGroup:dev Dec 1, 2024
6 checks passed

jose-luis-rs mentioned this pull request Dec 3, 2024

Revert "Implement particle filtering for neuland simulation" #1086

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement particle filtering for neuland simulation #1083

Implement particle filtering for neuland simulation #1083

SimonL2718 commented Oct 28, 2024

YanzhaoW commented Oct 28, 2024

YanzhaoW left a comment

YanzhaoW Oct 28, 2024

SimonL2718 Oct 29, 2024

YanzhaoW Oct 29, 2024

YanzhaoW Oct 28, 2024

YanzhaoW Oct 28, 2024

YanzhaoW Oct 28, 2024

YanzhaoW Oct 28, 2024

YanzhaoW Oct 28, 2024

YanzhaoW Oct 28, 2024

SimonL2718 Oct 29, 2024

YanzhaoW Oct 29, 2024

YanzhaoW left a comment

YanzhaoW Nov 1, 2024

YanzhaoW Nov 1, 2024

YanzhaoW Nov 1, 2024

YanzhaoW Nov 1, 2024

YanzhaoW commented Nov 1, 2024

YanzhaoW Nov 14, 2024

YanzhaoW Nov 14, 2024

jose-luis-rs commented Dec 1, 2024

jose-luis-rs commented Dec 3, 2024

YanzhaoW commented Dec 3, 2024

	auto ShouldNeulandPointBeFiltered(const R3BNeulandPoint& neuland_point) -> bool;
	auto CheckFiltered(const R3BNeulandPoint& neuland_point) -> bool;

	// energy in GeV
	double minimum_allowed_energy_ = 0;
	double minimum_allowed_energy_ = 0; // energy in GeV

	double birkC1Mod = BirkC1;
	constexpr auto birkC1Mod = BirkC1;

	TVector3 sample_vector;
	const auto sample_vector = TVector3{};


		NeulandPointFilter filter;

		R3BNeulandPoint protonPoint(0, 0, sample_vector, sample_vector, 0., 0., eLoss_proton, 0, 0., proton_pid, 0);

	R3BNeulandPoint protonPoint(0, 0, sample_vector, sample_vector, 0., 0., eLoss_proton, 0, 0., proton_pid, 0);
	const auto protonPoint = R3BNeulandPoint {0, 0, sample_vector, sample_vector, 0., 0., eLoss_proton, 0, 0., proton_pid, 0};

	R3BNeulandPoint neutronPoint(0, 0, sample_vector, sample_vector, 0., 0., eLoss_neutron, 0, 0., neutron_pid, 0);
	const auto neutronPoint = R3BNeulandPoint {0, 0, sample_vector, sample_vector, 0., 0., eLoss_neutron, 0, 0., neutron_pid, 0};

		@@ -42,21 +42,21 @@ class R3BNeulandPoint : public FairMCPoint
		const Double_t lightYield,

Implement particle filtering for neuland simulation #1083

Implement particle filtering for neuland simulation #1083

Conversation

SimonL2718 commented Oct 28, 2024

New features:

YanzhaoW commented Oct 28, 2024

YanzhaoW left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

YanzhaoW left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

YanzhaoW commented Nov 1, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jose-luis-rs commented Dec 1, 2024

jose-luis-rs commented Dec 3, 2024

YanzhaoW commented Dec 3, 2024