MLEstimateComponentBasedNormalisation refactor

documentation/release_6.3.htm

@@ -60,12 +60,17 @@ <h3>New functionality</h3>
 
 
 <h3>Changed functionality</h3>
+    <li>
+      Rework <code>MLEstimateComponentBasedNormalisation</code> into a class.
+      This allows for more flexibility in the use of the class without calling CLI executables. <br>
+      <a href=https://github.com/UCL/STIR/pull/1499>PR # 1499</a>
+    </li>
+
     <ul>
       <li>
         Default ECAT scanner configurations updated to use a negative intrinsic tilt.
       </li>
     </ul>
-
 <h3>Bug fixes</h3>
     <ul>
         <li>
@@ -115,6 +120,12 @@ <h3>Test changes</h3>
 
 <h4>C++ tests</h4>
 
+    <li>
+      Added <code>MLEstimateComponentBasedNormalisationTest</code> that tests the basic functionality of the
+      <code>MLEstimateComponentBasedNormalisation</code> class and creation of normalisation factors from
+      the calculated PET components. <br>
+      <a href=https://github.com/UCL/STIR/pull/1499>PR # 1499</a>
+    </li>
 
 <h4>recon_test_pack</h4>
 

src/buildblock/ML_norm.cxx

@@ -987,6 +987,10 @@ get_fan_info(int& num_rings, int& num_detectors_per_ring, int& max_ring_diff, in
     {
       error("Can only process data without axial compression (i.e. span=1)\n");
     }
+  if (proj_data_info_ptr->is_tof_data())
+    {
+      error("make_fan_data: Incompatible with TOF data. Abort.");
+    }
   num_rings = proj_data_info.get_scanner_ptr()->get_num_rings();
   num_detectors_per_ring = proj_data_info.get_scanner_ptr()->get_num_detectors_per_ring();
   const int half_fan_size = min(proj_data_info.get_max_tangential_pos_num(), -proj_data_info.get_min_tangential_pos_num());
@@ -1141,23 +1145,19 @@ make_fan_data_remove_gaps(FanProjData& fan_data, const ProjData& proj_data)
   int num_detectors_per_ring;
   int fan_size;
   int max_delta;
-
-  if (proj_data.get_proj_data_info_sptr()->is_tof_data())
-    error("make_fan_data: Incompatible with TOF data. Abort.");
-
   const ProjDataInfo& proj_data_info = *proj_data.get_proj_data_info_sptr();
   get_fan_info(num_rings, num_detectors_per_ring, max_delta, fan_size, proj_data_info);
 
   if (proj_data.get_proj_data_info_sptr()->get_scanner_ptr()->get_scanner_geometry() == "Cylindrical")
     {
-      auto proj_data_info_ptr = dynamic_cast<const ProjDataInfoCylindricalNoArcCorr* const>(&proj_data_info);
+      const auto proj_data_info_ptr = dynamic_cast<const ProjDataInfoCylindricalNoArcCorr* const>(&proj_data_info);
 
       make_fan_data_remove_gaps_help(
           fan_data, num_rings, num_detectors_per_ring, max_delta, fan_size, *proj_data_info_ptr, proj_data);
     }
   else
     {
-      auto proj_data_info_ptr = dynamic_cast<const ProjDataInfoBlocksOnCylindricalNoArcCorr* const>(&proj_data_info);
+      const auto proj_data_info_ptr = dynamic_cast<const ProjDataInfoBlocksOnCylindricalNoArcCorr* const>(&proj_data_info);
 
       make_fan_data_remove_gaps_help(
           fan_data, num_rings, num_detectors_per_ring, max_delta, fan_size, *proj_data_info_ptr, proj_data);

src/include/stir/recon_buildblock/BinNormalisationPETFromComponents.h

@@ -34,7 +34,7 @@ START_NAMESPACE_STIR
   Components currently supported are crystal efficiencies, geometric factors
   (constrained by symmetry) and block data. The latter were introduced to
   cope with timing alignment issues between blocks, but are generally
-  not recommended in the current estimation process (by ML_estimate_component_based_normalisation)
+  not recommended in the current estimation process (by MLEstimateComponentBasedNormalisation)
   as the model allows for too much freedom.
 
   The detection efficiency of a crystal pair is modelled as
@@ -126,15 +126,33 @@ class BinNormalisationPETFromComponents : public BinNormalisation
   void
   allocate(shared_ptr<const ProjDataInfo>, bool do_eff, bool do_geo, bool do_block = false, bool do_symmetry_per_block = false);
 
-  DetectorEfficiencies& crystal_efficiencies()
+
+  void set_crystal_efficiencies(const DetectorEfficiencies& eff)
+  {
+    efficiencies = eff;
+  }
+
+  DetectorEfficiencies& get_crystal_efficiencies()
   {
     return efficiencies;
   }
-  GeoData3D& geometric_factors()
+
+  void set_geometric_factors(const GeoData3D& geo)
+  {
+    geo_data = geo;
+  }
+
+  GeoData3D& get_geometric_factors()
   {
     return geo_data;
   }
-  BlockData3D& block_factors()
+
+  void set_block_factors(const BlockData3D& block)
+  {
+    block_data = block;
+  }
+
+  BlockData3D& get_block_factors()
   {
     return block_data;
   }