oap_model.cloud module

class oap_model.cloud.CloudVolume(psd: oap_model.psd.GammaPSD, dimensions: tuple[float, float, float], random_seed: int = 42)

Bases: object

dimensions: tuple[float, float, float]

generate_particles()

property n_particles

Calculate the number of particles in the volume based on the PSD.

particles_in_illuminated_region(detector: Detector, distance: float = 1e-05, offset: ndarray = array([0, 0, 0]))

plot_from_run(run: DetectorRun, near_coord=None, near_length=0.002, ylims=None, ax=None, **kwargs)

process_imaged_region(particles, detector, distance, offset, use_focus=False, binary_output=False)

psd: GammaPSD

random_seed: int = 42

set_model(shape: CrystalModel)

take_image(detector: Detector, distance: float = 1e-05, offset: ndarray = array([0, 0, 0]), single_image: bool = False, use_focus: bool = False, primary_only: bool = False, detection_condition: callable = None, binary_output: bool = False) → oap_model.detector_run.DetectorRun | oap_model.detector.ImagedRegion

Take an image using repeated detections along the y-axis.

Detector is aligned with x-axis, and the y-axis is the direction of travel. The z-axis is the focal axis. The detector position is the position of the detector centre during the final detection. The model_generator is a callable taking the diameter of the particle in microns and returning an ASTModel.

property volume

oap_model.cloud.process_image_no(image_no, particles_to_model, detector_position, detector, cloud, use_focus, binary_output)