Skip to content

Commit

Permalink
Documentation update.
Browse files Browse the repository at this point in the history
  • Loading branch information
robbietuk committed Sep 3, 2024
1 parent 0c635fc commit a3e81ed
Showing 1 changed file with 8 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ class MLEstimateComponentBasedNormalisation
/*!
\brief Constructor
\param out_filename_prefix The prefix for the output files
\param measured_data The measured projection data
\param model_data The model projection data
\param measured_data_v The measured projection data
\param model_data_v The model projection data
\param num_eff_iterations_v The number of (sub-)efficiency iterations to perform per iteration of the algorithm
\param num_iterations_v The number of algorithm iterations to perform
\param do_geo_v Whether to perform geo normalization calculations
Expand Down Expand Up @@ -98,6 +98,7 @@ class MLEstimateComponentBasedNormalisation
//! Get the block data, requires process() to be called first and do_block to be true
BlockData3D get_block_data() const;

//! Construct a BinNormalisationPETFromComponents from the calculated efficiencies, geo data and block data
BinNormalisationPETFromComponents construct_bin_normfactors_from_components() const;

private:
Expand Down Expand Up @@ -168,13 +169,17 @@ class MLEstimateComponentBasedNormalisation
//! Whether to save the each iteration of the efficiencies, geo data and block data to file.
bool do_save_to_file;

// The projdata info of the measured data
//! The projdata info of the measured data
std::shared_ptr<const ProjDataInfo> projdata_info;

// Calculated variables
//! The efficiencies calculated by the algorithm
DetectorEfficiencies norm_efficiencies;
//! The geo data calculated by the algorithm, if do_geo is true
BlockData3D norm_block_data;
//! The block data calculated by the algorithm, if do_block is true
GeoData3D norm_geo_data;

//! The threshold for the Kullback-Leibler divergence calculation
float threshold_for_KL;
FanProjData model_fan_data;
Expand Down

0 comments on commit a3e81ed

Please sign in to comment.