 |
ImFusion C++ SDK 4.4.0
|
|
ImFusion C++ SDK 4.4.0
|
#include <ImFusion/CT/SpectralXRaySimulation.h>
Algorithm for generating synthetic spectral X-ray projections from CT volumes or meshes. More...
Public Types | |
| enum class | SimulationMode { Polychromatic = 0 , Monochromatic = 1 } |
| enum class | PrefilterMaterials { None , Aluminum , Beryllium , Carbon , Copper , Gold , Lead , PTFE , Silver , Tin , Titanium , Tungsten , _Count } |
| Available prefilter materials. | |
| enum | DetectorMaterials { None , AmorphousSelenium , AmorphousSilicon , BismuthGermaniumOxide , CadmiumTelluride , CadmiumTungstate , CadmiumZincTelluride , CesiumIodide , GadoliniumOxysulfide , Silicon , SodiumIodide , _Count } |
| Available detector materials. | |
| Public Types inherited from ImFusion::Algorithm | |
| enum | Status { Unknown = -1 , Success = 0 , Error = 1 , InvalidInput , IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU , UnknownAction , AbortedByUser , User = 1000 } |
| Status codes. More... | |
Public Member Functions | |
| SpectralXRaySimulation (const SharedImageSet *sis, const std::vector< Mesh * > meshes) | |
| Sets up spectral X-ray simulation based on a voxel volume and/or a set of surface meshes. | |
| void | compute () override |
| Execute the spectral X-ray simulation. | |
| void | configure (const Properties *p) override |
| Configure this object instance by de-serializing the given Properties. | |
| void | configuration (Properties *p) const override |
| Serialize the current object configuration into the given Properties object. | |
| OwningDataList | takeOutput () override |
| Return the generated X-ray projections. | |
| bool | setGeometry (std::vector< GeometryUtils::FullGeometryRepresentation > &geo) |
| Set projection geometry. | |
| SharedImageSet * | projections () |
| Access to the output projections with geometry. | |
| const SharedImageSet * | volume () |
| Access to the volume. | |
| Public Member Functions inherited from ImFusion::Algorithm | |
| Algorithm () | |
| Default constructor will registers a single "compute" action that calls compute() and returns status(). | |
| virtual void | setProgress (Progress *progress) |
| Sets a Progress interface the algorithm can use to notify observers about its computing progress. | |
| Progress * | progress () const |
| Returns the progress interface if set. | |
| virtual int | status () const |
| Indicates the status of the last call to compute(). | |
| virtual bool | survivesDataDeletion (const Data *) const |
| Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list. | |
| const FactoryInfo & | factoryInfo () const |
| Returns the record describing how this Algorithm was instantiated by the AlgorithmFactory. | |
| void | setFactoryInfo (const FactoryInfo &value) |
| Sets the record describing how this Algorithm was instantiated by the AlgorithmFactory. | |
| Status | runAction (const std::string &id) |
| Run the action with name id if it exists. | |
| const std::vector< Action > & | actions () |
| Get a mapping from Action id to Action as registered in this algorithm. | |
| Public Member Functions inherited from ImFusion::Configurable | |
| virtual void | configureDefaults () |
| Retrieve the properties of this object, replaces values with their defaults and sets it again. | |
| void | registerParameter (ParameterBase *param) |
| Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration(). | |
| void | unregisterParameter (const ParameterBase *param) |
| Remove the given Parameter or SubProperty from the list of registered parameters. | |
| Configurable (const Configurable &rhs) | |
| Configurable (Configurable &&rhs) noexcept | |
| Configurable & | operator= (const Configurable &) |
| Configurable & | operator= (Configurable &&) noexcept |
Static Public Member Functions | |
| static bool | createCompatible (const DataList &data, Algorithm **a=nullptr) |
| Factory function to check compatibility and optionally create the algorithm. | |
| static const std::tuple< std::string, std::string, float > & | prefilterInfo (PrefilterMaterials m) |
| Get prefilter information, i.e. tuple of display name, name of data file, and mass density in \(g/mm^3\). | |
| static const std::tuple< std::string, std::string, float > & | detectorInfo (DetectorMaterials m) |
| Get detector information, i.e. tuple of display name, name of data file, and mass density in \(g/mm^3\). | |
| Static Public Member Functions inherited from ImFusion::Algorithm | |
| static bool | createCompatible (const DataList &data, Algorithm **a=nullptr) |
| Factory function to check algorithm compatibility with input data and optionally instantiate it. | |
Public Attributes | |
| Parameter< SimulationMode > | p_simulationMode = {"simulationMode", SimulationMode::Monochromatic, this} |
| Simulation mode: monochromatic simulation or polychromatic simulation. | |
| Parameter< float > | p_detectorSizeX = {"detectorSizeX", 300.f, this} |
| Physical size of the detector in x-direction (mm). | |
| Parameter< float > | p_detectorSizeY = {"detectorSizeY", 300.f, this} |
| Physical size of the detector in y-direction (mm). | |
| Parameter< int > | p_width = {"width", 512, this} |
| Width (pixel) of the projections to be simulated. | |
| Parameter< int > | p_height = {"height", 512, this} |
| Height (pixel) of the projections to be simulated. | |
| Parameter< int > | p_frames = {"frames", 400, this} |
| Number of frames to be simulated. | |
| Parameter< bool > | p_visualizeGeometry = {"visualizeGeometry", true, this} |
| Whether to visualize geometry of the output projections. | |
| std::vector< Parameter< std::string > > | p_meshMaterials |
| Materials of the provided meshes. | |
| std::vector< Parameter< float > > | p_meshDensities |
| Densities of the provided meshes. | |
| Parameter< bool > | p_logConversion = {"logConversion", true, this} |
| Log normalization of the simulated x-rays. | |
| Parameter< bool > | p_addNoise = {"addNoise", false, this} |
| Add noise to the simulated data if true. | |
| Parameter< int > | p_photonsPerPixel = {"photonsPerPixel", 10000, this} |
| Number of photons per pixel (in absence of an object). | |
| SubProperty< std::unique_ptr< ProjectionMatrixIoAlgorithm > > | p_matrixIoAlg = {"matrixIOAlg", nullptr, this} |
| SubProperty< std::unique_ptr< GeometryAlgorithm > > | p_geometryAlg = {"geometryAlg", nullptr, this} |
| Public Attributes inherited from ImFusion::Algorithm | |
| Signal | signalOutputChanged |
| Signal should be emitted by Algorithms when their output/result has changed. | |
| Signal | signalParametersChanged |
| Signal should be emitted by Algorithms when their parameter configuration has changed. | |
| Public Attributes inherited from ImFusion::Configurable | |
| Signal | signalParametersChanged |
| Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted. | |
Spectral X-ray simulation parameters | |
| Parameter< float > | p_tubeVoltage = {"tubeVoltage", 120.f, this} |
| Parameter< float > | p_dE = {"energyResolution", 1.f, this} |
| Energy resolution (keV), i.e. width of energy bins used in spectral calculations. | |
| Parameter< float > | p_anodeAngle = {"anodeAngle", 7.f, this} |
| Anode angle (degree) of the x-ray tube. Common values range from 7 to 20 degree. | |
| Parameter< PrefilterMaterials > | p_prefilterMaterial0 = {"prefilterMaterial0", PrefilterMaterials::Aluminum, this} |
| Material of first prefilter. | |
| Parameter< float > | p_prefilterThickness0 = {"prefilterThickness0", 5.f, this} |
| Thickness of first prefilter. | |
| Parameter< PrefilterMaterials > | p_prefilterMaterial1 = {"prefilterMaterial1", PrefilterMaterials::None, this} |
| Material of second prefilter. | |
| Parameter< float > | p_prefilterThickness1 = {"prefilterThickness1", 0.f, this} |
| Thickness of second prefilter. | |
| Parameter< DetectorMaterials > | p_detectorMaterial = {"detectorMaterial", DetectorMaterials::CesiumIodide, this} |
| Detector material. | |
| Parameter< float > | p_detectorThickness = {"detectorThickness", 1.0f, this} |
| Detector thickness. | |
| Parameter< bool > | p_energyIntegratingDetector = {"energyIntegratingDetector", true, this} |
| If true, detected photons are weighted with their energy to mimic the detection process in an energy integrating detectors. | |
Monochromatic simulation parameters | |
| Parameter< float > | p_xrayEnergy = {"xrayEnergy", 120.f, this} |
Additional Inherited Members | |
| Protected Member Functions inherited from ImFusion::Algorithm | |
| void | loadDefaults () |
| void | registerAction (const std::string &id, const std::string &guiName, const std::function< Algorithm::Status(void)> &action) |
| Register an action to be run via runAction. | |
| template<typename D> | |
| void | registerAction (const std::string &id, const std::string &guiName, Algorithm::Status(D::*action)(void)) |
| Template version of runAction that can be used with a pointer to a member function. | |
| void | registerAction (const Action &action) |
| Register an action. | |
| Protected Attributes inherited from ImFusion::Algorithm | |
| std::string | m_name |
| Algorithm name. | |
| Progress * | m_progress = nullptr |
| Non-owing pointer to a progress interface. May be a nullptr. | |
| FactoryInfo | m_factoryInfo = {} |
| Record describing how this algorithm was instantiated by the AlgorithmFactory. | |
| int | m_status = Status::Unknown |
| Algorithm status after last call to compute(). | |
| std::vector< Action > | m_actions |
| Map of key given by the id of the action, of the available actions of this algorithm. | |
| Protected Attributes inherited from ImFusion::Configurable | |
| std::vector< Param > | m_params |
| List of all registered Parameter and SubProperty instances. | |
|
overridevirtual |
Execute the spectral X-ray simulation.
Implements ImFusion::Algorithm.
|
overridevirtual |
Configure this object instance by de-serializing the given Properties.
The default implementation will do so automatically for all registered Parameter and SubProperty instances.
Reimplemented from ImFusion::Configurable.
|
overridevirtual |
Serialize the current object configuration into the given Properties object.
The default implementation will do so automatically for all registered Parameter and SubProperty instances.
Reimplemented from ImFusion::Configurable.
|
overridevirtual |
Return the generated X-ray projections.
Reimplemented from ImFusion::Algorithm.
| Parameter<float> ImFusion::CT::SpectralXRaySimulation::p_tubeVoltage = {"tubeVoltage", 120.f, this} |
Tube voltage of the spectrum (kV)
| Parameter<bool> ImFusion::CT::SpectralXRaySimulation::p_energyIntegratingDetector = {"energyIntegratingDetector", true, this} |
If true, detected photons are weighted with their energy to mimic the detection process in an energy integrating detectors.
To simulate photon counting detectors, this flag needs to be set to false instead.
| Parameter<float> ImFusion::CT::SpectralXRaySimulation::p_xrayEnergy = {"xrayEnergy", 120.f, this} |
X-ray energy (keV). This parameter specifies the photon energy of the simulated X-ray beam when operating in monochromatic mode.