lensfitnessobject.h

Go to the documentation of this file.

/*

  This file is a part of GRALE, a library to facilitate the simulation
  and inversion of gravitational lenses.

  Copyright (C) 2008-2012 Jori Liesenborgs

  Contact: jori.liesenborgs@gmail.com
  
  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.
  
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  
*/

#ifndef GRALE_LENSFITNESSOBJECT_H

#define GRALE_LENSFITNESSOBJECT_H

#include "graleconfig.h"
#include "projectedimagesinterface.h"
#include <errut/errorbase.h>
#include <vector>
#include <list>

namespace grale
{
        
class ImagesDataExtended;

class GRALE_IMPORTEXPORT LensFitnessObject : public errut::ErrorBase 
{
protected:
        LensFitnessObject()                                                             { }
public:
        virtual ~LensFitnessObject()                                                    { }
        
        virtual bool init(std::list<ImagesDataExtended *> &images, std::list<ImagesDataExtended *> &massScaleImages) = 0;

        virtual void postInit(const std::list<ImagesDataExtended *> &images, const std::list<ImagesDataExtended *> &massScaleImages, 
                              double angularScale)                                      { }

        virtual float calculateMassScaleFitness(const ProjectedImagesInterface &interface0) const = 0;

        virtual void calculateOverallFitness(const ProjectedImagesInterface &interface0, float *pFitnessValues) const = 0;

        virtual int getNumberOfFitnessComponents() const = 0;

        virtual int getImagesGroupSize() const = 0;
        
        // These are used in the factory initialization, to indicate what should be calculated and what original
        // information should be store


        virtual void getTotalCalcFlags(std::vector<bool> &deflectionFlags, std::vector<bool> &derivativeFlags, std::vector<bool> &potentialFlags) const = 0;

        virtual void getTotalStoreFlags(bool *pStoreIntens, bool *pStoreTimeDelay, bool *pStoreShearInfo) const = 0;

        virtual void getShortCalcFlags(std::vector<bool> &deflectionFlags, std::vector<bool> &derivativeFlags, std::vector<bool> &potentialFlags) const = 0;

        virtual void getShortStoreFlags(bool *pStoreIntens, bool *pStoreTimeDelay, bool *pStoreShearInfo) const = 0;

        // These are used in the genome fitness calculation. They all depend on the derivatives of the
        // deflection angle, so they can only be used for sources that have the derivative calculation
        // enabled in the ...CalcFlags functions below.
        // These functions then use these derivatives to calculate other properties


        virtual bool totalNeedInverseMagnifications() const = 0;

        virtual bool totalNeedShearComponents() const = 0;

        virtual bool totalNeedConvergence() const = 0;

        virtual const std::vector<bool> *getTotalInverseMagnificationFlags() const = 0;

        virtual const std::vector<bool> *getTotalShearComponentFlags() const = 0;

        virtual const std::vector<bool> *getTotalConvergenceFlags() const = 0;

        virtual bool shortNeedInverseMagnifications() const = 0;

        virtual bool shortNeedShearComponents() const = 0;

        virtual bool shortNeedConvergence() const = 0;

        virtual const std::vector<bool> *getShortInverseMagnificationFlags() const = 0;

        virtual const std::vector<bool> *getShortShearComponentFlags() const = 0;

        virtual const std::vector<bool> *getShortConvergenceFlags() const = 0;
};

} // end namespace

#endif // GRALE_LENSFITNESSOBJECT_H