avtShapeletDecompResult.h 3.9 KB
Newer Older
1 2
/*****************************************************************************
*
3
* Copyright (c) 2000 - 2008, Lawrence Livermore National Security, LLC
4
* Produced at the Lawrence Livermore National Laboratory
5
* LLNL-CODE-400142
6 7
* All rights reserved.
*
8
* This file is  part of VisIt. For  details, see https://visit.llnl.gov/.  The
9 10 11 12 13 14 15 16 17 18
* full copyright notice is contained in the file COPYRIGHT located at the root
* of the VisIt distribution or at http://www.llnl.gov/visit/copyright.html.
*
* Redistribution  and  use  in  source  and  binary  forms,  with  or  without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of  source code must  retain the above  copyright notice,
*    this list of conditions and the disclaimer below.
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this  list of  conditions  and  the  disclaimer (as noted below)  in  the
19 20 21
*    documentation and/or other materials provided with the distribution.
*  - Neither the name of  the LLNS/LLNL nor the names of  its contributors may
*    be used to endorse or promote products derived from this software without
22 23 24 25 26
*    specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT  HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR  IMPLIED WARRANTIES, INCLUDING,  BUT NOT  LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND  FITNESS FOR A PARTICULAR  PURPOSE
27 28 29
* ARE  DISCLAIMED. IN  NO EVENT  SHALL LAWRENCE  LIVERMORE NATIONAL  SECURITY,
* LLC, THE  U.S.  DEPARTMENT OF  ENERGY  OR  CONTRIBUTORS BE  LIABLE  FOR  ANY
* DIRECT,  INDIRECT,   INCIDENTAL,   SPECIAL,   EXEMPLARY,  OR   CONSEQUENTIAL
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
* DAMAGES (INCLUDING, BUT NOT  LIMITED TO, PROCUREMENT OF  SUBSTITUTE GOODS OR
* SERVICES; LOSS OF  USE, DATA, OR PROFITS; OR  BUSINESS INTERRUPTION) HOWEVER
* CAUSED  AND  ON  ANY  THEORY  OF  LIABILITY,  WHETHER  IN  CONTRACT,  STRICT
* LIABILITY, OR TORT  (INCLUDING NEGLIGENCE OR OTHERWISE)  ARISING IN ANY  WAY
* OUT OF THE  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
*****************************************************************************/

#ifndef AVT_SHAPELET_DECOMP_RESULT_H
#define AVT_SHAPELET_DECOMP_RESULT_H
#include <shapelets_exports.h>
#include <visitstream.h>
#include <vectortypes.h>

// ****************************************************************************
//  Class:  avtShapeletDecompResult
//
//  Purpose:
//    Holds the a shapelet decomposition result for an image. 
//
//  Programmer:  Cyrus Harrison
//  Creation:    December 12, 2007
//
//  Modifications:
55 56
//    Cyrus Harrison, Wed Jun 11 15:29:15 PDT 2008
//    Added support to retain the original data extents.
57 58 59 60 61 62 63 64 65 66
//
// ****************************************************************************

class AVTSHAPELETS_API avtShapeletDecompResult
{
  public:
    avtShapeletDecompResult(double beta, 
                            int nmax, 
                            int width, 
                            int height,
67
                            const doubleVector& extents,
68 69 70 71 72 73
                            const doubleVector& coeffs);

    avtShapeletDecompResult(const avtShapeletDecompResult&);
    avtShapeletDecompResult &operator=(const avtShapeletDecompResult&);
    virtual ~avtShapeletDecompResult();

74 75 76 77 78
    double              Beta()    const       { return beta;} 
    int                 NMax()    const       { return  nmax;}
    int                 Width()   const       { return width;}
    int                 Height()  const       { return height;}
    const doubleVector &Extents() const       { return extents;}
79 80
    const doubleVector &Coefficients() const  { return coeffs;}
    double              Coefficient(int,int) const;
81
    
82 83 84 85 86 87 88 89 90

    // pretty print 
    std::string         ToString() const;

  private:
    double       beta;
    int          nmax;
    int          width;
    int          height;
91
    doubleVector extents;
92 93 94 95 96 97 98
    doubleVector coeffs;
};



#endif