field line options and examples

Author: maureeungaro

gemc/g4display/g4display_options.cc

@@ -196,6 +196,15 @@ GOptions defineOptions() {
 
 	goptions.defineOption("g4decoration", "Adds optional Geant4 scene decorations", g4decoration, help);
 
+	help = "Display magnetic field lines in the initial visualization scene. \n \n";
+	help += "The value is the number of field-line integration points. Set to 0 to disable. \n \n";
+	help += "Example: -show_field_lines=100 \n";
+	goptions.defineOption(GVariable("show_field_lines", 0, "number of field-line points to display"), help);
+
+	help = "Display auxiliary edges in the initial visualization scene. \n \n";
+	help += "Example: -show_auxiliary_edges=true \n";
+	goptions.defineOption(GVariable("show_auxiliary_edges", false, "show auxiliary volume edges"), help);
+
 	// scenetext
 	goptions.addGOptions(addSceneTextsOptions());
 

gemc/g4display/tabs/g4displayview.cc

@@ -447,6 +447,7 @@ G4DisplayView::G4DisplayView(const std::shared_ptr<GOptions>& gopts,
 	// X slice controls.
 	sliceXEdit = new QLineEdit(tr("0"));
 	sliceXEdit->setMaximumWidth(100);
+	sliceXEdit->setValidator(new QDoubleValidator(sliceXEdit));
 	sliceXActi = new QCheckBox(tr("&On"));
 	sliceXActi->setChecked(false);
 	sliceXInve = new QCheckBox(tr("&Flip"));
@@ -465,6 +466,7 @@ G4DisplayView::G4DisplayView(const std::shared_ptr<GOptions>& gopts,
 	// Y slice controls.
 	sliceYEdit = new QLineEdit(tr("0"));
 	sliceYEdit->setMaximumWidth(100);
+	sliceYEdit->setValidator(new QDoubleValidator(sliceYEdit));
 	sliceYActi = new QCheckBox(tr("&On"));
 	sliceYActi->setChecked(false);
 	sliceYInve = new QCheckBox(tr("&Flip"));
@@ -483,6 +485,7 @@ G4DisplayView::G4DisplayView(const std::shared_ptr<GOptions>& gopts,
 	// Z slice controls.
 	sliceZEdit = new QLineEdit(tr("0"));
 	sliceZEdit->setMaximumWidth(100);
+	sliceZEdit->setValidator(new QDoubleValidator(sliceZEdit));
 	sliceZActi = new QCheckBox(tr("&On"));
 	sliceZActi->setChecked(false);
 	sliceZInve = new QCheckBox(tr("&Flip"));
@@ -801,39 +804,45 @@ void G4DisplayView::slice() {
 	if (sliceSectn->isChecked()) { g4uim->ApplyCommand("/vis/viewer/set/cutawayMode intersection"); }
 	else if (sliceUnion->isChecked()) { g4uim->ApplyCommand("/vis/viewer/set/cutawayMode union"); }
 
-	// Clear again to ensure mode change does not retain previously-defined planes.
-	g4uim->ApplyCommand("/vis/viewer/clearCutawayPlanes");
-
 	// For each enabled axis, add a plane at the requested position. Values are interpreted as mm.
 	if (sliceXActi->isChecked()) {
 		string command = "/vis/viewer/addCutawayPlane " + sliceXEdit->text().toStdString() + " 0  0 mm " +
 			to_string(sliceXInve->isChecked() ? -1 : 1) + " 0 0 ";
-		cout << "X " << command << endl;
 		g4uim->ApplyCommand(command);
 	}
 
 	if (sliceYActi->isChecked()) {
 		string command = "/vis/viewer/addCutawayPlane 0 " + sliceYEdit->text().toStdString() + " 0 mm 0 " +
 			to_string(sliceYInve->isChecked() ? -1 : 1) + " 0 ";
-		cout << "Y " << command << endl;
 		g4uim->ApplyCommand(command);
 	}
 
 	if (sliceZActi->isChecked()) {
 		string command = "/vis/viewer/addCutawayPlane 0 0 " + sliceZEdit->text().toStdString() + " mm 0 0 " +
 			to_string(sliceZInve->isChecked() ? -1 : 1);
-		cout << "Z " << command << endl;
 		g4uim->ApplyCommand(command);
 	}
+
+	g4uim->ApplyCommand("/vis/viewer/rebuild");
+	g4uim->ApplyCommand("/vis/viewer/flush");
 }
 
 void G4DisplayView::clearSlices() {
 	// Clear cutaway planes in the viewer and reset activation UI state.
-	G4UImanager::GetUIpointer()->ApplyCommand("/vis/viewer/clearCutawayPlanes");
+	G4UImanager* g4uim = G4UImanager::GetUIpointer();
+	if (g4uim == nullptr) { return; }
+
+	QSignalBlocker blockX(sliceXActi);
+	QSignalBlocker blockY(sliceYActi);
+	QSignalBlocker blockZ(sliceZActi);
 
-	// NOTE: Only X is reset here in the current implementation; Y/Z are left unchanged.
-	// This behavior is preserved intentionally (no logic changes).
 	sliceXActi->setChecked(false);
+	sliceYActi->setChecked(false);
+	sliceZActi->setChecked(false);
+
+	g4uim->ApplyCommand("/vis/viewer/clearCutawayPlanes");
+	g4uim->ApplyCommand("/vis/viewer/rebuild");
+	g4uim->ApplyCommand("/vis/viewer/flush");
 }
 
 void G4DisplayView::apply_buttons_set1(int index) {

gemc/utilities/gemcUtilities.cc

@@ -17,6 +17,57 @@
 #include "g4SceneProperties.h"
 #include "g4display_options.h"
 
+#include <algorithm>
+#include <cctype>
+#include <cstdlib>
+#include <iostream>
+#include <sstream>
+
+namespace {
+bool scalarOptionIsTrue(const std::shared_ptr<GOptions>& gopts, const std::string& name) {
+	if (gopts == nullptr) { return false; }
+
+	std::string value = gopts->getScalarString(name);
+	std::transform(value.begin(), value.end(), value.begin(),
+	               [](unsigned char c) { return static_cast<char>(std::tolower(c)); });
+
+	if (value == "true" || value == "yes" || value == "on" || value == "1") {
+		return true;
+	}
+	if (value == "false" || value == "no" || value == "off" || value == "0" || value == "null") {
+		return false;
+	}
+
+	std::cerr << FATALERRORL << "The option " << name
+	          << " accepts only true/false/yes/no/on/off/1/0." << std::endl;
+	std::exit(EC__NOOPTIONFOUND);
+}
+
+std::string rootExtentForFieldCommand(const std::shared_ptr<GOptions>& gopts) {
+	if (gopts == nullptr) { return ""; }
+
+	std::string rootDefinition = gopts->getScalarString("root");
+	for (auto& c : rootDefinition) {
+		if (c == ',') { c = ' '; }
+	}
+
+	const auto tokens = gutilities::getStringVectorFromString(rootDefinition);
+	if (tokens.size() < 5 || tokens[0] != "G4Box") { return ""; }
+
+	const double dx = gutilities::getG4Number(tokens[1]);
+	const double dy = gutilities::getG4Number(tokens[2]);
+	const double dz = gutilities::getG4Number(tokens[3]);
+	if (dx <= 0 || dy <= 0 || dz <= 0) { return ""; }
+
+	std::ostringstream command;
+	command << "/vis/set/extentForField "
+	        << -dx << " " << dx << " "
+	        << -dy << " " << dy << " "
+	        << -dz << " " << dz << " mm";
+	return command.str();
+}
+}
+
 namespace gemc {
 	// return the number of cores from options.
 	// if 0 is given, returns max number of available cores
@@ -154,6 +205,19 @@ namespace gemc {
 		for (const auto& command : g4SceneProperties.addSceneTexts(gopts)) { cmds.emplace_back(command); }
 		if (decorations.eventID) { cmds.emplace_back("/vis/scene/add/eventID"); }
 
+		if (scalarOptionIsTrue(gopts, "show_auxiliary_edges")) {
+			cmds.emplace_back("/vis/viewer/set/auxiliaryEdge 1");
+			cmds.emplace_back("/vis/viewer/set/hiddenEdge 1");
+		}
+
+		const int fieldLinePoints = gopts->getScalarInt("show_field_lines");
+		if (fieldLinePoints > 0) {
+			if (const auto extent = rootExtentForFieldCommand(gopts); !extent.empty()) {
+				cmds.emplace_back(extent);
+			}
+			cmds.emplace_back("/vis/scene/add/magneticField " + std::to_string(fieldLinePoints));
+		}
+
 		// do not draw volumes in batch screenshot
 		if (g4view.driver != "TOOLSSG_OFFSCREEN") {
 			// Re-enable refresh and flush once configuration is complete.

releases/0.4.md

@@ -8,6 +8,9 @@ This version includes:
   are no longer loaded.
 - A new `asciimap` field plugin (`type: asciimap`) that loads ASCII field maps from data-only files
   with the grid defined in YAML — the GEMC3 successor of the clas12 `asciiField`.
+- Field-only runs now initialize against the default ROOT world when no detector system is selected.
+- New source examples under `examples/fields/` for torus, dipole, solenoid, and constant fields.
+- New visualization startup options, `-show_field_lines=<n>` and `-show_auxiliary_edges=<bool>`.
 - Field-line visualization now derives the sampling extent from the configured ROOT `G4Box` before
   adding Geant4's magnetic-field model.
 - A `-log_every=N[-NTH]` option for periodic per-event progress logging with the running average rate.
@@ -55,6 +58,14 @@ This version includes:
   the `dipole-{x,y,z}`, `cylindrical-{x,y,z}`, `phi-segmented`, and `cartesian_3D[_quadrant]`
   symmetries, `linear`/`none` interpolation, a `scale` factor, and `vx,vy,vz` / `rx,ry,rz` map
   placement. The map file is resolved next to its YAML definition, so a plain `.yaml` runs directly.
+- Field-only configurations can now start without selecting a detector system. GEMC treats configured
+  field definitions as startup geometry, attaches a single configured field to ROOT when appropriate,
+  and adds a visible viewer volume for the default ROOT world so `-gui` has an extent to frame.
+- Added `-show_field_lines=<n>` to add Geant4 magnetic-field lines during visualization startup. A
+  value of `0` disables the model; positive values are passed to `/vis/scene/add/magneticField`.
+- Added `-show_auxiliary_edges=<bool>` to enable auxiliary volume edges at visualization startup. The
+  option accepts `true/false/yes/no/on/off/1/0` and also enables hidden edges, matching the GUI button
+  behavior.
 
 <br/>
 
@@ -74,6 +85,11 @@ This version includes:
 - Added `asciimap` examples under the gfields module: `asciimap_dipole.yaml` (dipole-z), and the
   clas12 `solenoid.yaml` (cylindrical-z) and `torus.yaml` (phi-segmented) maps translated from their
   legacy `<mfield>` headers, each with a small but complete data-only map file.
+- Added a top-level `examples/fields/` category with runnable torus, dipole, solenoid, and constant
+  field display examples. The torus and solenoid examples use ASCII field maps, and each example has
+  a simple enclosing solid chosen to make the field region visible in the Geant4 viewer.
+- Added `show_field_lines` and `show_auxiliary_edges` entries to the example YAML files. General
+  examples leave them disabled, while the field-display examples enable them by default.
 
 <br/>
 
@@ -133,6 +149,9 @@ Both x86_64 and ARM64 platforms are supported.
   or by `-global_field`), instead of every configured `gmultipoles`/`gfields` entry. A field that no
   volume references — including any reset via `-no_field` — has its plugin and map skipped. The
   `-fieldAt` / `-fieldMapPoints` query path is unaffected and still loads all configured fields.
+- Field-only GUI runs no longer require selecting a detector system first. If exactly one configured
+  field is present and no explicit `global_field` is set, GEMC attaches that field to the default
+  ROOT world for visualization startup.
 
 <br/>
 
@@ -193,3 +212,17 @@ Both x86_64 and ARM64 platforms are supported.
   the YAML that defined the field.
 - The gfields example driver now probes every configured field by name (`GMagneto::getFieldNames`)
   instead of a hardcoded `dipole`, so it works for the multipole, solenoid, and torus examples alike.
+- Startup now proceeds for field-only configurations even when no detector system is selected. The
+  detector construction can auto-attach a single configured field to ROOT when no explicit
+  `global_field` is set, and the default ROOT-only scene includes a visible viewer box so Geant4 has
+  an extent for camera setup.
+- Added `examples/fields/constant`, `examples/fields/dipole`, `examples/fields/solenoid`, and
+  `examples/fields/torus`. The examples cover constant and multipole fields plus solenoid and torus
+  ASCII field maps, each with a simple visible enclosing solid suited to its field shape.
+- Added the scalar display option `show_field_lines`, available as `-show_field_lines=<n>` and from
+  YAML. Positive values emit `/vis/scene/add/magneticField <n>` after setting the field extent from
+  the configured ROOT `G4Box`; `0` keeps field lines disabled.
+- Added the scalar display option `show_auxiliary_edges`, available as `-show_auxiliary_edges=<bool>`
+  and from YAML. When enabled, startup emits `/vis/viewer/set/auxiliaryEdge 1` and
+  `/vis/viewer/set/hiddenEdge 1`, preserving the same paired behavior as the GUI auxiliary-edges
+  toggle.