SIMPA
Welcome to the SIMPA documentation!
The toolkit for Simulation and Image Processing for Photonics and Acoustics (SIMPA) aims to facilitate realistic image simulation for optical and acoustic imaging modalities by providing adapters to crucial modelling steps, such as volume generation; optical modelling; acoustic modelling; and image reconstruction. SIMPA provides a communication layer between various modules that implement optical and acoustic forward and inverse models. Non-experts can use the toolkit to create sensible simulations from default parameters in an end-to-end fashion. Domain experts are provided with the functionality to set up a highly customisable pipeline according to their specific use cases and tool requirements.
SIMPA toolkit
SIMPA examples
- simpa_examples
- create_a_custom_digital_device_twin
- create_custom_tissues
- linear_unmixing
- minimal_optical_simulation
- minimal_optical_simulation_heterogeneous_tissue
- minimal_optical_simulation_uniform_cube
- msot_invision_simulation
- optical_and_acoustic_simulation
- perform_image_reconstruction
- perform_iterative_qPAI_reconstruction
- segmentation_loader
Package reference
- core
- io_handling
- log
- utils
- libraries
- absorption_spectra_data
- anisotropy_spectra_data
- scattering_spectra_data
- structure_library
BlobHeterogeneityHeterogeneityGeneratorBaseImageHeterogeneityRandomHeterogeneityMorphologicalTissuePropertiesOpticalTissuePropertiesStandardPropertiesMolecularCompositionMolecularCompositionGeneratorMoleculeMoleculeLibraryAbsorptionSpectrumLibraryAnisotropySpectrumLibraryScatteringSpectrumLibrarySpectraLibrarySpectrumget_simpa_internal_absorption_spectra_by_names()view_saved_spectra()TissueLibrary
- quality_assurance
are_equal()calculate_bvf()calculate_gruneisen_parameter_from_temperature()calculate_oxygenation()create_spline_for_range()extract_hemoglobin_fractions()min_max_normalization()positive_gauss()randomize_uniform()rotation()rotation_matrix_between_vectors()rotation_x()rotation_y()rotation_z()round_x5_away_from_zero()spline_evaluator2d_voxel()EPSSegmentationClassesSegmentationClasses.AIRSegmentationClasses.BLOODSegmentationClasses.BONESegmentationClasses.COUPLING_ARTIFACTSegmentationClasses.DERMISSegmentationClasses.EPIDERMISSegmentationClasses.FATSegmentationClasses.GENERICSegmentationClasses.HEAVY_WATERSegmentationClasses.LYMPH_NODESegmentationClasses.MEDIPRENESegmentationClasses.MUSCLESegmentationClasses.SOFT_TISSUESegmentationClasses.ULTRASOUND_GELSegmentationClasses.WATER
create_deformation_settings()get_functional_from_deformation_settings()generate_dict_path()get_data_field_from_simpa_output()generate_matlab_cmd()PathManagerget_processing_device()profile()SerializableSIMPAClassSettingsSettings.deserialize()Settings.get_acoustic_settings()Settings.get_optical_settings()Settings.get_reconstruction_settings()Settings.get_volume_creation_settings()Settings.get_volume_dimensions_voxels()Settings.serialize()Settings.set_acoustic_settings()Settings.set_optical_settings()Settings.set_reconstruction_settings()Settings.set_volume_creation_settings()
TagsTags.ACOUSTIC_LOG_SCALETags.ACOUSTIC_MODELTags.ACOUSTIC_MODEL_BINARY_PATHTags.ACOUSTIC_MODEL_K_WAVETags.ACOUSTIC_MODEL_OUTPUT_NAMETags.ACOUSTIC_MODEL_SETTINGSTags.ACOUSTIC_MODEL_TESTTags.ACOUSTIC_SIMULATION_3DTags.ADDITIONAL_FLAGSTags.ADHERE_TO_DEFORMATIONTags.BACKGROUNDTags.BANDPASS_CUTOFF_HIGHPASS_IN_HZTags.BANDPASS_CUTOFF_LOWPASS_IN_HZTags.BANDPASS_FILTER_METHODTags.BUTTERWORTH_BANDPASS_FILTERTags.BUTTERWORTH_FILTER_ORDERTags.CHILD_STRUCTURESTags.CIRCULAR_TUBULAR_STRUCTURETags.COMPUTE_DIFFUSE_REFLECTANCETags.COMPUTE_PHOTON_DIRECTION_AT_EXITTags.CONSIDER_PARTIAL_VOLUMETags.CONSIDER_PARTIAL_VOLUME_IN_DEVICETags.CONTINUE_SIMULATIONTags.CROP_POSITION_BOTTOMTags.CROP_POSITION_CENTRETags.CROP_POSITION_LEFTTags.CROP_POSITION_RANDOMTags.CROP_POSITION_RIGHTTags.CROP_POSITION_TOPTags.DATA_FIELDTags.DATA_FIELD_ABSORPTION_PER_CMTags.DATA_FIELD_ALPHA_COEFFTags.DATA_FIELD_ANISOTROPYTags.DATA_FIELD_BLOOD_VOLUME_FRACTIONTags.DATA_FIELD_DENSITYTags.DATA_FIELD_DIFFUSE_REFLECTANCETags.DATA_FIELD_DIFFUSE_REFLECTANCE_POSTags.DATA_FIELD_FLUENCETags.DATA_FIELD_GRUNEISEN_PARAMETERTags.DATA_FIELD_INITIAL_PRESSURETags.DATA_FIELD_OXYGENATIONTags.DATA_FIELD_PHOTON_EXIT_DIRTags.DATA_FIELD_PHOTON_EXIT_POSTags.DATA_FIELD_RECONSTRUCTED_DATATags.DATA_FIELD_SCATTERING_PER_CMTags.DATA_FIELD_SEGMENTATIONTags.DATA_FIELD_SPEED_OF_SOUNDTags.DATA_FIELD_TIME_SERIES_DATATags.DEFORMATION_X_COORDINATES_MMTags.DEFORMATION_Y_COORDINATES_MMTags.DEFORMATION_Z_ELEVATIONS_MMTags.DEFORMED_LAYERS_SETTINGSTags.DETECTOR_ELEMENT_WIDTH_MMTags.DIGITAL_DEVICETags.DIGITAL_DEVICE_MSOT_ACUITYTags.DIGITAL_DEVICE_MSOT_INVISIONTags.DIGITAL_DEVICE_POSITIONTags.DIGITAL_DEVICE_RSOMTags.DIGITAL_DEVICE_SLIT_ILLUMINATION_LINEAR_DETECTORTags.DIM_VOLUME_X_MMTags.DIM_VOLUME_Y_MMTags.DIM_VOLUME_Z_MMTags.DOWNSCALE_FACTORTags.DO_FILE_COMPRESSIONTags.DO_IPASC_EXPORTTags.ELLIPTICAL_TUBULAR_STRUCTURETags.GPUTags.HORIZONTAL_LAYER_STRUCTURETags.IGNORE_QA_ASSERTIONSTags.ILLUMINATION_DIRECTIONTags.ILLUMINATION_PARAM1Tags.ILLUMINATION_PARAM2Tags.ILLUMINATION_POSITIONTags.ILLUMINATION_TYPETags.ILLUMINATION_TYPE_DISKTags.ILLUMINATION_TYPE_DKFZ_PAUSTags.ILLUMINATION_TYPE_FOURIERTags.ILLUMINATION_TYPE_FOURIER_XTags.ILLUMINATION_TYPE_FOURIER_X_2DTags.ILLUMINATION_TYPE_GAUSSIANTags.ILLUMINATION_TYPE_IPASC_DEFINITIONTags.ILLUMINATION_TYPE_MSOT_ACUITY_ECHOTags.ILLUMINATION_TYPE_MSOT_INVISIONTags.ILLUMINATION_TYPE_PATTERNTags.ILLUMINATION_TYPE_PATTERN_3DTags.ILLUMINATION_TYPE_PENCILTags.ILLUMINATION_TYPE_PENCILARRAYTags.ILLUMINATION_TYPE_PLANARTags.ILLUMINATION_TYPE_RINGTags.ILLUMINATION_TYPE_SLITTags.IMAGE_PROCESSINGTags.IMAGE_SCALING_CONSTANTTags.IMAGE_SCALING_EDGETags.IMAGE_SCALING_STRETCHTags.IMAGE_SCALING_SYMMETRICTags.IMAGE_SCALING_WRAPTags.INPUT_SEGMENTATION_VOLUMETags.ITERATIVE_RECONSTRUCTION_CONSTANT_REGULARIZATIONTags.ITERATIVE_RECONSTRUCTION_MAX_ITERATION_NUMBERTags.ITERATIVE_RECONSTRUCTION_REGULARIZATION_SIGMATags.ITERATIVE_RECONSTRUCTION_SAVE_INTERMEDIATE_RESULTSTags.ITERATIVE_RECONSTRUCTION_SAVE_LAST_FLUENCETags.ITERATIVE_RECONSTRUCTION_STOPPING_LEVELTags.ITERATIVE_qPAI_RESULTTags.KWAVE_PROPERTY_ALPHA_POWERTags.KWAVE_PROPERTY_DIRECTIVITY_ANGLETags.KWAVE_PROPERTY_INITIAL_PRESSURE_SMOOTHINGTags.KWAVE_PROPERTY_INTRINSIC_EULER_ANGLETags.KWAVE_PROPERTY_PMLAlphaTags.KWAVE_PROPERTY_PMLInsideTags.KWAVE_PROPERTY_PMLSizeTags.KWAVE_PROPERTY_PlotPMLTags.KWAVE_PROPERTY_SENSOR_MASKTags.KWAVE_PROPERTY_SENSOR_RECORDTags.K_WAVE_SPECIFIC_DTTags.K_WAVE_SPECIFIC_NTTags.LASER_PULSE_ENERGY_IN_MILLIJOULETags.LINEAR_UNMIXING_COMPUTE_SO2Tags.LINEAR_UNMIXING_NON_NEGATIVETags.LINEAR_UNMIXING_RESULTTags.LINEAR_UNMIXING_SPECTRATags.MATLAB_BINARY_PATH_VARNAMETags.MAX_DEFORMATION_MMTags.MCX_ASSUMED_ANISOTROPYTags.MCX_BINARY_PATH_VARNAMETags.MCX_SEEDTags.MEDIUM_TEMPERATURE_CELCIUSTags.MODEL_SENSOR_FREQUENCY_RESPONSETags.MOLECULE_COMPOSITIONTags.MOVIENAMETags.NOISE_FREQUENCYTags.NOISE_MAXTags.NOISE_MEANTags.NOISE_MINTags.NOISE_MODETags.NOISE_MODE_ADDITIVETags.NOISE_MODE_MULTIPLICATIVETags.NOISE_NON_NEGATIVITY_CONSTRAINTTags.NOISE_SCALETags.NOISE_SHAPETags.NOISE_STDTags.OPTICAL_MODELTags.OPTICAL_MODEL_BINARY_PATHTags.OPTICAL_MODEL_ILLUMINATION_GEOMETRY_JSON_FILETags.OPTICAL_MODEL_MCXTags.OPTICAL_MODEL_NUMBER_PHOTONSTags.OPTICAL_MODEL_OUTPUT_NAMETags.OPTICAL_MODEL_SETTINGSTags.OPTICAL_MODEL_TESTTags.OPTICAL_MODEL_UNITSTags.ORIGINAL_DATATags.PARALLELEPIPED_STRUCTURETags.PRIORITYTags.RANDOM_SEEDTags.RECONSTRUCTION_ALGORITHMTags.RECONSTRUCTION_ALGORITHM_DASTags.RECONSTRUCTION_ALGORITHM_DMASTags.RECONSTRUCTION_ALGORITHM_SDMASTags.RECONSTRUCTION_ALGORITHM_TESTTags.RECONSTRUCTION_ALGORITHM_TIME_REVERSALTags.RECONSTRUCTION_APODIZATION_BOXTags.RECONSTRUCTION_APODIZATION_HAMMINGTags.RECONSTRUCTION_APODIZATION_HANNTags.RECONSTRUCTION_APODIZATION_METHODTags.RECONSTRUCTION_BMODE_AFTER_RECONSTRUCTIONTags.RECONSTRUCTION_BMODE_BEFORE_RECONSTRUCTIONTags.RECONSTRUCTION_BMODE_METHODTags.RECONSTRUCTION_BMODE_METHOD_ABSTags.RECONSTRUCTION_BMODE_METHOD_HILBERT_TRANSFORMTags.RECONSTRUCTION_INVERSE_CRIMETags.RECONSTRUCTION_MITK_BINARY_PATHTags.RECONSTRUCTION_MITK_SETTINGS_XMLTags.RECONSTRUCTION_MODETags.RECONSTRUCTION_MODEL_SETTINGSTags.RECONSTRUCTION_MODE_DIFFERENTIALTags.RECONSTRUCTION_MODE_FULLTags.RECONSTRUCTION_MODE_PRESSURETags.RECONSTRUCTION_OUTPUT_NAMETags.RECONSTRUCTION_PERFORM_BANDPASS_FILTERINGTags.RECONSTRUCTION_PERFORM_RESAMPLING_FOR_FFTTags.RECORDMOVIETags.RECTANGULAR_CUBOID_STRUCTURETags.SEGMENTATION_CLASS_MAPPINGTags.SENSOR_BANDWIDTH_PERCENTTags.SENSOR_CENTER_FREQUENCY_HZTags.SENSOR_CONCAVETags.SENSOR_DIRECTIVITY_PATTERNTags.SENSOR_DIRECTIVITY_SIZE_MTags.SENSOR_ELEMENT_POSITIONSTags.SENSOR_LINEARTags.SENSOR_NUM_ELEMENTSTags.SENSOR_NUM_USED_ELEMENTSTags.SENSOR_PITCH_MMTags.SENSOR_RADIUS_MMTags.SENSOR_SAMPLING_RATE_MHZTags.SETTINGSTags.SIGNAL_THRESHOLDTags.SIMPA_NAMED_ABSORPTION_SPECTRUM_COPPER_SULPHIDETags.SIMPA_NAMED_ABSORPTION_SPECTRUM_DEOXYHEMOGLOBINTags.SIMPA_NAMED_ABSORPTION_SPECTRUM_FATTags.SIMPA_NAMED_ABSORPTION_SPECTRUM_MELANINTags.SIMPA_NAMED_ABSORPTION_SPECTRUM_NICKEL_SULPHIDETags.SIMPA_NAMED_ABSORPTION_SPECTRUM_OXYHEMOGLOBINTags.SIMPA_NAMED_ABSORPTION_SPECTRUM_WATERTags.SIMPA_OUTPUT_FILE_PATHTags.SIMPA_OUTPUT_NAMETags.SIMPA_SAVE_DIRECTORY_VARNAMETags.SIMPA_VERSIONTags.SIMULATE_DEFORMED_LAYERSTags.SIMULATIONSTags.SIMULATION_PATHTags.SIMULATION_PIPELINETags.SIMULATION_PROPERTIESTags.SPACING_MMTags.SPHERICAL_STRUCTURETags.STRUCTURESTags.STRUCTURE_BIFURCATION_LENGTH_MMTags.STRUCTURE_CURVATURE_FACTORTags.STRUCTURE_DIRECTIONTags.STRUCTURE_ECCENTRICITYTags.STRUCTURE_END_MMTags.STRUCTURE_FIRST_EDGE_MMTags.STRUCTURE_RADIUS_MMTags.STRUCTURE_RADIUS_VARIATION_FACTORTags.STRUCTURE_SECOND_EDGE_MMTags.STRUCTURE_SEGMENTATION_TYPETags.STRUCTURE_START_MMTags.STRUCTURE_THIRD_EDGE_MMTags.STRUCTURE_TYPETags.STRUCTURE_X_EXTENT_MMTags.STRUCTURE_Y_EXTENT_MMTags.STRUCTURE_Z_EXTENT_MMTags.TIME_STEPTags.TISSUE_PROPERTIES_OUPUT_NAMETags.TOTAL_TIMETags.TUKEY_BANDPASS_FILTERTags.TUKEY_WINDOW_ALPHATags.UNITS_ARBITRARYTags.UNITS_PRESSURETags.UPSAMPLED_DATATags.US_GELTags.VESSEL_STRUCTURETags.VOLUME_CREATION_MODEL_SETTINGSTags.VOLUME_CREATORTags.VOLUME_CREATOR_SEGMENTATION_BASEDTags.VOLUME_CREATOR_VERSATILETags.VOLUME_FRACTIONTags.VOLUME_NAMETags.WAVELENGTHTags.WAVELENGTHS
TissueProperties
- libraries
- visualisation