pacfish
- api
- core
DetectionElementCreatorDetectionElementCreator.get_dictionary()DetectionElementCreator.set_angular_response()DetectionElementCreator.set_detector_geometry()DetectionElementCreator.set_detector_geometry_type()DetectionElementCreator.set_detector_orientation()DetectionElementCreator.set_detector_position()DetectionElementCreator.set_frequency_response()
DeviceMetaDataCreatorIlluminationElementCreatorIlluminationElementCreator.get_dictionary()IlluminationElementCreator.set_beam_divergence_angles()IlluminationElementCreator.set_beam_energy_profile()IlluminationElementCreator.set_beam_intensity_profile()IlluminationElementCreator.set_beam_stability_profile()IlluminationElementCreator.set_illuminator_geometry()IlluminationElementCreator.set_illuminator_geometry_type()IlluminationElementCreator.set_illuminator_orientation()IlluminationElementCreator.set_illuminator_position()IlluminationElementCreator.set_pulse_width()IlluminationElementCreator.set_wavelength_range()
DIMENSIONALITY_STRINGSEnumeratedStringMetaDatumMetadataAcquisitionTagsMetadataAcquisitionTags.ACOUSTIC_COUPLING_AGENTMetadataAcquisitionTags.ACQUISITION_WAVELENGTHSMetadataAcquisitionTags.AD_SAMPLING_RATEMetadataAcquisitionTags.COMPRESSIONMetadataAcquisitionTags.DATA_TYPEMetadataAcquisitionTags.DIMENSIONALITYMetadataAcquisitionTags.ELEMENT_DEPENDENT_GAINMetadataAcquisitionTags.ENCODINGMetadataAcquisitionTags.FREQUENCY_DOMAIN_FILTERMetadataAcquisitionTags.MEASUREMENTS_PER_IMAGEMetadataAcquisitionTags.MEASUREMENT_SPATIAL_POSESMetadataAcquisitionTags.MEASUREMENT_TIMESTAMPSMetadataAcquisitionTags.OVERALL_GAINMetadataAcquisitionTags.PHOTOACOUSTIC_IMAGING_DEVICE_REFERENCEMetadataAcquisitionTags.PULSE_ENERGYMetadataAcquisitionTags.REGIONS_OF_INTERESTMetadataAcquisitionTags.SCANNING_METHODMetadataAcquisitionTags.SIZESMetadataAcquisitionTags.SPEED_OF_SOUNDMetadataAcquisitionTags.TAGSMetadataAcquisitionTags.TAGS_ACQUISITIONMetadataAcquisitionTags.TAGS_BINARYMetadataAcquisitionTags.TAGS_CONTAINERMetadataAcquisitionTags.TEMPERATURE_CONTROLMetadataAcquisitionTags.TIME_GAIN_COMPENSATIONMetadataAcquisitionTags.UUID
MetadataDeviceTagsMetadataDeviceTags.ANGULAR_RESPONSEMetadataDeviceTags.BEAM_DIVERGENCE_ANGLESMetadataDeviceTags.BEAM_ENERGY_PROFILEMetadataDeviceTags.BEAM_INTENSITY_PROFILEMetadataDeviceTags.BEAM_STABILITY_PROFILEMetadataDeviceTags.DETECTION_ELEMENTMetadataDeviceTags.DETECTORSMetadataDeviceTags.DETECTOR_GEOMETRYMetadataDeviceTags.DETECTOR_GEOMETRY_TYPEMetadataDeviceTags.DETECTOR_ORIENTATIONMetadataDeviceTags.DETECTOR_POSITIONMetadataDeviceTags.FIELD_OF_VIEWMetadataDeviceTags.FREQUENCY_RESPONSEMetadataDeviceTags.GENERALMetadataDeviceTags.ILLUMINATION_ELEMENTMetadataDeviceTags.ILLUMINATORSMetadataDeviceTags.ILLUMINATOR_GEOMETRYMetadataDeviceTags.ILLUMINATOR_GEOMETRY_TYPEMetadataDeviceTags.ILLUMINATOR_ORIENTATIONMetadataDeviceTags.ILLUMINATOR_POSITIONMetadataDeviceTags.INTENSITY_PROFILE_DISTANCEMetadataDeviceTags.NUMBER_OF_DETECTION_ELEMENTSMetadataDeviceTags.NUMBER_OF_ILLUMINATION_ELEMENTSMetadataDeviceTags.PULSE_WIDTHMetadataDeviceTags.TAGSMetadataDeviceTags.TAGS_DETECTORSMetadataDeviceTags.TAGS_GENERALMetadataDeviceTags.TAGS_ILLUMINATORSMetadataDeviceTags.UNIQUE_IDENTIFIERMetadataDeviceTags.WAVELENGTH_RANGE
NDimensionalNumpyArrayNDimensionalNumpyArrayWithMElementsNonNegativeNumberNonNegativeNumbersInArrayNonNegativeWholeNumberNumberWithUpperAndLowerLimitUnconstrainedMetaDatumUnitsPADataPAData.get_acoustic_coupling_agent()PAData.get_acquisition_meta_datum()PAData.get_acquisition_wavelengths()PAData.get_angular_response()PAData.get_beam_divergence()PAData.get_beam_energy_profile()PAData.get_beam_profile()PAData.get_beam_profile_distance()PAData.get_beam_stability_profile()PAData.get_compression()PAData.get_custom_meta_datum()PAData.get_data_UUID()PAData.get_data_type()PAData.get_detector_attribute_for_tag()PAData.get_detector_geometry()PAData.get_detector_geometry_type()PAData.get_detector_ids()PAData.get_detector_orientation()PAData.get_detector_position()PAData.get_device_uuid()PAData.get_dimensionality()PAData.get_element_dependent_gain()PAData.get_encoding()PAData.get_field_of_view()PAData.get_frequency_domain_filter()PAData.get_frequency_response()PAData.get_illuminator_attribute_for_tag()PAData.get_illuminator_geometry()PAData.get_illuminator_geometry_type()PAData.get_illuminator_ids()PAData.get_illuminator_orientation()PAData.get_illuminator_position()PAData.get_measurement_spatial_poses()PAData.get_measurement_time_stamps()PAData.get_measurements_per_image()PAData.get_number_of_detectors()PAData.get_number_of_illuminators()PAData.get_overall_gain()PAData.get_photoacoustic_imaging_device_reference()PAData.get_pulse_energy()PAData.get_pulse_width()PAData.get_regions_of_interest()PAData.get_sampling_rate()PAData.get_scanning_method()PAData.get_sizes()PAData.get_speed_of_sound()PAData.get_temperature()PAData.get_time_gain_compensation()PAData.get_wavelength_range()
- iohandler
- qualitycontrol
- visualize_device(device_dictionary: dict, save_path: Optional[str] = None, title: Optional[str] = None, only_show_xz: bool = False, show_legend: bool = True)[source]
Visualises a given device from the device_dictionary.
- Parameters:
device_dictionary (dict) – The dictionary containing the device description.
save_path (str) – Optional save_path with the path and file name to save the visualisation to.
title (str) – Optional custom title for the plot.
only_show_xz (bool) – Optional bool parameter specifying if only the first window should be shown instead of all
show_legend (bool) – Optional parameter whether the figure legend should be shown (default: True)