sifter.h

Go to the documentation of this file.

/* Copyright (c) 2008-2022 the MRtrix3 contributors.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Covered Software is provided under this License on an "as is"
 * basis, without warranty of any kind, either expressed, implied, or
 * statutory, including, without limitation, warranties that the
 * Covered Software is free of defects, merchantable, fit for a
 * particular purpose or non-infringing.
 * See the Mozilla Public License v. 2.0 for more details.
 *
 * For more details, see http://www.mrtrix.org/.
 */
 
#ifndef __dwi_tractography_sift_sifter_h__
#define __dwi_tractography_sift_sifter_h__
 
 
 
#include "image.h"
#include "types.h"
 
#include "math/rng.h"
 
#include "dwi/fixel_map.h"
#include "dwi/directions/set.h"
#include "dwi/tractography/SIFT/fixel.h"
#include "dwi/tractography/SIFT/gradient_sort.h"
#include "dwi/tractography/SIFT/model.h"
#include "dwi/tractography/SIFT/output.h"
#include "dwi/tractography/SIFT/track_index_range.h"
#include "dwi/tractography/SIFT/types.h"
 
 
 
namespace MR
{
  namespace DWI
  {
    namespace Tractography
    {
      namespace SIFT
      {
 
 
      class SIFTer : public Model<Fixel>
      { MEMALIGN(SIFTer)
 
        protected:
        using MapType = Model<Fixel>;
        using MapVoxel = Fixel_map<Fixel>::MapVoxel;
        using VoxelAccessor = Fixel_map<Fixel>::VoxelAccessor;
 
 
        public:
        SIFTer (Image<float>& i, const DWI::Directions::FastLookupSet& d) :
            MapType (i, d),
            output_debug (false),
            term_number (0),
            term_ratio (0.0),
            term_mu (0.0),
            enforce_quantisation (true) { }
 
        SIFTer (const SIFTer& that) = delete;
 
        ~SIFTer() { }
 
 
        // CORE OPERATIONS
        void perform_filtering();
        void output_filtered_tracks (const std::string&, const std::string&) const;
        void output_selection (const std::string&) const;
 
        // CONFIGURATION OPTIONS
        void set_term_number (const track_t i)      { term_number = i; }
        void set_term_ratio  (const float i)        { term_ratio = i; }
        void set_term_mu     (const float i)        { term_mu = i; }
        void set_csv_path    (const std::string& i) { csv_path = i; }
 
        void set_regular_outputs (const vector<uint32_t>&, const bool);
 
 
        // DEBUGGING
        void test_sorting_block_size (const size_t) const;
 
 
        protected:
        using Fixel_map<Fixel>::accessor;
        using Fixel_map<Fixel>::fixels;
 
        using MapType::FOD_sum;
        using MapType::TD_sum;
        using MapType::proc_mask;
        using MapType::num_tracks;
 
 
        // User-controllable settings
        vector<track_t> output_at_counts;
        bool    output_debug;
        track_t term_number;
        float   term_ratio;
        double  term_mu;
        bool    enforce_quantisation;
        std::string csv_path;
 
 
        // Convenience functions
        double calc_roc_cost_function() const;
        double calc_gradient (const track_t, const double, const double) const;
 
 
 
        // For calculating the streamline removal gradients in a multi-threaded fashion
        class TrackGradientCalculator
        { MEMALIGN(TrackGradientCalculator)
          public:
            TrackGradientCalculator (const SIFTer& sifter, vector<Cost_fn_gradient_sort>& v, const double mu, const double r) :
                master (sifter), gradient_vector (v), current_mu (mu), current_roc_cost (r) { }
            bool operator() (const TrackIndexRange&) const;
          private:
            const SIFTer& master;
            vector<Cost_fn_gradient_sort>& gradient_vector;
            const double current_mu, current_roc_cost;
        };
 
 
      };
 
 
 
 
      }
    }
  }
}
 
 
#endif