Made deposition along x or in the x-y plane possible. (e29788b1) · Commits · XRFLab109 / Allpix Squared

src/modules/DepositionPointCharge/DepositionPointChargeModule.cpp

+42 −2

Original line number	Diff line number	Diff line
		@@ -93,9 +93,48 @@ void DepositionPointChargeModule::initialize() {
		// Get the config manager and retrieve total number of events:
		ConfigManager* conf_manager = getConfigManager();
		auto events = conf_manager->getGlobalConfiguration().get<unsigned int>("number_of_events");
		auto scan_coordinates_ = config_.getArray<std::string>("scan_coordinates", {"x", "y", "z"});

		// Scan with points required 3D scanning, scan with MIPs only 2D:
		if(type_ == SourceType::MIP) {
		if(scan_coordinates_.size() == 1) {
		root_ = events;
		// Calculate voxel size:
		if(std::find(scan_coordinates_.begin(), scan_coordinates_.end(), "x") != scan_coordinates_.end()) {
		voxel_ = ROOT::Math::XYZVector(
		model->getPixelSize().x() / root_, model->getPixelSize().y(), model->getSensorSize().z());
		} else if(std::find(scan_coordinates_.begin(), scan_coordinates_.end(), "y") != scan_coordinates_.end()) {
		voxel_ = ROOT::Math::XYZVector(
		model->getPixelSize().x(), model->getPixelSize().y() / root_, model->getSensorSize().z());
		} else if(std::find(scan_coordinates_.begin(), scan_coordinates_.end(), "z") != scan_coordinates_.end()) {
		voxel_ = ROOT::Math::XYZVector(
		model->getPixelSize().x(), model->getPixelSize().y(), model->getSensorSize().z() / root_);
		} else {
		throw InvalidValueError(config_, "scan_coordinates", "The coordinate must be x, y, or z.");
		}
		} else if(scan_coordinates_.size() == 2) {
		// Throw if we don't have a valid combination. Need 2 valid entries; x y, x z, or y z
		bool has_x = std::find(scan_coordinates_.begin(), scan_coordinates_.end(), "x") != scan_coordinates_.end();
		bool has_y = std::find(scan_coordinates_.begin(), scan_coordinates_.end(), "y") != scan_coordinates_.end();
		bool has_z = std::find(scan_coordinates_.begin(), scan_coordinates_.end(), "z") != scan_coordinates_.end();
		root_ = static_cast<unsigned int>(std::lround(std::sqrt(events)));
		if(events != root_ * root_) {
		LOG(WARNING) << "Number of events is not a square, pixel cell volume cannot fully be covered in scan. "
		<< "Closest square is " << root_ * root_;
		}
		if(has_x && has_y) {
		voxel_ = ROOT::Math::XYZVector(
		model->getPixelSize().x() / root_, model->getPixelSize().y() / root_, model->getSensorSize().z());
		} else if(has_x && has_z) {
		voxel_ = ROOT::Math::XYZVector(
		model->getPixelSize().x() / root_, model->getPixelSize().y(), model->getSensorSize().z() / root_);
		} else if(has_y && has_z) {
		voxel_ = ROOT::Math::XYZVector(
		model->getPixelSize().x(), model->getPixelSize().y() / root_, model->getSensorSize().z() / root_);
		} else {
		throw InvalidValueError(config_, "scan_coordinates", "The coordinates must be x, y, or z.");
		}

		} else if(scan_coordinates_.size() == 3 && type_ == SourceType::MIP) {
		root_ = static_cast<unsigned int>(std::lround(std::sqrt(events)));
		if(events != root_ * root_) {
		LOG(WARNING) << "Number of events is not a square, pixel cell volume cannot fully be covered in scan. "
		@@ -114,7 +153,7 @@ void DepositionPointChargeModule::initialize() {
		voxel_ = ROOT::Math::XYZVector(
		model->getPixelSize().x() / root_, model->getPixelSize().y() / root_, model->getSensorSize().z() / root_);
		}
		LOG(INFO) << "Voxel size for scan of pixel volume: " << Units::display(voxel_, {"um", "mm"});
		LOG(WARNING) << "Voxel size for scan of pixel volume: " << Units::display(voxel_, {"um", "mm"});
		}
		}

		@@ -137,6 +176,7 @@ void DepositionPointChargeModule::run(Event* event) {
		voxel_.y() * static_cast<double>(((event->number - 1) / root_) % root_),
		voxel_.z() * static_cast<double>(((event->number - 1) / root_ / root_) % root_)) +
		ref;
		LOG(DEBUG) << "In-pixel deposition position: " << Units::display(position - ref, {"um", "mm"});
		} else {
		// Calculate random offset from configured position
		auto shift = [&](auto size) {

src/modules/DepositionPointCharge/README.md

+15 −3

Original line number	Diff line number	Diff line
		@@ -31,12 +31,13 @@ All charge carriers are deposited at time zero, i.e. at the beginning of the eve
		* `number_of_charges`: Number of charges deposited. This refers to the total number of charge carriers for the source type `point` and defaults to 1. For the `mip` source type, this value is interpreted as charge carriers per length deposited in the sensor and defaults to `80/um`. It should be noted that without units specified, this value will be interpreted in the framework base units, in this case `/mm`.
		* `number_of_steps`: Number of steps over the full sensor thickness at which charge carriers are deposited. Only used for `mip` source type. Defaults to 100.
		* `source_type`: Modeled source type for the deposition of charge carriers. For `point`, charge carriers are deposited at the position given by the `position` parameter. For `mip`, charge carriers are deposited along a line through the full sensor thickness. Defaults to `point`.
		* `position`: Position in local coordinates of the sensor, where charge carriers should be deposited. Expects three values for local-x, local-y and local-z position in the sensor volume and defaults to `0um 0um 0um`, i.e. the center of first (lower left) pixel. Only used for the `fixed` and model. When using source type `mip`, providing a 2D position is sufficient since it only uses the x and y coordinates. If used in scan mode, it allows you to shift the origin of each deposited charge by adding this value.
		* `position`: Position in local coordinates of the sensor, where charge carriers should be deposited. Expects three values for local-x, local-y and local-z position in the sensor volume and defaults to `0um 0um 0um`, i.e. the center of first (lower left) pixel. When using source type `mip`, providing a 2D position is sufficient since it only uses the x and y coordinates. If used in scan mode, it allows you to shift the origin of each deposited charge by adding this value. If the scan is only performed in one or two dimensions, the remaining coordinate will constantly have the value given by `position`.
		* `spot_size`: Width of the Gaussian distribution used to smear the position in the `spot` model. Only one value is taken and used for all three dimensions.
		* `scan_coordinates`: Coordinates to scan over, a combiantion of x, y, z. Defaults to `xyz`, i.e. all three spatial coordinates. The `position`parameter is used to determine the value of the coordiantes that are not scanned over, if a partial scan is requested.

		## Usage

		Example configuration for a point source at a defined position around which charge carriers are deposited with a Gaussian distribution:
		Example configuration for a point source at a defined position around which 100 charge carriers are deposited with a Gaussian distribution:

		```ini
		[DepositionPointCharge]
		@@ -44,7 +45,18 @@ source_type = "point"
		model = "spot"
		position = -10um 10um 0um
		spot_size = 3um
		number_of_steps = 100
		number_of_charges = 100
		```

		Example configuration for a point source scanned over the x and y cooridantes, with a fixed z coordinate of 10 micrometers from the sensor middle:

		```ini
		[DepositionPointCharge]
		source_type = "point"
		model = "scan"
		scan_coordinates = x y
		position = 0um 0um 10um
		number_of_charges = 100
		```

		Example configuration for a MIP-like energy deposition along a line at a fixed position, with 63 electron-hole pairs deposited per micrometer of sensor material: