Pixmap (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.Pixmap

```
public class Pixmap
extends java.lang.Object
```
The Pixmap object allows you to access a Cumulus pixmap field.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Pixmap.AssetInfo
Wraps asset information.

static class Pixmap.JPEGInfo
Wraps image information.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Pixmap.AssetInfo` Wraps asset information.
`static class`	`Pixmap.JPEGInfo` Wraps image information.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`High` Value of the high image quality.
`static int`	`JPEG` Value of the compression for JPEG compressed images.
`static int`	`LZW` Value of the compression for LZW compressed images.
`static int`	`Monochrome` Value of the color mode for grayscale images.
`static int`	`Normal` Value of the normal image quality.
`static int`	`PNG` Value of the compression for PNG compressed images.
`static int`	`RGBColor` Value of the color mode for color images.
`static int`	`UNCOMPRESSED` Value of the compression for uncompressed images.

Constructor Summary

Constructors
Constructor and Description
`Pixmap()` Creates a new empty `Pixmap` object.
`Pixmap(byte[] packData)` Creates a new `Pixmap` object from a pack byte array.
`Pixmap(JPack pack)` Creates a new `Pixmap` object from a pack.

Method Summary

Methods
Modifier and Type	Method and Description
`static Pixmap`	`createFromAsset(Asset asset, java.lang.String assetHandlingSet)` Creates a pixel preview for the given asset.
`static Pixmap`	`createFromAsset(Asset asset, java.lang.String assetHandlingSet, int maxSize, int rotation)` Creates a pixel preview for the given asset.
`static Pixmap`	`createFromAsset(Asset asset, java.lang.String assetHandlingSet, int maxSizeWidth, int maxSizeHeight, int rotation)` Creates a pixel preview for the given asset.
`static Pixmap`	`createPixmapFromJPEG(byte[] jpgBytes)` Creates a new Pixmap object from a JPG stream given as a byte array.
`static Pixmap`	`createPixmapFromPNG(byte[] pngBytes)` Creates a new Pixmap object from a PNG stream given as a byte array.
`static Pixmap`	`createPixmapFromPNG(java.io.InputStream PNGStream)` Creates a new Pixmap object from a PNG stream.
`java.awt.image.BufferedImage`	`getAsImage(CumulusSession session, Item item, boolean extendImageAreaToBoundingBox, int maxSizeWidth, int maxSizeHeight, int rotation)` Return AWT image which optionally embeds the assets metadata tags.
`byte[]`	`getAsJPEG()` Returns the pixels as JPEG compressed data.
`byte[]`	`getAsJPEG(CumulusSession session, int maxSize, int rotation, int quality)`
`byte[]`	`getAsJPEG(int maxSize)` Returns the pixels as JPEG compressed data.
`byte[]`	`getAsJPEG(int maxSize, int rotation, int quality)` Returns the pixels as JPEG compressed data.
`byte[]`	`getAsJPEG(Item item, CumulusSession cumulusSession, int maxWidth, int maxHeight, int rotation, int quality)` Return JPEG image which optionally embeds the assets metadata tags.
`byte[]`	`getAsJPEG(Item item, int maxSize, int rotation, int quality)` Return JPEG image which optionally embeds the assets metadata tags.
`byte[]`	`getAsPNG(int maxSize, int rotation)` Returns the pixels as PNG compressed data.
`byte[]`	`getAsPNG(int maxSizeWidth, int maxSizeHeight, int rotation)` Returns the pixels as PNG compressed data.
`static Pixmap.AssetInfo`	`getAssetInfo(Asset asset)` Reads the image size and bitdepth if the given asset uses a supported format.
`int`	`getBitsPerPixel()` Returns the number of bits per pixel.
`int`	`getColorMode()` Returns the color mode.
`int`	`getCompressMethod()` Returns the compression method.
`byte[]`	`getData()` Returns the compressed pixel data.
`int`	`getHeight()` Returns the height of the image.
`JPack`	`getJPack()` Returns the internal data pack for this pixmap.
`int`	`getQuality()` Returns the image quality of the picture.
`int`	`getWidth()` Returns the width of the image.
`boolean`	`hasValue()` Return whether this Pixmap object holds a real image.
`void`	`optimize()` Optimize brightness and contrast.
`static Pixmap.JPEGInfo`	`readJPEGInfoFromAsset(Asset asset)` Reads the image size and bitdepth if the given asset references an accessible JPEG asset.
`void`	`rotate(int rotation)` Rotate the pixmap by a multiple of 90 degrees.
`static void`	`rotateJpeg(InputDataStream inStream, OutputDataStream outStream, int rotation, int quality)` Rotates a JPEG image by multiples of 90 degrees clockwise.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - Monochrome
```
public static final int Monochrome
```
    Value of the color mode for grayscale images.
    
    See Also:
    getColorMode(), Constant Field Values
  - RGBColor
```
public static final int RGBColor
```
    Value of the color mode for color images.
    
    See Also:
    getColorMode(), Constant Field Values
  - UNCOMPRESSED
```
public static final int UNCOMPRESSED
```
    Value of the compression for uncompressed images.
    
    Since:
    
    6.5.1
    
    See Also:
    getCompressMethod(), Constant Field Values
  - LZW
```
public static final int LZW
```
    Value of the compression for LZW compressed images.
    
    See Also:
    getCompressMethod(), Constant Field Values
  - JPEG
```
public static final int JPEG
```
    Value of the compression for JPEG compressed images.
    
    See Also:
    getCompressMethod(), Constant Field Values
  - PNG
```
public static final int PNG
```
    Value of the compression for PNG compressed images.
    
    Since:
    
    7.0
    
    See Also:
    getCompressMethod(), Constant Field Values
  - Normal
```
public static final int Normal
```
    Value of the normal image quality.
    
    See Also:
    getQuality(), Constant Field Values
  - High
```
public static final int High
```
    Value of the high image quality.
    
    See Also:
    getQuality(), Constant Field Values
- Constructor Detail
  - Pixmap
```
public Pixmap(byte[] packData)
```
    Creates a new Pixmap object from a pack byte array.
    
    For example:
```
 Fields fields = records.getRecord(index).getFields ();
 Field field = field.getFieldByID(GUID.UID_REC_THUMBNAIL);
 Pixmap pixmap = new Pixmap ((byte[]) f.getValue());
 Image image = Toolkit.getDefaultToolkit().createImage(pixmap.getData());
 ImageIcon imageIcon = new ImageIcon(image);
 
```
    Parameters:
    packData - a pack byte array obtained from a call to Item.getPictureValue(GUID).
  - Pixmap
```
public Pixmap(JPack pack)
```
    Creates a new Pixmap object from a pack.
    
    Parameters:
    pack - a pixmap pack
  - Pixmap
```
public Pixmap()
```
    Creates a new empty Pixmap object.
    
    Since:
    
    8.0
- Method Detail
  - hasValue
```
public boolean hasValue()
```
    Return whether this Pixmap object holds a real image.
    
    Returns:
    true if this object holds a valid image. Return false otherwise.
    Since:
    
    8.0
  - createPixmapFromJPEG
```
public static Pixmap createPixmapFromJPEG(byte[] jpgBytes)
```
    Creates a new Pixmap object from a JPG stream given as a byte array.
    
    Parameters:
    jpgBytes - a JPG stream.
    
    Returns:
    returns a new pixmap.
  - createPixmapFromPNG
```
public static Pixmap createPixmapFromPNG(java.io.InputStream PNGStream)
```
    Creates a new Pixmap object from a PNG stream.
    
    Parameters:
    PNGStream - a PNG stream.
    
    Returns:
    returns a new pixmap.
    Since:
    
    7.0
  - createPixmapFromPNG
```
public static Pixmap createPixmapFromPNG(byte[] pngBytes)
```
    Creates a new Pixmap object from a PNG stream given as a byte array.
    
    Parameters:
    pngBytes - a PNG stream.
    
    Returns:
    returns a new pixmap.
    Since:
    
    7.0
  - getJPack
```
public JPack getJPack()
```
    Returns the internal data pack for this pixmap.
    
    Returns:
    data pack
    Since:
    
    8.1.1
  - getWidth
```
public int getWidth()
             throws CumulusException
```
    Returns the width of the image.
    
    Returns:
    the width of the image in pixels.
    
    Throws:
    
    CumulusException - if the information is not available.
  - getHeight
```
public int getHeight()
              throws CumulusException
```
    Returns the height of the image.
    
    Returns:
    the height of the image in pixels.
    
    Throws:
    
    CumulusException - if the information is not available.
  - getBitsPerPixel
```
public int getBitsPerPixel()
                    throws CumulusException
```
    Returns the number of bits per pixel.
    Possible values are: 1, 2, 4, 8, 16 and 24. The values 2, 4, 8, and 16 are no longer created by Cumulus. They only appear in thumbnails created in older versions. Cumulus 5 only creates picture field value with bits-per-pixel of 1, 8 and 24.
    
    Returns:
    the number of bits per pixel.
    
    Throws:
    
    CumulusException - if the information is not available.
  - getColorMode
```
public int getColorMode()
                 throws CumulusException
```
    Returns the color mode.
    Possible values are:
    - Monochrome
    - RGBColor
    Returns:
    the color mode of the pixel values.
    
    Throws:
    
    CumulusException - if the information is not available.
  - getCompressMethod
```
public int getCompressMethod()
                      throws CumulusException
```
    Returns the compression method.
    Possible values are:
    - LZW
    - JPEG
    In case of LZW the compression is applied to the all pixels of the image. The LZW algorithm is the same as defined for the TIFF image format standard. Cumulus 5 uses LZW compression only for line art pictures (1 bit per pixel). Grayscale and RGB color images are always JPEG compressed.
    Returns:
    the method used to compress the pixel data.
    
    Throws:
    
    CumulusException - if the information is not available.
  - getData
```
public byte[] getData()
               throws CumulusException
```
    Returns the compressed pixel data.
    
    Returns:
    the compressed pixel data.
    
    Throws:
    
    CumulusException - if the information is not available.
  - getAsJPEG
```
public byte[] getAsJPEG()
                 throws CumulusException
```
    Returns the pixels as JPEG compressed data.
    
    Returns:
    the JPEG compressed pixel data.
    
    Throws:
    
    CumulusException - if the information is not available.
  - getAsJPEG
```
public byte[] getAsJPEG(int maxSize)
                 throws CumulusException
```
    Returns the pixels as JPEG compressed data. Scale down to maximum size if it is larger.
    
    Parameters:
    maxSize - maximum number of pixels for width and height.
    
    Returns:
    the JPEG compressed pixel data.
    
    Throws:
    
    CumulusException - if an error occurred.
  - getAsJPEG
```
public byte[] getAsJPEG(int maxSize,
               int rotation,
               int quality)
                 throws CumulusException
```
    Returns the pixels as JPEG compressed data. Scales down to given maximum size if it is larger. Also rotate the resulting image in steps of 90 degrees clockwise.
    
    Parameters:
    maxSize - maximum number of pixels for width and height.
    rotation - number of times to rotate by 90 degrees clockwise.
    quality - the quality used for JPEG compression. Possible values are between 1 (lowest) and 10 (best).
    
    Returns:
    the JPEG compressed pixel data.
    
    Throws:
    
    CumulusException - if an error occurred.
  - getAsJPEG
```
public byte[] getAsJPEG(CumulusSession session,
               int maxSize,
               int rotation,
               int quality)
                 throws CumulusException
```
    Throws:
    
    CumulusException
  - getAsJPEG
```
public byte[] getAsJPEG(Item item,
               int maxSize,
               int rotation,
               int quality)
                 throws CumulusException
```
    Return JPEG image which optionally embeds the assets metadata tags.
    
    Parameters:
    item - provider for the metadata tags to embed
    maxSize - maximum number of pixels for width and height.
    rotation - number of times to rotate by 90 degrees clockwise.
    quality - the quality used for JPEG compression. Possible values are between 1 (lowest) and 10 (best).
    
    Returns:
    the JPEG compressed pixel data.
    
    Throws:
    
    CumulusException - if an error occurred.
    Since:
    
    8.6
  - getAsJPEG
```
public byte[] getAsJPEG(Item item,
               CumulusSession cumulusSession,
               int maxWidth,
               int maxHeight,
               int rotation,
               int quality)
                 throws CumulusException
```
    Return JPEG image which optionally embeds the assets metadata tags.
    
    Parameters:
    item - provider for the metadata tags to embed or null if no metadata tags should be embedded
    cumulusSession - session specifying the user configuration for displaying pattern background for transparent images, or null if you don't want to see the pattern background
    maxWidth - maximum number of pixels for width.
    maxHeight - maximum number of pixels for height.
    rotation - number of times to rotate by 90 degrees clockwise.
    quality - the quality used for JPEG compression. Possible values are between 1 (lowest) and 10 (best).
    
    Returns:
    the JPEG compressed pixel data.
    
    Throws:
    
    CumulusException - if an error occurred.
    Since:
    
    9.0
  - getAsImage
```
public java.awt.image.BufferedImage getAsImage(CumulusSession session,
                                      Item item,
                                      boolean extendImageAreaToBoundingBox,
                                      int maxSizeWidth,
                                      int maxSizeHeight,
                                      int rotation)
                                        throws CumulusException
```
    Return AWT image which optionally embeds the assets metadata tags.
    
    Parameters:
    session - used to determine the background transparency grid configuration for transparent images. Can be null if no transparency grid should be painted
    item - provider for the metadata tags to embed or null if no metadata tags should be embedded.
    extendImageAreaToBoundingBox - expand the scaled image to the complete bounding box area. When this parameter is true, the returned image will always be a square with the maxSize as edge length, otherwise the returned image will keep the aspect ratio of the source pixmap.
    maxSizeWidth - maximum number of pixels for width.
    maxSizeHeight - maximum number of pixels for height.
    rotation - number of times to rotate by 90 degrees clockwise.
    
    Returns:
    the generated image
    
    Throws:
    
    CumulusException - if an error occurred.
    Since:
    
    9.0
  - getAsPNG
```
public byte[] getAsPNG(int maxSize,
              int rotation)
                throws CumulusException
```
    Returns the pixels as PNG compressed data. Scales down to given maximum size if it is larger. Also rotate the resulting image in steps of 90 degrees clockwise.
    
    Parameters:
    maxSize - maximum number of pixels for width and height.
    rotation - number of times to rotate by 90 degrees clockwise.
    
    Returns:
    PNG compressed image data
    
    Throws:
    
    CumulusException - if an error occurred.
    Since:
    
    8.1.1
  - getAsPNG
```
public byte[] getAsPNG(int maxSizeWidth,
              int maxSizeHeight,
              int rotation)
                throws CumulusException
```
    Returns the pixels as PNG compressed data. Scales down to given maximum size if it is larger. Also rotate the resulting image in steps of 90 degrees clockwise.
    
    Parameters:
    maxSizeWidth - maximum number of pixels for width.
    maxSizeHeight - maximum number of pixels for height.
    rotation - number of times to rotate by 90 degrees clockwise.
    
    Returns:
    PNG compressed image data
    
    Throws:
    
    CumulusException - if an error occurred.
    Since:
    
    9.0
  - getQuality
```
public int getQuality()
               throws CumulusException
```
    Returns the image quality of the picture.
    Possible values are:
    - Normal
    - High
    This information is kept in the picture to allow retaining the image quality when applying Cumulus uses different JPEG compression ratio depending on this quality.
    Returns:
    the image quality of the picture.
    
    Throws:
    
    CumulusException - if the information is not available.
  - rotateJpeg
```
public static void rotateJpeg(InputDataStream inStream,
              OutputDataStream outStream,
              int rotation,
              int quality)
                       throws CumulusException
```
    Rotates a JPEG image by multiples of 90 degrees clockwise.
    
    Parameters:
    inStream - an input stream of source the JPEG image data.
    outStream - an output stream of source the JPEG image data.
    rotation - number of times to rotate by 90 degrees clockwise.
    quality - the quality used for JPEG compression. Possible values are between 1 (lowest) and 10 (best).
    
    Throws:
    
    CumulusException - if the image cannot be rotated.
  - readJPEGInfoFromAsset
```
public static Pixmap.JPEGInfo readJPEGInfoFromAsset(Asset asset)
                                             throws CumulusException
```
    Reads the image size and bitdepth if the given asset references an accessible JPEG asset.
    
    Parameters:
    asset - the JPEG asset to read the information from.
    
    Returns:
    the image size and bitdepth.
    
    Throws:
    
    CumulusException - if the asset is not accessible or not a valid JPEG image.
    Since:
    
    6.5
  - getAssetInfo
```
public static Pixmap.AssetInfo getAssetInfo(Asset asset)
                                     throws CumulusException
```
    Reads the image size and bitdepth if the given asset uses a supported format.
    
    Parameters:
    asset - the asset to read the information from
    
    Returns:
    the size and bitdepth.
    
    Throws:
    
    CumulusException - if the asset is not accessible or not a valid format
    Since:
    
    8.5.2
  - createFromAsset
```
public static Pixmap createFromAsset(Asset asset,
                     java.lang.String assetHandlingSet)
                              throws CumulusException
```
    Creates a pixel preview for the given asset.
    
    Parameters:
    asset - the asset to create the preview for.
    assetHandlingSet - the name of the asset handling set to use. Specify null to use the default set.
    
    Returns:
    the newly created image.
    
    Throws:
    
    CumulusException - if the asset is not accessible or the format is not supported
    Since:
    
    6.5.1
  - createFromAsset
```
public static Pixmap createFromAsset(Asset asset,
                     java.lang.String assetHandlingSet,
                     int maxSize,
                     int rotation)
                              throws CumulusException
```
    Creates a pixel preview for the given asset.
    
    Parameters:
    asset - the asset to create the preview for.
    assetHandlingSet - the name of the asset handling set to use. Specify null to use the default set.
    maxSize - maximum size of the preview in pixels. Specify 0 to create a preview in the native size.
    rotation - number of times to rotate by 90 degrees clockwise.
    
    Returns:
    the newly created image.
    
    Throws:
    
    CumulusException - if the asset is not accessible or the format is not supported
    Since:
    
    6.5.1
  - createFromAsset
```
public static Pixmap createFromAsset(Asset asset,
                     java.lang.String assetHandlingSet,
                     int maxSizeWidth,
                     int maxSizeHeight,
                     int rotation)
                              throws CumulusException
```
    Creates a pixel preview for the given asset.
    
    Parameters:
    asset - the asset to create the preview for.
    assetHandlingSet - the name of the asset handling set to use. Specify null to use the default set.
    maxSizeWidth - maximum size of the preview width in pixels. Specify 0 to create a preview in the native size.
    maxSizeHeight - maximum size of the preview height in pixels. Specify 0 to create a preview in the native size.
    rotation - number of times to rotate by 90 degrees clockwise.
    
    Returns:
    the newly created image.
    
    Throws:
    
    CumulusException - if the asset is not accessible or the format is not supported
    Since:
    
    9.0
  - optimize
```
public void optimize()
```
    Optimize brightness and contrast. This only applies to JPEG compressed pixel maps. Other pixel maps will not be modified.
    
    Since:
    
    8.0
  - rotate
```
public void rotate(int rotation)
```
    Rotate the pixmap by a multiple of 90 degrees. Pixmap images of depth 1 (line art) will be converted to depth 8 (grayscale).
    
    Parameters:
    rotation - number of times to rotate by 90 degrees clockwise.
    Since:
    
    8.0

www.canto.com
Canto, the Canto logo, the Cumulus logo, and Cumulus are registered trademarks of Canto GmbH, registered in the U.S. and other countries.

Class Pixmap

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

Monochrome

RGBColor

UNCOMPRESSED

LZW

JPEG

PNG

Normal

High

Constructor Detail

Pixmap

Pixmap

Pixmap

Method Detail

hasValue

createPixmapFromJPEG

createPixmapFromPNG

createPixmapFromPNG

getJPack

getWidth

getHeight

getBitsPerPixel

getColorMode

getCompressMethod

getData

getAsJPEG

getAsJPEG

getAsJPEG

getAsJPEG

getAsJPEG

getAsJPEG

getAsImage

getAsPNG

getAsPNG

getQuality

rotateJpeg

readJPEGInfoFromAsset

getAssetInfo

createFromAsset

createFromAsset

createFromAsset

optimize

rotate