ImageFrame.h

/*
 
MIT License
 
Copyright (c) 2017 FMI Open Development / Markus Peura, first.last@fmi.fi
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
/*
Part of Rack development has been done in the BALTRAD projects part-financed
by the European Union (European Regional Development Fund and European
Neighbourhood Partnership Instrument, Baltic Sea Region Programme 2007-2013)
*/
#ifndef IMAGE_FRAME_H_
#define IMAGE_FRAME_H_ "ImageFrame 0.9,  2011.09.25 Markus.Peura@fmi.fi"
 
#include <stddef.h>  // size_t
 
#include "drain/Sprinter.h"
#include "drain/util/ValueScaling.h"
#include "drain/util/VariableMap.h"
 
#include "Geometry.h"
#include "ImageLike.h"
 
namespace drain
{
 
namespace image
{
 
class Channel;
 
 
class ImageFrame : public ImageLike {
 
 
public:
 
 
 
 
    typedef CastableIterator const_iterator;  // TODO...
    typedef CastableIterator iterator;
 
    inline
    ImageFrame() : propertiesPtr(&properties) { //, scalingPtr(&conf.getScaling()) {
        adjustBuffer();
        init();
    };
 
    // TODO: CHECK: -Wdeprecated-copy fires because this copy constructor is user-declared but
    // operator= is not. The constructor itself only calls adjustBuffer()+init() (its own comment
    // "copy properties? (no)" already flags that properties aren't copied), so it's unclear what
    // a correct operator= should even do here; needs a real look, not a blind `=default`.
    inline
    ImageFrame(const ImageFrame & src) : ImageLike(src), propertiesPtr(&properties) { // , scalingPtr(&conf.getScaling()) {
        adjustBuffer();
        init();
        // copy properties? (no)
    }
 
 
    virtual inline
    const ImageConf & getConf() const {
        return conf; // *this;
    }
 
    /*
    inline
    ImageConf & getConf() {
        return conf; // *this;
    }
    */
 
    inline
    void setPhysicalRange(const Range<double> &range, bool rescale=false){
        conf.setPhysicalRange(range, rescale);
    }
 
    inline
    void setPhysicalRange(double min, double max, bool rescale=false){
        conf.setPhysicalRange(min, max, rescale);
    }
 
 
    inline
    const iterator & begin() {
        return segmentBegin;
    }
 
    inline
    const iterator & end() {
        return segmentEnd;
    }
 
 
    inline
    const const_iterator & begin() const {
        return segmentBegin;
    }
 
    inline
    const const_iterator & end() const {
        return segmentEnd;
    }
 
 
    // TODO where is this actually needed? If in ImageViews, then should be virtual here.
    inline
    size_t address(size_t i) const {
        return (i);
    }
 
 
    // Note: this may change if box view is implemented in future. (viewBox width,height, offset i,j)
    inline
    size_t address(size_t i, size_t j) const {
        return ( + j * conf.area.getWidth() + i);
    }
 
 
    inline
    size_t address(size_t i, size_t j, size_t k) const {
        return ( + k*conf.area.getArea() + j*conf.area.getWidth() + i);
    }
 
    inline
    const void * getBuffer() const {
        return & buffer[0];  
    };
 
    inline
    void * getBuffer() {
        return &buffer[0];   
    };
 
    // END ImageCore...
 
 
    template <class T>
    inline
    void put(size_t i, T x){
        conf.caster.put( & bufferPtr[address(i) * conf.byteSize], x);  // why address(i)?
    }
 
 
    template <class T>
    inline
    void put(size_t i, size_t j, T x){
        conf.caster.put( & bufferPtr[address(i,j) * conf.byteSize], x);
    }
 
 
    template <class T>
    inline
    void put(size_t i, size_t j, size_t k, T x){
        conf.caster.put( & bufferPtr[address(i,j,k)*conf.byteSize], x);
    }
 
 
 
    template <class T, class P>
    inline
    void put(const Point2D<P> &p, T x){
        conf.caster.put( & bufferPtr[address(p.x,p.y)*conf.byteSize], x);
    }
 
 
 
    inline
    void putScaled(size_t i, double x) const {
        conf.caster.put( & bufferPtr[i*conf.byteSize], getScaling().inv(x));
        // return getScaling().fwd(conf.caster.get<double>( & bufferPtr[i * conf.byteSize ] ));
    }
 
 
    // TODO: consider virtual, with Channel::scalingPtr->inv(x) and Image::scaling.inv(x)    Could be just as fast, though...
    inline
    void putScaled(size_t i, size_t j, double x){
        conf.caster.put( & bufferPtr[address(i,j) * conf.byteSize], getScaling().inv(x));
    }
 
 
 
 
 
    template <class T>
    inline
    T get(size_t i) const {
        return conf.caster.get<T>( & bufferPtr[address(i)*conf.byteSize] );
    }
 
 
    template <class T>
    inline
    T get(size_t i, size_t j) const {
        return conf.caster.get<T>( & bufferPtr[address(i,j) * conf.byteSize ] );
    }
 
 
    template <class T>
    inline
    T get(size_t i, size_t j, size_t k) const {
        return conf.caster.get<T>( & bufferPtr[address(i,j,k) * conf.byteSize] );
    }
 
    inline
    double getScaled(size_t i) const {
        return getScaling().fwd(conf.caster.get<double>( & bufferPtr[i * conf.byteSize ] ));
    }
 
 
    // TODO: consider virtual, with Channel::scalingPtr->fwd(x) and Image::scaling.fwd(x)    Could be just as fast, though...
    inline
    double getScaled(size_t i, size_t j) const {
        return getScaling().fwd(conf.caster.get<double>( & bufferPtr[address(i,j) * conf.byteSize ] ));
    }
 
 
    template <class T,class P>
    inline
    T get(const Point2D<P> &p) const {
        return conf.caster.get<T>( & bufferPtr[address(p.x,p.y) * conf.byteSize ] );
    }
 
    template <class P>
    inline
    double getScaled(const Point2D<P> &p) const {
        return getScaling().fwd(conf.caster.get<double>( & bufferPtr[address(p.x,p.y) * conf.byteSize ] ));
        // return getScaling().fwd(conf.caster.get<double>( & bufferPtr[address(i,j) * conf.byteSize ] ));
    }
 
 
    template <class T, class P>
    inline
    void putPixel(const Point2D<P> &p, const std::vector<T> & pixel) const {
        for (typename std::vector<T>::size_type i = 0; i < pixel.size(); ++i) {
            conf.caster.put( & bufferPtr[address(p.x,p.y,i)*conf.byteSize], pixel[i]);
        }
    }
 
 
    template <class T, class P>
    inline
    void getPixel(const Point2D<P> &p, std::vector<T> & pixel) const {
        for (typename std::vector<T>::size_type i = 0; i < pixel.size(); ++i) {
            pixel[i] = conf.caster.get<T>( & bufferPtr[address(p.x,p.y,i)*conf.byteSize]);
        }
    }
 
 
    // TODO: what about value corresponding to physical min?
    inline
    void clear(){
        fill(0);
    };
 
    template <class T>
    inline
    void fill(T x){
        for (iterator it = segmentBegin; it != segmentEnd; ++it)
            *it = x;
    }
 
    void copyData(const ImageFrame & src);
 
 
    inline
    bool hasOverlap(const ImageFrame & image) const {
        return ((image.begin() < end()) && (image.end() > begin()));
    }
 
    /*
    inline
    bool isSame(const ImageFrame & image) const {
        return (getType() == image.getType()) && hasSameSegment(image);
    }
    */
 
 
    inline
    bool hasSameSegment(const ImageFrame & image) const {
        return ((image.begin() == begin()) && (image.end() == end()));
    }
 
 
 
 
    FlexVariableMap properties;
 
    virtual inline
    const FlexVariableMap & getProperties() const {
        return *propertiesPtr;
    }
 
    /*
    virtual inline
    FlexVariableMap & getProperties() {
        return *propertiesPtr;
    }
    */
 
 
    inline
    void setName(const std::string & s){ name = s; };
 
    inline
    const std::string & getName() const { return name; };
 
    void toStream(std::ostream &ostr = std::cout) const;
 
    virtual
    Channel & getChannel(size_t i) = 0;
 
    virtual
    const Channel & getChannel(size_t i) const = 0;
 
    virtual
    Channel & getAlphaChannel(size_t i=0) = 0;
 
    virtual
    const Channel & getAlphaChannel(size_t i=0) const = 0;
 
    virtual
    bool suggestType(const std::type_info &t);
 
    virtual
    bool requireGeometry(const Geometry & geometry);
 
    //  Experimental for ImageFrame
    virtual inline
    void initialize(const std::type_info &t, const Geometry & geometry){
 
        if (conf.getType() != t){
            Logger(getImgLog(), __FILE__, __FUNCTION__).error("tried to change type [", conf.getType(), "] to [", t, "]");
            return;
        }
        else if (conf.getGeometry() != geometry){
            Logger(getImgLog(), __FILE__, __FUNCTION__).error("tried to change geometry ", conf.getGeometry(), " to ", geometry);
            return;
        }
        else {
            return;
            // Logger mout(__FILE__, __FUNCTION__);
            // throw std::runtime_error(StringBuilder<>(__FILE__, "::",__FUNCTION__, ": tried to change ImageFrame geometry:", conf, " => ", conf.getGeometry()));
        }
 
    }
 
    //  Experimental for ImageFrame (does not change image; throws exception if change requested)
    virtual inline
    void initialize(const std::type_info &t, size_t width, size_t height, size_t imageChannels=1, size_t alphaChannels=0){
         initialize(t, Geometry(width, height, imageChannels, alphaChannels));
    }
 
 
protected:
 
    void init();
 
    void adjustBuffer();
 
    //std::vector<unsigned char> buffer;
 
    unsigned char * bufferPtr;
 
    iterator segmentBegin;
    iterator segmentEnd;
 
    // Caster caster;
 
    // Size of the storage type (1 for 8 bits, 2 for 16 bits, etc.)
    //size_t byteSize;
 
    /* Sets the type of pixel elements of the image.
     *
     */
    void setStorageType(const std::type_info &type);
 
    inline
    void unsetType(){
        throw std::runtime_error("ImageFrame infinite loop: -> unsetType() ?");
        //setStorageType(typeid(void));
    };
 
 
    void setView(const ImageFrame & src, size_t channelStart, size_t channelCount, bool catenate=false);
 
    inline
    bool isView() const {
        return (bufferPtr != &buffer[0]);
    };  // TODO: first channel not
 
 
protected:
 
    FlexVariableMap const * propertiesPtr;
 
 
 
    virtual inline
    void updateChannelVector() const {};
 
    std::string name;
 
    // Return pointer to pixel
    template <class T>
    inline
    T * retrieve(size_t a){
        return (T*) & buffer[ a*conf.byteSize ];
    }
 
    // Return pointer to pixel
    template <class T>
    inline
    const T * retrieve(size_t a) const {
        return (const T*) & buffer[ a*conf.byteSize ];
    }
 
 
    // Return pointer to pixel
    /*
    template <class T>
    inline
    T * retrieve(size_t i, size_t j){
        return (T*) & buffer[ a*conf.byteSize ];
    }
 
    template <class T>
    inline
    const T * retrieve(size_t i, size_t j) const {
        return (const T*) & buffer[ a*conf.byteSize ];
    }
    */
 
    std::vector<unsigned char> buffer; // non-private, for Image::swap().
 
private:
 
    //drain::ValueScaling const * scalingPtr;
 
};
 
 
 
inline
std::ostream & operator<<(std::ostream &ostr, const ImageFrame & src){
    src.toStream(ostr);
    return ostr;
}
 
 
 
} // image::
 
template <>
std::ostream & drain::Sprinter::toStream<drain::image::ImageFrame>(std::ostream & ostr, const drain::image::ImageFrame & src, const SprinterLayout & layout);
 
DRAIN_TYPENAME(drain::image::ImageFrame);
 
} // drain::
 
#endif /* IMAGE_FRAME_H_*/
 
// Drain