device_digital_twins

• detection_geometries
  • CurvedArrayDetectionGeometry
    • CurvedArrayDetectionGeometry.check_settings_prerequisites()
    • CurvedArrayDetectionGeometry.deserialize()
    • CurvedArrayDetectionGeometry.get_detector_element_orientations()
    • CurvedArrayDetectionGeometry.get_detector_element_positions_base_mm()
    • CurvedArrayDetectionGeometry.serialize()
    • CurvedArrayDetectionGeometry.update_settings_for_use_of_model_based_volume_creator()
  • DetectionGeometryBase
    • DetectionGeometryBase.deserialize()
    • DetectionGeometryBase.get_detector_element_orientations()
    • DetectionGeometryBase.get_detector_element_positions_accounting_for_device_position_mm()
    • DetectionGeometryBase.get_detector_element_positions_accounting_for_field_of_view()
    • DetectionGeometryBase.get_detector_element_positions_base_mm()
    • DetectionGeometryBase.serialize()
  • LinearArrayDetectionGeometry
    • LinearArrayDetectionGeometry.check_settings_prerequisites()
    • LinearArrayDetectionGeometry.deserialize()
    • LinearArrayDetectionGeometry.get_detector_element_orientations()
    • LinearArrayDetectionGeometry.get_detector_element_positions_base_mm()
    • LinearArrayDetectionGeometry.serialize()
    • LinearArrayDetectionGeometry.update_settings_for_use_of_model_based_volume_creator()
  • PlanarArrayDetectionGeometry
    • PlanarArrayDetectionGeometry.check_settings_prerequisites()
    • PlanarArrayDetectionGeometry.deserialize()
    • PlanarArrayDetectionGeometry.get_detector_element_orientations()
    • PlanarArrayDetectionGeometry.get_detector_element_positions_base_mm()
    • PlanarArrayDetectionGeometry.get_field_of_view_extent_mm()
    • PlanarArrayDetectionGeometry.serialize()
    • PlanarArrayDetectionGeometry.update_settings_for_use_of_model_based_volume_creator()
• illumination_geometries
  • DiskIlluminationGeometry
    • DiskIlluminationGeometry.deserialize()
    • DiskIlluminationGeometry.get_mcx_illuminator_definition()
    • DiskIlluminationGeometry.serialize()
  • GaussianBeamIlluminationGeometry
    • GaussianBeamIlluminationGeometry.deserialize()
    • GaussianBeamIlluminationGeometry.get_mcx_illuminator_definition()
    • GaussianBeamIlluminationGeometry.serialize()
  • IlluminationGeometryBase
    • IlluminationGeometryBase.check_settings_prerequisites()
    • IlluminationGeometryBase.deserialize()
    • IlluminationGeometryBase.get_mcx_illuminator_definition()
    • IlluminationGeometryBase.serialize()
    • IlluminationGeometryBase.update_settings_for_use_of_model_based_volume_creator()
  • MSOTAcuityIlluminationGeometry
    • MSOTAcuityIlluminationGeometry.deserialize()
    • MSOTAcuityIlluminationGeometry.get_mcx_illuminator_definition()
    • MSOTAcuityIlluminationGeometry.serialize()
  • MSOTInVisionIlluminationGeometry
    • MSOTInVisionIlluminationGeometry.deserialize()
    • MSOTInVisionIlluminationGeometry.get_mcx_illuminator_definition()
    • MSOTInVisionIlluminationGeometry.serialize()
  • PencilArrayIlluminationGeometry
    • PencilArrayIlluminationGeometry.deserialize()
    • PencilArrayIlluminationGeometry.get_mcx_illuminator_definition()
    • PencilArrayIlluminationGeometry.serialize()
  • PencilBeamIlluminationGeometry
    • PencilBeamIlluminationGeometry.deserialize()
    • PencilBeamIlluminationGeometry.get_mcx_illuminator_definition()
    • PencilBeamIlluminationGeometry.serialize()
  • RectangleIlluminationGeometry
    • RectangleIlluminationGeometry.deserialize()
    • RectangleIlluminationGeometry.get_mcx_illuminator_definition()
    • RectangleIlluminationGeometry.serialize()
  • RingIlluminationGeometry
    • RingIlluminationGeometry.deserialize()
    • RingIlluminationGeometry.get_mcx_illuminator_definition()
    • RingIlluminationGeometry.serialize()
  • SlitIlluminationGeometry
    • SlitIlluminationGeometry.deserialize()
    • SlitIlluminationGeometry.get_mcx_illuminator_definition()
    • SlitIlluminationGeometry.serialize()
• pa_devices
  • MSOTAcuityEcho
    • MSOTAcuityEcho.deserialize()
    • MSOTAcuityEcho.serialize()
    • MSOTAcuityEcho.update_settings_for_use_of_model_based_volume_creator()
  • InVision256TF
    • InVision256TF.deserialize()
    • InVision256TF.serialize()
  • RSOMExplorerP50
    • RSOMExplorerP50.deserialize()
    • RSOMExplorerP50.serialize()
  • PhotoacousticDevice
    • PhotoacousticDevice.detection_geometry
    • PhotoacousticDevice.illumination_geometries
    • PhotoacousticDevice.add_illumination_geometry()
    • PhotoacousticDevice.check_settings_prerequisites()
    • PhotoacousticDevice.deserialize()
    • PhotoacousticDevice.get_detection_geometry()
    • PhotoacousticDevice.get_illumination_geometry()
    • PhotoacousticDevice.serialize()
    • PhotoacousticDevice.set_detection_geometry()
    • PhotoacousticDevice.update_settings_for_use_of_model_based_volume_creator()

class DigitalDeviceTwinBase(device_position_mm=None, field_of_view_extent_mm=None)

Bases: SerializableSIMPAClass

This class represents a device that can be used for illumination, detection or a combined photoacoustic device which has representations of both.

Parameters:

• device_position_mm (ndarray) – Each device has an internal position which serves as origin for internal representations of e.g. detector element positions or illuminator positions.

• field_of_view_extent_mm (ndarray) – Field of view which is defined as a numpy array of the shape [xs, xe, ys, ye, zs, ze], where x, y, and z denote the coordinate axes and s and e denote the start and end positions.

__eq__(other)

Checks each key, value pair in the devices.

abstract check_settings_prerequisites(global_settings) → bool

It might be that certain device geometries need a certain dimensionality of the simulated PAI volume, or that it requires the existence of certain Tags in the global global_settings. To this end, a PAI device should use this method to inform the user about a mismatch of the desired device and throw a ValueError if that is the case.

Parameters:

global_settings (Settings) – Settings for the entire simulation pipeline.

Raises:

ValueError – raises a value error if the prerequisites are not matched.

Returns:

True if the prerequisites are met, False if they are not met, but no exception has been raised.

Return type:

bool

static deserialize(dictionary_to_deserialize)

generate_uuid()

Generates a universally unique identifier (uuid) for each device. :return:

get_field_of_view_mm() → ndarray

Returns the absolute field of view in mm where the probe position is already accounted for. It is defined as a numpy array of the shape [xs, xe, ys, ye, zs, ze], where x, y, and z denote the coordinate axes and s and e denote the start and end positions.

Returns:

Absolute field of view in mm where the probe position is already accounted for.

Return type:

ndarray

serialize() → dict

abstract update_settings_for_use_of_model_based_volume_creator(global_settings)

This method can be overwritten by a PA device if the device poses special constraints to the volume that should be considered by the model-based volume creator.

Parameters:

global_settings (Settings) – Settings for the entire simulation pipeline.