Subversion Repositories public iLand

/********************************************************************************************

**    iLand - an individual based forest landscape and disturbance model

**    http://iland.boku.ac.at

**    Copyright (C) 2009-  Werner Rammer, Rupert Seidl

**

**    This program is free software: you can redistribute it and/or modify

**    it under the terms of the GNU General Public License as published by

**    the Free Software Foundation, either version 3 of the License, or

**    (at your option) any later version.

**

**    This program is distributed in the hope that it will be useful,

**    but WITHOUT ANY WARRANTY; without even the implied warranty of

**    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

**    GNU General Public License for more details.

**

**    You should have received a copy of the GNU General Public License

**    along with this program.  If not, see <http://www.gnu.org/licenses/>.

********************************************************************************************/

#ifndef STAMP_H

#define STAMP_H

#include <QtCore>

#include "grid.h"

/** Stamp is the basic class for the LIP field of a individual tree.

    @ingroup core

    In iLand jargon, a Stamp is a LIP (light influence pattern). These patterns are pre-calculated using the "LightRoom" (http://iland.boku.ac.at/Lightroom)

    and stand for a field of influence (w.r.t. light) of a individual tree of a given size and species.

    see http://iland.boku.ac.at/competition+for+light

*/

class Stamp

{

public:

    /// @enum StampType defines different grid sizes for stamps (4x4 floats, ... 48x48 floats).

    /// the numeric value indicates also the size of the grid.

    enum StampType { est4x4=4, est8x8=8, est12x12=12, est16x16=16, est24x24=24, est32x32=32, est48x48=48, est64x64=64 };

    Stamp();

    ~Stamp();

    Stamp(const int size):m_data(NULL) { setup(size); }

    void setOffset(const int offset) { m_offset = offset; }

    static void setDistanceGrid(const Grid<float> *grid) { mDistanceGrid = grid; }

    int offset() const { return m_offset; } ///< delta between edge of the stamp and the logical center point (of the tree). e.g. a 5x5 stamp in an 8x8-grid has an offset from 2.

    int count() const { return m_size*m_size; } ///< count of pixels (rectangle)

    int size() const { return m_offset*2+1; } ///< logical size of the stamp

    int dataSize() const { return m_size; } ///< internal size of the stamp; e.g. 4 -> 4x4 stamp with 16 pixels.

    /// get a full access pointer to internal data

    float *data() { return m_data; }

    /// get pointer to the element after the last element (iterator style)

    const float *end() const { return &m_data[m_size*m_size]; }

    /// get pointer to data item with indices x and y

    inline float *data(const int x, const int y) const { return m_data + index(x,y); }

    void setData(const int x, const int y, const float value) { *data(x,y) = value; }

    /// get index (e.g. for data()[index]) for indices x and y

    inline int index(const int x, const int y) const {  Q_ASSERT(y*m_size + x < m_size*m_size); return y*m_size + x; }

    /// retrieve the value of the stamp at given indices x and y

    inline float operator()(const int x, const int y) const { return *data(x,y); }

    inline float offsetValue(const int x, const int y, const int offset) const { return *data(x+offset, y+offset); }

    const Stamp *reader() const { return m_reader; }

    void setReader(Stamp *reader) { m_reader = reader; setCrownRadius(reader->crownRadius()); /*calculates also the Area*/ }

    // property crown radius

    float crownRadius() const { return m_crownRadius; }

    float crownArea() const { return m_crownArea; }

    void setCrownRadius(const float r) { m_crownRadius = r; m_crownArea=r*r*M_PI; }

    float distanceToCenter(const int ix, const int iy) const { return mDistanceGrid->constValueAtIndex(abs(ix-m_offset), abs(iy-m_offset)); }

    // loading/saving

    void loadFromFile(const QString &fileName);

    void load(QDataStream &in); ///< load from stream (predefined binary structure)

    void save(QDataStream &out); ///< save to stream (predefined binary structure)

    QString dump() const;

private:

    void setup(const int size);

    float *m_data;

    float m_crownRadius;

    float m_crownArea;

    int m_size;

    int m_offset;

    Stamp *m_reader; ///< pointer to the appropriate reader stamp (if available)

    static const Grid<float> *mDistanceGrid;

};

// global functions

/// create a stamp from a FloatGrid with any size

/// @param grid source grid. It is assumed the actual stamp data is around the center point and the grid has an uneven size (e.g 13x13 or 25x25)

/// @param width number of pixels that should actually be used. e.g: grid 25x25, width=7 -> data is located from 9/9 to 16/16 (12+-3)

/// @return a stamp created on the heap with the fitting size. The data rect is aligned to 0/0. above example: stamp will be 8x8, with a 7x7-data-block from 0/0 to 6/6.

Stamp *stampFromGrid(const FloatGrid& grid, const int width);

#endif // STAMP_H