These pages are auto-generated from self-documenting comments embedded in class files.
For more information on breve and steve, refer to the breve homepage.

Abstract : Image

Class description:

The Image class provides an interface to work with images and textures. The individual pixels of the image can be read or changed by the simulation as desired.

The image class can read rendered images from the screen using the method read-pixels, so that agents in the 3D world can have access to real rendered data. In addition, the method get-pixel-pointer can be used to provide a pointer to the RGBA pixel data so that plugins can access and analyze image data. This could be used, among other things, to implement agent vision.

Methods:

  • getAlphaPixel
  • getBluePixel
  • getCompressionSize
  • getGreenPixel
  • getHeight
  • getImageData
  • getPixelPointer
  • getRedPixel
  • getRgbPixel
  • getTextureNumber
  • getWidth
  • initWith
  • load
  • readDepth
  • readPixels
  • setAlphaPixel
  • setBluePixel
  • setGreenPixel
  • setPixel
  • setRedPixel
  • setRgbPixel
  • setSize
  • write
  • write16BitGrayscale
    getAlphaPixel( self, x, y )

    Returns the alpha channel pixel at the image coordinates (x, y). The pixel value is given on a scale from 0.0 to 1.0.

    getBluePixel( self, x, y )

    Returns the blue pixel at the image coordinates (x, y). The pixel value is given on a scale from 0.0 to 1.0.

    getCompressionSize( self )

    Compresses the image and returns the compression size. Useful for generating simple complexity measures based on image compression.

    getGreenPixel( self, x, y )

    Returns the green pixel at the image coordinates (x, y). The pixel value is given on a scale from 0.0 to 1.0.

    getHeight( self )

    Returns the width of the image.

    getImageData( self )

    getPixelPointer( self )

    Returns a pointer to the pixels this image is holding in RGBA format. The size of the buffer is 4 * height * width. This data is provided for plugin developers who wish to read or write pixel data directly.

    getRedPixel( self, x, y )

    Returns the red pixel at the image coordinates (x, y). The pixel value is given on a scale from 0.0 to 1.0.

    getRgbPixel( self, x, y )

    Returns the red, green and blue components of the pixel at image coordinates (x, y) as a vector.

    getTextureNumber( self )

    Internal use only.

    getWidth( self )

    Returns the width of the image.

    initWith( self, imageWidth, imageHeight )

    Deprecated.

    load( self, imageFile )

    Loads an image from the file imageFile.

    readDepth( self, x, y, lin, dist )

    Reads the depth into this Image from the rendered image on the screen. The resulting image can be written to a file or analyzed if desired. This is only supported in graphical versions of breve. The linearize option (if true) linearizes the depth buffer to a maximum distance so that for each pixel, the value corresponds to the distance from the centre of the camera. Values above the maximum distance (max-dist) are set to the maximum distance. If linearize is false, then this returns the raw depth buffer. This is considerably faster, but the values are not linear in the distance.

    readPixels( self, x, y )

    Reads pixels into this Image from the rendered image on the screen. The resulting image can be written to a file or analyzed if desired. This is only supported in graphical versions of breve.

    setAlphaPixel( self, alphaPixel, x, y )

    Sets the alpha pixel value at coordinates (x, y) to alphaPixel. alphaPixel should be a value between 0.0 and 1.0.

    setBluePixel( self, bluePixel, x, y )

    Sets the blue pixel value at coordinates (x, y) to bluePixel. bluePixel should be a value between 0.0 and 1.0.

    setGreenPixel( self, greenPixel, x, y )

    Sets the green pixel value at coordinates (x, y) to greenPixel. greenPixel should be a value between 0.0 and 1.0.

    setPixel( self, pixelVector, x, y )

    Deprecated -- for compatibility only.

    setRedPixel( self, redPixel, x, y )

    Sets the red pixel value at coordinates (x, y) to redPixel. redPixel should be a value between 0.0 and 1.0.

    setRgbPixel( self, pixelVector, x, y )

    Sets the red, green and blue pixel values at image coordinates (x, y) from the values in pixelVector.

    setSize( self, imageWidth, imageHeight )

    Creates an empty image buffer with width imageWidth and length imageLength.

    write( self, imageFile )

    Write the image to imageFile. The image is written as a PNG file, so imageFile should end with .PNG.

    write16BitGrayscale( self, imageFile )

    Write the image to imageFile. The image is written as a PNG file, so imageFile should end with .PNG.