Commit 0a9da37c authored by Makayla Shepherd's avatar Makayla Shepherd
Browse files

Updated documentation for Albedo and AlbedoAtm. References #4807. 

git-svn-id: http://subversion.wr.usgs.gov/repos/prog/isis3/trunk@7817 41f8697f-d340-4b68-9986-7bafba869bb8
parent 436f5eab

isis/src/base/objs/Albedo/Albedo.cpp

+2 −2
Original line number Diff line number Diff line
@@ -65,8 +65,8 @@ namespace Isis { 
   * @param dememission The local emission angle

   * @param dn The DN value

   * @param albedo ???

   * @param mult ???

   * @param base ???

   * @param mult The multiplier of the image

   * @param base The base of the image

   */

  void Albedo::NormModelAlgorithm(double phase, double incidence,

                                  double emission, double demincidence, double dememission,

isis/src/base/objs/Albedo/Albedo.h

+2 −2
Original line number Diff line number Diff line
@@ -53,7 +53,7 @@ namespace Isis { 
   *                      conditions in initialization

   *  @history 2010-11-30 Janet Barrett - Added ability to use photometric angles

   *                      from the ellipsoid or the DEM

   *  @history 2017-06-28 Makayla Shepherd - Updated documentation. References #4807.

   *  @history 2017-07-03 Makayla Shepherd - Updated documentation. References #4807.

   *

   */

  class Albedo : public NormModel {
@@ -88,7 +88,7 @@ namespace Isis { 
      void SetNormThresh(const double thresh);

      void SetNormAlbedo(const double albedo);



      double p_normPsurfref; //!< The Normal

      double p_normPsurfref; //!< ???

      double p_normPharef; //!< The reference phase angle

      double p_normIncref; //!< The reference incidence angle

      double p_normEmaref; //!< The reference emission angle

isis/src/base/objs/AlbedoAtm/AlbedoAtm.cpp

+11 −7
Original line number Diff line number Diff line
@@ -67,13 +67,17 @@ namespace Isis { 
  }



  /**

   * @param phase Value of phase angle.

   * @param incidence  Value of incidence angle.

   * @param emission Value of emission angle.

   * @param dn

   * @param albedo

   * @param mult

   * @param base

   * Performs the normalization.

   * 

   * @param phase The phase angle.

   * @param incidence The incidence angle.

   * @param emission The emission angle.

   * @param demincidence The local incidence angle

   * @param dememission The local emission angle

   * @param dn The DN value

   * @param albedo ???

   * @param mult The multiplier of the image

   * @param base The base of the image

   * @internal

   *   @history 2008-11-05 Jeannie Walldren - Modified references

   *          to NumericalMethods class and replaced Isis::PI with

isis/src/base/objs/AlbedoAtm/AlbedoAtm.h

+31 −19
Original line number Diff line number Diff line
@@ -48,6 +48,7 @@ namespace Isis { 
   *                          conditions in initialization

   *  @history 2010-11-30 Janet Barrett - Added ability to use photometric angles

   *                          from the ellipsoid and the DEM

   *  @history 2017-07-03 Makayla Shepherd - Updated documentation. References #4807.

   *

   */

  class AlbedoAtm : public NormModel {
@@ -57,6 +58,17 @@ namespace Isis { 
      virtual ~AlbedoAtm() {};



    protected:

      /**

       * Performs the normalization.

       * 

       * @param pha The phase angle.

       * @param inc The incidence angle.

       * @param ema The emission angle.

       * @param dn The DN value

       * @param albedo ???

       * @param mult The multiplier of the image

       * @param base The base of the image

       */

      virtual void NormModelAlgorithm(double pha, double inc, double ema,

                                      double dn, double &albedo, double &mult, double &base) {};

      virtual void NormModelAlgorithm(double pha, double inc, double ema,
@@ -69,17 +81,17 @@ namespace Isis { 
      void SetNormIncref(const double incref);

      void SetNormEmaref(const double emaref);



      double p_normPsurfref;

      double p_normPharef;

      double p_normIncref;

      double p_normEmaref;

      double p_normPstdref;

      double p_normAhref;

      double p_normMunotref;

      double p_normTransref;

      double p_normTrans0ref;

      double p_normTranss;

      double p_normSbar;

      double p_normPsurfref;  //!< ???

      double p_normPharef;    //!< The reference phase angle

      double p_normIncref;    //!< The reference incidence angle

      double p_normEmaref;    //!< The reference emission angle

      double p_normPstdref;   //!< ???

      double p_normAhref;     //!< ???

      double p_normMunotref;  //!< ???

      double p_normTransref;  //!< ???

      double p_normTrans0ref; //!< ???

      double p_normTranss;    //!< ???

      double p_normSbar;      //!< ???

  };

};