html/nightly/DataSetStats_8hpp_source.html

#pragma once


#include "opals/config.hpp"

#include "opals/Vector.hpp"

#include "opals/Array.hpp"

#include "opals/Path.hpp"

#include "opals/DataSetType.hpp"

#include "opals/AttributeBandDescription.hpp"

#include "opals/IndexDescription.hpp"


namespace opals

{

  /// \brief  DataSetStats provides generic information about a data file (use in opalsInfo).

  ///

  /// Beside the name, type, storage size (in bytes) and a nodata indicator of the attribute the

  /// class provides basic statistic information such as min, max, mean and the standard deviation.

  /// If a specific information is really set, can be retrieved by the corresponding isSet function.

  /// Depending on the data type a specific no data value is used to indicate unset values.

  ///

  /// \author JO

  /// \date   24.05.2012

  class OPALS_API DataSetStats

  {

  public:

    static DataSetStats merge(Vector<DataSetStats> &stats, bool mergeFilenames);

    static DataSetStats readFromOverview(const Path &overviewFilename);


    typedef Array<double,6>                    ArrayD6;

    typedef Vector< AttributeBandDescription > AttributeVector;

    typedef Vector< IndexDescription >         IndexVector;

    typedef Vector< String >                   StringVector;

    typedef Array<double,2>                    ArrayD2;

    typedef Array<unsigned, 2>                 ArrayU2;


    DataSetStats();

    ~DataSetStats();


    void reset();


    // isSet functions ================================================

    bool isEmpty()                const;

    bool hasValueFrequency()      const;


    //common part

    bool isSetFilename()          const;

    bool isSetType()              const;

    bool isSetVersion()           const;

    bool isSetCreator()           const;

    bool isSetBoundingBox()       const;

    bool isSetCoordRefSys()       const;

    // odm part

    bool isSetPointCount()        const;

    bool isSetLineCount()         const;

    bool isSetPolygonCount()      const;

    bool isSetBoundaryPolygon()   const;

    bool isSetPointDensity()      const;

    bool isSetAttributes()        const;

    bool isSetIndices()           const;

    //Raster Part

    bool isSetPixelCount()            const;

    bool isSetRasterDimension()       const;

    bool isSetBands()                 const;

    bool isSetPixelSize()             const;

    bool isSetCompression()           const;

    bool isSetInterleave()            const;

    bool isSetErrorMessage()          const;


    // Get functions ================================================

    //common part

    Path      getFilename()         const;

    DataSetType getType()     const;

    String    getVersion()          const;

    String    getCreator()          const;

    ArrayD6   getBoundingBox()      const;

    int       getBoundingBoxDim()   const;

    String    getCoordRefSys()      const;

    // odm part

    long long getPointCount()         const;

    long long getLineCount()          const;

    long long getPolygonCount()       const;

    StringVector getBoundaryPolygon() const;

    double    getPointDensity()       const;

    AttributeVector getAttributes()   const;

    IndexVector     getIndices()      const;  ///< get info object about the spatial indices

    //Raster Part

    long long getPixelCount()       const;

    AttributeVector getBands()      const;

    ArrayD2 getPixelSize()          const;

    ArrayU2 getRasterDimension()    const;

    bool getPixelAreaOrPointFlag()  const;

    String getCompression()         const;

    String getInterleave()          const;

    String getErrorMessage()        const;


    // set functions ================================================

    //common part

    void setFilename(const Path& Filename);

    void setType(const DataSetType &Type);

    void setVersion(const String &Version);

    void setCreator(const String& Creator);

    void setBoundingBox(const ArrayD6& BoundingBox);

    void setBoundingBoxDim(const int& BoundingBoxDim);

    void setCoordRefSys(const String& crs);

    // odm part

    void setPointCount(const long long& PointCount);

    void setLineCount(const long long& LineCount);

    void setPolygonCount(const long long& PolygonCount);

    void setBoundaryPolygon(const StringVector& BoundaryPolygon);

    void setPointDensity(const double &PointDensity);

    void setAttributes(const AttributeVector& Attributes);

    void setIndices(const IndexVector& Indecs);

    //Raster Part

    void setPixelCount(const long long&  PixelCount);

    void setBands(const AttributeVector& Bands)     ;

    void setPixelSize(const ArrayD2& PixelSize);

    void setRasterDimension(const ArrayU2&  dim);

    void setPixelAreaOrPointFlag(const bool& PixelAreaOrPointFlag);

    void setCompression(const String& Compression);

    void setInterleave(const String& Interleave);

    void setErrorMessage(const String& errorMessage);


    String logDataSetStats(int precision=3) const;    ///< for xml output

    String printDataSetStats() const; ///< for log output (in more readable format)

    String printValueFrequency() const; ///< for log output (in more readable format)


  private:

    Path              filename;

    DataSetType type;

    String            version;


    long long pointCount;

    long long lineCount;

    long long polygonCount;


    ArrayD6 boundingBox;

    int     boundingBoxDim;


    StringVector  boundaryPolygon;

    double  pointDensity;


    String  creator;

    String  coordRefSys;


    AttributeVector attributes;

    IndexVector     indices;


    long long pixelcount;

    AttributeVector bands;


    ArrayD2 pixelsize;

    ArrayU2 rasterdim;

    bool pixelareaorpointflag;

    String compression;

    String interleave;


    String errorMessage;

  };

}