synthetic_radiograph
- plasmapy.diagnostics.charged_particle_radiography.synthetic_radiography.synthetic_radiograph(obj, size=None, bins=None, ignore_grid: bool = False)[source]
Calculate a “synthetic radiograph” (particle count histogram in the image plane).
- Parameters:
obj (
dict
orPath
orTracker
) – Either aTracker
object that has been run, a dictionary equivalent toresults_dict
, or path to a saved output file from aTracker
object (HDF5 file).size (
Quantity
, shape(2, 2)
, optional) – The size of the detector array, specified as the minimum and maximum values included in both the horizontal and vertical directions in the detector plane coordinates. Shape is((hmin, hmax), (vmin, vmax))
. If not specified, the size will be set to include all particles on the detector. Units must be convertible to meters.bins (array of integers, shape
(2)
) – The number of bins in each direction in the format(hbins, vbins)
. The default is(200, 200)
.ignore_grid (
bool
) – IfTrue
, returns the intensity in the image plane in the absence of simulated fields.
- Returns:
Notes
This function ignores any particles that are stopped or removed before reaching the detector plane.