freESPopulation.h

Go to the documentation of this file.

/*=========================================================================

  Program:   F.R.E.E. - flexible registration evaluation engine
  Version:   v.1.0.0
  Date:      $Date: 2006/09/01 12:00:00 $
  Module:    $RCSfile: freESPopulation.h,v $
  Language:  C++



  Copyright (c) 2007 Ralf o Floca (Department of Medical Informatics,
  Institute for Medical Biometry and Informatics, University of Heidelberg,
  Germany). All rights reserved.
  See FREECopyright.txt or http://www.mi.med.uni-hd.de/free/copyright.htm
  for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __freESPopulation_h
#define __freESPopulation_h

#include "itkVectorContainer.h"

namespace FREE
{
  namespace ES
  {
    template <class TIndividual>
    class ITK_EXPORT Population :
      public itk::VectorContainer<unsigned long, typename TIndividual::Pointer>
    {
    public:
      /* Standard class typedefs. */
      typedef Population<TIndividual> Self;
      typedef itk::VectorContainer<unsigned long, typename TIndividual::Pointer> Superclass;
      typedef itk::SmartPointer<Self> Pointer;
      typedef itk::SmartPointer<const Self> ConstPointer;

      /* Method for creation through the object factory. */
      itkNewMacro(Self);

      /* Run-time type information (and related methods). */
      itkTypeMacro(Population, VectorContainer);

      /* Other typedefs */
      typedef TIndividual                                         IndividualType;
      typedef typename IndividualType::Pointer                    IndividualPointer;
      typedef typename Superclass::ElementIdentifier              ElementIdentifier;
      typedef unsigned long                                       GenerationIDType;
      typedef unsigned long                                       IndividualIDType;

      typedef typename IndividualType::StrategicParametersType    StrategicParametersType;

      GenerationIDType GetGenerationID() const {return m_GenerationID;};
      void SetGenerationID(GenerationIDType id) {m_GenerationID = id;};

      //Is usede to generate an unique ID for a new individual within the population.
      IndividualIDType GenerateUniqueIndividualID() {return m_UniqueID++;} ;

      IndividualIDType GetLastUniqueIndividualID() const {return m_UniqueID;} ;

      IndividualType* GetIndividualByUniqueID(IndividualIDType iID);

      itkSetObjectMacro(BestIndividualEver, IndividualType);
      itkGetConstObjectMacro(BestIndividualEver, IndividualType);
      itkGetObjectMacro(BestIndividualEver, IndividualType);

      itkSetObjectMacro(BestIndividual, IndividualType);
      itkGetConstObjectMacro(BestIndividual, IndividualType);
      itkGetObjectMacro(BestIndividual, IndividualType);

      const StrategicParametersType& StrategicParameters() const
      {
        return *(m_StrategicParameters.GetPointer());
      };

      StrategicParametersType& StrategicParameters()
      {
        return *(m_StrategicParameters.GetPointer());
      };

      virtual Pointer Clone() const;

    protected:
      Population();
      virtual ~Population(){}

      GenerationIDType m_GenerationID;
      IndividualIDType m_UniqueID;

      typename StrategicParametersType::Pointer m_StrategicParameters;

      IndividualPointer m_BestIndividualEver;

      IndividualPointer m_BestIndividual;

      virtual void PrintSelf(std::ostream& os, itk::Indent indent) const;

      void operator=(Self const& population);

    private:
      Population(Self const&); // Purposely not implemented.
    };

  } //end namspsace ES
} // end namespace FREE

#ifndef ITK_MANUAL_INSTANTIATION
#include "freESPopulation.txx"
#endif

#endif // __freESPopulations_h

---