mlClusterRefCollection.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_CLUSTER_REF_COLLECTION_H
#define ML_CLUSTER_REF_COLLECTION_H
 


 
#include "MLClusterAlgorithmSystem.h"
 
#include "mlClusterInfo.h"
 
 
ML_START_NAMESPACE
 

// class ClusterRefType

class ClusterRefType : public ClusterInfo
{
public:
  // Default constructor
  ClusterRefType() : ClusterInfo(),
    link(nullptr)
  {
  }
 
  // Following methods return by reference to grant
  // access to the protected members of ClusterInfo,
  // so that values can be changed by ClusterRefCollection.

  ML_FORCE_INLINE void setIndexId(MLuint newIndex) { _indexId = newIndex; }
  ML_FORCE_INLINE void setNumVoxels(MLuint newNumVoxels) { _numVoxels = newNumVoxels; }
  ML_FORCE_INLINE void setRank(MLuint newRank) { _rank = newRank; }
  ClusterRefType* link;
 
  // The protected id from ClusterInfo is also used as
  // index in _clusterRefs, so don't change!
};
 
 


class ClusterRefCollection
{
public:
 
  // Constructor (recommended to use this one if possible, since it sets the initial array size already)
  ClusterRefCollection(MLuint initialCapacity=10);
 
  // Default destructor
  ~ClusterRefCollection();

  void init(MLuint numVoxels);

  MLuint getNewReference(MLdouble imageValue);

  void incrementClusterSize(MLuint reference);

  MLuint merge(MLuint ref1, MLuint ref2);

  const ClusterInfo& getClusterInfo(MLuint reference) const;
  const ClusterInfo& getClusterAt(MLuint rank) const;
  void setUserDataAtRank(MLuint rank, MLdouble userData);

  void addPositionToClusterBoundingBox(MLuint rank, MLint x, MLint y, MLint z);
  void addPositionToBackgroundBoundingBox(MLint x, MLint y, MLint z);

  ML_FORCE_INLINE const ClusterInfo& getBackground() const { return _backgroundCluster; }

  std::vector<ClusterInfo> getClusterInfoList() const;

  void calcClusterSizes(const ClusterUserDataParameters& userDataParameters);

  MLuint getNumClusters() const { return _numCluster; }
  MLuint getNumVoxelsInCluster(MLuint rankId) const;
 
private:
  // --- methods ---

  void resize();

  ML_FORCE_INLINE ClusterRefType* getRoot(ClusterRefType* const startElement) const
  {
    ClusterRefType* root = startElement;
    while (root->link != nullptr)
    {
      root = root->link;
    }
    return root;
  }
 
  MLuint getTotalNumVoxelsInClusters(const std::vector<ClusterRefType>& clusters) const;
  void countClustersAndCopyToSortVector();
  void countVoxelsForClusters();
  void setRankAndUserDataToClusters(const ClusterUserDataParameters& userDataParameters);
  void setRankAndUserDataToBackgroundCluster(const ClusterUserDataParameters& userDataParameters);
 
  // --- members ---

  MLuint _initialCapacity;

  ClusterRefType* _clusterRefs;
 
  ClusterRefType _backgroundCluster;

  MLuint _numReferences;

  MLuint _numCluster;

  MLuint _capacity;
  MLuint _numVoxels;

  std::vector<ClusterRefType> _clustersSortedBySize;
};
 
ML_END_NAMESPACE
 
 
#endif // __mlClusterRefCollection_H