generated_track.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_tracking_generated_track_h__
#define __dwi_tractography_tracking_generated_track_h__
 
 
#include "types.h"
 
#include "dwi/tractography/tracking/types.h"
 
 
namespace MR
{
  namespace DWI
  {
    namespace Tractography
    {
      namespace Tracking
      {
 
 
 
        class GeneratedTrack : public vector<Eigen::Vector3f>
        { MEMALIGN(GeneratedTrack)
 
 
          public:
 
            using BaseType = vector<Eigen::Vector3f>;
 
            enum class status_t { INVALID, SEED_REJECTED, TRACK_REJECTED, ACCEPTED };
 
            GeneratedTrack() : seed_index (0), status (status_t::INVALID) { }
            void clear() { BaseType::clear(); seed_index = 0; status = status_t::INVALID; }
            size_t get_seed_index() const { return seed_index; }
            status_t get_status() const { return status; }
            void reverse() { std::reverse (begin(), end()); seed_index = (size()-1) - seed_index; }
            void set_seed_index (const size_t i) { seed_index = i; }
            void set_status (const status_t i) { status = i; }
 
            float length (const float step_size) const
            {
              // Only in the context of a track being generated is it safe to
              //   exploit knowledge of the step size in order to calculate
              //   streamline length more efficiently; however we must consider
              //   the possibility of truncation of the final segment at either
              //   endpoint of the streamline
              // If this is not a safe assumption, Tractography::length() should
              //   instead be used
              switch (size()) {
                case 0: return NaN;
                case 1: return ((*this)[1] - (*this)[0]).norm();
                default:
                  return ((step_size * (size() - 2)) +
                          ((*this)[1]-(*this)[0]).norm() +
                          ((*this)[size()-1] - (*this)[size()-2]).norm());
              }
            }
 
            friend inline std::ostream& operator<< (std::ostream& stream, GeneratedTrack& tck)
            {
              stream << str(tck.size()) << " vertices, seed index " << str(tck.seed_index) << ", status ";
              switch (tck.status) {
                case status_t::INVALID:        stream << "INVALID"; break;
                case status_t::SEED_REJECTED:  stream << "SEED_REJECTED"; break;
                case status_t::TRACK_REJECTED: stream << "TRACK_REJECTED"; break;
                case status_t::ACCEPTED:       stream << "ACCEPTED"; break;
              }
              return stream;
            }
 
          private:
            size_t seed_index;
            status_t status;
 
        };
 
 
      }
    }
  }
}
 
#endif