Representations/Perception/LowResImage.h

Go to the documentation of this file.

/**
 * @file LowResImage.h
 * 
 * Declaration of class LowResImage
 *
 * @author Max Risler
 */ 

#ifndef __LowResImage_h_
#define __LowResImage_h_

#include "Image.h"

class LowResImage;

/**
 * Streaming operator that writes a low resolution image to a stream.
 * @param stream The stream to write on.
 * @param lrImage The LowResImage object.
 * @return The stream.
 */ 
Out& operator<<(Out& stream,const LowResImage& lrImage);

/**
 * Streaming operator that reads a low resolution image from a stream.
 * @param stream The stream to read from.
 * @param lrImage The LowResImage object.
 * @return The stream.
 */ 
In& operator>>(In& stream,LowResImage& lrImage);

/**
 * Definition of a class for streaming images in low resolution i.e. without the three additional y channels.
 */
class LowResImage
{
  private:
    /**
    * A reference to the image
    */
    Image &image;

  public:
    /** 
     * Constructor.
     */
    LowResImage(Image& src) : image(src) {}

  friend Out& operator<<(Out& stream,const LowResImage& lrImage);
  friend In& operator>>(In& stream,LowResImage& lrImage);
};

#endif //__LowResImage_h_

---