HapkeExponential.h

Go to the documentation of this file.

#ifndef HapkeExponential_h
#define HapkeExponential_h
/**
 * @file
 * $Revision$
 * $Date$
 *
 *   Unless noted otherwise, the portions of Isis written by the USGS are
 *   public domain. See individual third-party library and package descriptions
 *   for intellectual property information, user agreements, and related
 *   information.
 *
 *   Although Isis has been used by the USGS, no warranty, expressed or
 *   implied, is made by the USGS as to the accuracy and functioning of such
 *   software and related material nor shall the fact of distribution
 *   constitute any such warranty, and no responsibility is assumed by the
 *   USGS in connection therewith.
 *
 *   For additional information, launch
 *   $ISISROOT/doc//documents/Disclaimers/Disclaimers.html
 *   in a browser or see the Privacy & Disclaimers page on the Isis website,
 *   http://isis.astrogeology.usgs.gov, and the USGS privacy and disclaimers on
 *   http://www.usgs.gov/privacy.html.
 */

#include <iostream>
#include <sstream>
#include <iomanip>
#include <vector>

#include "PhotometricFunction.h"
#include "IString.h"
#include "Camera.h"
#include "DbProfile.h"
#include "SpecialPixel.h"

namespace Isis {
    class PvlObject;
    class Camera;

    /**
     * @brief An implementation of the HapkeExponential photometric function
     *
     * This class implements the Exponential-Buratti-Hill photometric
     * equation as outline in thier paper "Multispectral Photometry
     * of the Moon and Absolute Calibration of the Clementine UV/VIS
     * Camera", published in Icaris v141, pg. 205-255 (1999).
     *
     * @author  2010-02-15 Kris Becker
     *
     * @internal
     */
    class HapkeExponential : public PhotometricFunction {
        public:
            /**
             * @brief Create Hilier photometric object
             *
             */
            HapkeExponential (PvlObject &pvl, Cube &cube, bool useCamera) : PhotometricFunction(pvl, cube, useCamera) {init(pvl, cube);}

            //! Destructor
            virtual ~HapkeExponential () {}

            double photometry ( double i, double e, double g, int band = 1 ) const;
            void Report ( PvlContainer &pvl );

        private:
            /**
             * @brief Container for band photometric correction parameters
             *
             * @author Kris Becker - 2/21/2010
             */
            struct Parameters {
                    Parameters () :
                        aTerms(), bTerms(), wavelength(0.0), tolerance(0.0), units("Degrees"), phaUnit(1.0), band(0), phoStd(
                                0.0), iProfile(-1) {
                    }
                    ~Parameters () {
                    }
                    bool IsValid () const {
                        return (iProfile != -1);
                    }
                    std::vector<double> aTerms; //<! a-terms for exponential in form a*e^(b*x)
                    std::vector<double> bTerms; //<! b-terms for exponential in form a*e^(b*x)
                    double wavelength; //<! Wavelength for correction
                    double tolerance; //<! Wavelength Range/Tolerance
                    QString units; //<! Phase units of Hiller eq.
                    double phaUnit; // 1 for degrees, Pi/180 for radians
                    int band; //<! Cube band parameters
                    double phoStd; //<! Computed photometric std.
                    int iProfile; //<! Profile index of this data
            };

            std::vector<DbProfile> _profiles;
            std::vector<Parameters> _bandpho;

            void init(PvlObject &pvl, Cube &cube);

            double photometry ( const Parameters &parms, double i, double e, double g ) const;

            Parameters findParameters ( const double wavelength ) const;
            Parameters extract ( const DbProfile &profile ) const;
    };

}
;

#endif