Commit 3622a84d authored by Summer Stapleton's avatar Summer Stapleton
Browse files

Updated documentation for Basis1VariableFunction, Blobber,... 

Updated documentation for Basis1VariableFunction, Blobber, BoxcarCachingAlgorithm, Brick, Buffer, BufferManager, Calculator, Camera, CameraDetectorMap, CameraDistortionMap, CameraFactory, CameraFocalPlaneMap, CameraGroundMap, CameraPointInfo, CameraSkyMap, CameraStatistics, Centroid, Chip, CollectorMap, Color and Column. References #4807.

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

isis/src/base/objs/Basis1VariableFunction/Basis1VariableFunction.h

+24 −2
Original line number Diff line number Diff line
@@ -52,14 +52,15 @@ namespace Isis { 
   *

   * @internal

   *   @todo Add coded example

   *   @history 2005-03-16 Leah Dahmer modified file to support Doxygen

   *   @history 2005-03-16 Leah Dahmer - modified file to support Doxygen

   *                           documentation.

   *   @history 2008-01-08 Tracie Sucharski, Derived from BasisFunction class for

   *   @history 2008-01-08 Tracie Sucharski - Derived from BasisFunction class for

   *                          a single variable function.  Added Derivative

   *                          methods as pure virtuals.  This class was

   *                          developed as a convenience to simplify the

   *                          Derivative methods and any other methods that

   *                          might need to be developed in the future.

   *   @history 2017-08-30 Summer Stapleton - Updated documentation. References #4807.

   *

   */

  class Basis1VariableFunction : public Isis::BasisFunction {
@@ -68,7 +69,28 @@ namespace Isis { 
      //! Destroys the Basis1VariableFunction object.

      virtual ~Basis1VariableFunction() {};



      /**

       * This will take the Derivative with respect to the variable and evaluate at

       * given value.

       *

       * @param [in] value   (const double)  value at which to evaluate derivative

       * 

       * @return (double) The derivative evaluated at given value

       *

       */

      virtual double DerivativeVar(const double value) = 0;



      /**

       *  Evaluate the derivative defined by the given coefficients with respect to the coefficient

       *  at the given index, at the current value.

       *

       * @param [in]  value      (const double) value at which to evaluate derivative

       * @param [in]  coefIndex  (const int)    The index of the coefficient to

       *                                          differentiate with respect to

       *

       * @return    (double) The derivative evaluated at given value

       *

       */

      virtual double DerivativeCoef(const double value, const int coefIndex) = 0;



    protected:

isis/src/base/objs/Blobber/Blobber.cpp

+2 −0
Original line number Diff line number Diff line
@@ -228,6 +228,8 @@ namespace Isis { 
   * that may exist in the BLOB to its appropriate double precision value.

   *

   * @param [in] value (int) Integer value to convert

   *

   * @returns (double) The calculated double precision value

   */

  double Blobber::int2ToDouble(int value) const {

    if (value == NULL2) return NULL8;

isis/src/base/objs/Blobber/Blobber.h

+1 −0
Original line number Diff line number Diff line
@@ -107,6 +107,7 @@ namespace Isis { 
   *                           and added padding to control statements to fit

   *                           coding standards. Added padding to control

   *                           statements. References #1169.

   *   @history 2017-08-30 Summer Stapleton - Updated documentation. References #4807.

   */

  class Blobber {

    public:

isis/src/base/objs/BoxcarCachingAlgorithm/BoxcarCachingAlgorithm.cpp

+0 −9
Original line number Diff line number Diff line
@@ -36,8 +36,6 @@ namespace Isis { 
   *   kept in the cache, while the other chunks in the cache will all be

   *   tossed.

   *

   * @param numUniqueIOs The number of unique IO operations to keep the chunks

   *                     around for.

   */

  BoxcarCachingAlgorithm::BoxcarCachingAlgorithm() {

    m_minLine = 1;
@@ -67,8 +65,6 @@ namespace Isis { 
    (void) justRequested; // unused, for fullfilling virtual function signiture 

    QList<RawCubeChunk *> chunksToToss;



    //std::cerr << "begin" << std::endl;



    if (justUsed.size() > 0) {

      // TODO bands

      int minLine = justUsed[0]->getStartLine();
@@ -88,15 +84,10 @@ namespace Isis { 
          int currentEnd = chunk->getStartLine() + chunk->lineCount() - 1;



          if (currentEnd < minLine) {

            //std::cerr << "minLine = " << minLine << " | maxLine = " << maxLine << std::endl;

            //std::cerr << "currentStart = " << currentStart << " | currentEnd = " << currentEnd << std::endl;

            chunksToToss.append(chunk);

          }

        }

      }



      //std::cerr << "allocated chunks = " << allocated.size() << std::endl;

      //std::cerr << "num chunks = " << chunksToToss.size() << std::endl;

    }



    return CacheResult(chunksToToss);

isis/src/base/objs/BoxcarCachingAlgorithm/BoxcarCachingAlgorithm.h

+2 −1
Original line number Diff line number Diff line
@@ -43,6 +43,7 @@ namespace Isis { 
   * @author ????-??-?? Jai Rideout and Steven Lambright

   *

   * @internal

   *   @history 2017-08-30 Summer Stapleton - Updated documentation. References #4807.

   */

  class BoxcarCachingAlgorithm : public CubeCachingAlgorithm {

    public:
@@ -54,7 +55,7 @@ namespace Isis { 
          const Buffer &justRequested);



    private:

      int m_minLine;

      int m_minLine;  //!< Used to calculate what lines to cache

  };

}