FlyCapture2.Image (JavaCPP Presets for FlyCapture 2.13.3.31-1.4.4 API)

java.lang.Object
- org.bytedeco.javacpp.Pointer
- - org.bytedeco.javacpp.FlyCapture2.Image

All Implemented Interfaces:

AutoCloseable

Enclosing class:

FlyCapture2
```
@Namespace(value="FlyCapture2")
 @NoOffset
public static class FlyCapture2.Image
extends Pointer
```
The Image class is used to retrieve images from a camera, convert between multiple pixel formats and save images to disk. Operations on Image objects are not guaranteed to be thread safe. It is recommended that operations on Image objects be protected by thread synchronization constructs such as mutexes.

Nested Class Summary
- Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer
  Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator

Field Summary
- Fields inherited from class org.bytedeco.javacpp.Pointer
  address, capacity, limit, position

Constructor Summary

Constructors
Constructor and Description
`Image()` Default constructor.
`Image(byte[] pData, int dataSize)`
`Image(ByteBuffer pData, int dataSize)`
`Image(BytePointer pData, int dataSize)` Construct an Image object with the specified arguments.
`Image(FlyCapture2.Image image)` Copy constructor.
`Image(int rows, int cols, int format)`
`Image(int rows, int cols, int stride, byte[] pData, int dataSize, int format)`
`Image(int rows, int cols, int stride, byte[] pData, int dataSize, int format, int bayerFormat)`
`Image(int rows, int cols, int stride, byte[] pData, int dataSize, int receivedDataSize, int format, int bayerFormat)`
`Image(int rows, int cols, int stride, ByteBuffer pData, int dataSize, int format)`
`Image(int rows, int cols, int stride, ByteBuffer pData, int dataSize, int format, int bayerFormat)`
`Image(int rows, int cols, int stride, ByteBuffer pData, int dataSize, int receivedDataSize, int format, int bayerFormat)`
`Image(int rows, int cols, int stride, BytePointer pData, int dataSize, int format)`
`Image(int rows, int cols, int stride, BytePointer pData, int dataSize, int format, int bayerFormat)` Construct an Image object with the specified arguments.
`Image(int rows, int cols, int stride, BytePointer pData, int dataSize, int receivedDataSize, int format, int bayerFormat)` Construct an Image object with the specified arguments.
`Image(int rows, int cols, int format, int bayerFormat)` Construct an Image object with the specified arguments.
`Image(long size)` Native array allocator.
`Image(Pointer p)` Pointer cast constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BytePointer`	`apply(int row, int col)` Indexing operator.
`FlyCapture2.Error`	`CalculateStatistics(FlyCapture2.ImageStatistics pStatistics)` Calculate statistics associated with the image.
`FlyCapture2.Error`	`Convert(FlyCapture2.Image pDestImage)` Converts the current image buffer to the specified output format and stores the result in the specified image.
`FlyCapture2.Error`	`Convert(int format, FlyCapture2.Image pDestImage)` Converts the current image buffer to the specified output format and stores the result in the specified image.
`FlyCapture2.Error`	`DeepCopy(FlyCapture2.Image pImage)` Perform a deep copy of the Image.
`static int`	`DetermineBitsPerPixel(int format)` Calculate the bits per pixel for the specified pixel format.
`BytePointer`	`get(int index)` Indexing operator.
`int`	`GetBayerTileFormat()` Get the Bayer tile format of the image.
`int`	`GetBitsPerPixel()` Get the bits per pixel of the image.
`int`	`GetBlockId()` get the block id of the Image object.
`int`	`GetColorProcessing()` Get the current color processing algorithm.
`int`	`GetCols()` Get the number of columns in the image.
`BytePointer`	`GetData()` Get a pointer to the data associated with the image.
`int`	`GetDataSize()` Get the size of the buffer associated with the image, in bytes.
`static int`	`GetDefaultColorProcessing()` Get the default color processing algorithm.
`static int`	`GetDefaultOutputFormat()` Get the default output pixel format.
`void`	`GetDimensions(int[] pRows)`
`void`	`GetDimensions(int[] pRows, int[] pCols, int[] pStride, int[] pPixelFormat, int[] pBayerFormat)`
`void`	`GetDimensions(IntBuffer pRows)`
`void`	`GetDimensions(IntBuffer pRows, IntBuffer pCols, IntBuffer pStride, IntBuffer pPixelFormat, IntBuffer pBayerFormat)`
`void`	`GetDimensions(IntPointer pRows)`
`void`	`GetDimensions(IntPointer pRows, IntPointer pCols, IntPointer pStride, IntPointer pPixelFormat, IntPointer pBayerFormat)` Get the image dimensions associated with the image.
`FlyCapture2.ImageMetadata`	`GetMetadata()` Get the metadata associated with the image.
`int`	`GetPixelFormat()` Get the current pixel format.
`int`	`GetReceivedDataSize()` Get the size of the compressed data, in bytes.
`int`	`GetRows()` Get the number of rows in the image.
`int`	`GetStride()` Get the stride in the image.
`FlyCapture2.TimeStamp`	`GetTimeStamp()` Get the timestamp data associated with the image.
`FlyCapture2.Image`	`position(long position)`
`FlyCapture2.Image`	`put(FlyCapture2.Image image)` Assignment operator.
`FlyCapture2.Error`	`ReleaseBuffer()` Release the buffer associated with the Image.
`FlyCapture2.Error`	`Save(BytePointer pFilename)`
`FlyCapture2.Error`	`Save(BytePointer pFilename, FlyCapture2.BMPOption pOption)` Save the image to the specified file name with the options specified.
`FlyCapture2.Error`	`Save(BytePointer pFilename, FlyCapture2.JPEGOption pOption)` Save the image to the specified file name with the options specified.
`FlyCapture2.Error`	`Save(BytePointer pFilename, FlyCapture2.JPG2Option pOption)` Save the image to the specified file name with the options specified.
`FlyCapture2.Error`	`Save(BytePointer pFilename, FlyCapture2.PGMOption pOption)` Save the image to the specified file name with the options specified.
`FlyCapture2.Error`	`Save(BytePointer pFilename, FlyCapture2.PNGOption pOption)` Save the image to the specified file name with the options specified.
`FlyCapture2.Error`	`Save(BytePointer pFilename, FlyCapture2.PPMOption pOption)` Save the image to the specified file name with the options specified.
`FlyCapture2.Error`	`Save(BytePointer pFilename, FlyCapture2.TIFFOption pOption)` Save the image to the specified file name with the options specified.
`FlyCapture2.Error`	`Save(BytePointer pFilename, int format)` Save the image to the specified file name with the file format specified.
`FlyCapture2.Error`	`Save(String pFilename)`
`FlyCapture2.Error`	`Save(String pFilename, FlyCapture2.BMPOption pOption)`
`FlyCapture2.Error`	`Save(String pFilename, FlyCapture2.JPEGOption pOption)`
`FlyCapture2.Error`	`Save(String pFilename, FlyCapture2.JPG2Option pOption)`
`FlyCapture2.Error`	`Save(String pFilename, FlyCapture2.PGMOption pOption)`
`FlyCapture2.Error`	`Save(String pFilename, FlyCapture2.PNGOption pOption)`
`FlyCapture2.Error`	`Save(String pFilename, FlyCapture2.PPMOption pOption)`
`FlyCapture2.Error`	`Save(String pFilename, FlyCapture2.TIFFOption pOption)`
`FlyCapture2.Error`	`Save(String pFilename, int format)`
`FlyCapture2.Error`	`SetBlockId(int blockId)` Set the block id of the Image object.
`FlyCapture2.Error`	`SetColorProcessing(int colorProc)` Set the color processing algorithm.
`FlyCapture2.Error`	`SetData(byte[] pData, int dataSize)`
`FlyCapture2.Error`	`SetData(ByteBuffer pData, int dataSize)`
`FlyCapture2.Error`	`SetData(BytePointer pData, int dataSize)` Set the data of the Image object.
`static FlyCapture2.Error`	`SetDefaultColorProcessing(int defaultMethod)` Set the default color processing algorithm.
`static FlyCapture2.Error`	`SetDefaultOutputFormat(int format)` Set the default output pixel format.
`FlyCapture2.Error`	`SetDimensions(int rows, int cols, int stride, int pixelFormat, int bayerFormat)` Sets the dimensions of the image object.

Methods inherited from class org.bytedeco.javacpp.Pointer
address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, put, realloc, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Image
```
public Image(Pointer p)
```
Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Image
```
public Image(long size)
```
Native array allocator. Access with Pointer.position(long).

Image
```
public Image()
```
Default constructor.

Image

public Image(@Cast(value="unsigned int")
             int rows,
             @Cast(value="unsigned int")
             int cols,
             @Cast(value="unsigned int")
             int stride,
             @Cast(value="unsigned char*")
             BytePointer pData,
             @Cast(value="unsigned int")
             int dataSize,
             @Cast(value="FlyCapture2::PixelFormat")
             int format,
             @Cast(value="FlyCapture2::BayerTileFormat")
             int bayerFormat)

Construct an Image object with the specified arguments. Ownership of the image buffer is not transferred to the Image object. It is the user's responsibility to delete the buffer when it is no longer in use.

Parameters:: rows - Rows in the image.; cols - Columns in the image.; stride - Stride of the image buffer.; pData - Pointer to the image buffer.; dataSize - Size of the image buffer.; format - Pixel format.; bayerFormat - Format of the Bayer tiled raw image.

Image

public Image(@Cast(value="unsigned int")
             int rows,
             @Cast(value="unsigned int")
             int cols,
             @Cast(value="unsigned int")
             int stride,
             @Cast(value="unsigned char*")
             BytePointer pData,
             @Cast(value="unsigned int")
             int dataSize,
             @Cast(value="FlyCapture2::PixelFormat")
             int format)

Image

public Image(@Cast(value="unsigned int")
             int rows,
             @Cast(value="unsigned int")
             int cols,
             @Cast(value="unsigned int")
             int stride,
             @Cast(value="unsigned char*")
             ByteBuffer pData,
             @Cast(value="unsigned int")
             int dataSize,
             @Cast(value="FlyCapture2::PixelFormat")
             int format,
             @Cast(value="FlyCapture2::BayerTileFormat")
             int bayerFormat)

Image

public Image(@Cast(value="unsigned int")
             int rows,
             @Cast(value="unsigned int")
             int cols,
             @Cast(value="unsigned int")
             int stride,
             @Cast(value="unsigned char*")
             ByteBuffer pData,
             @Cast(value="unsigned int")
             int dataSize,
             @Cast(value="FlyCapture2::PixelFormat")
             int format)

Image

public Image(@Cast(value="unsigned int")
             int rows,
             @Cast(value="unsigned int")
             int cols,
             @Cast(value="unsigned int")
             int stride,
             @Cast(value="unsigned char*")
             byte[] pData,
             @Cast(value="unsigned int")
             int dataSize,
             @Cast(value="FlyCapture2::PixelFormat")
             int format,
             @Cast(value="FlyCapture2::BayerTileFormat")
             int bayerFormat)

Image

public Image(@Cast(value="unsigned int")
             int rows,
             @Cast(value="unsigned int")
             int cols,
             @Cast(value="unsigned int")
             int stride,
             @Cast(value="unsigned char*")
             byte[] pData,
             @Cast(value="unsigned int")
             int dataSize,
             @Cast(value="FlyCapture2::PixelFormat")
             int format)

Image

public Image(@Cast(value="unsigned int")
             int rows,
             @Cast(value="unsigned int")
             int cols,
             @Cast(value="unsigned int")
             int stride,
             @Cast(value="unsigned char*")
             BytePointer pData,
             @Cast(value="unsigned int")
             int dataSize,
             @Cast(value="unsigned int")
             int receivedDataSize,
             @Cast(value="FlyCapture2::PixelFormat")
             int format,
             @Cast(value="FlyCapture2::BayerTileFormat")
             int bayerFormat)

Parameters:: rows - Rows in the image.; cols - Columns in the image.; stride - Stride of the image buffer.; pData - Pointer to the image buffer.; dataSize - Size of the image buffer.; receivedDataSize - Actual size of data.; format - Pixel format.; bayerFormat - Format of the Bayer tiled raw image.

Image

public Image(@Cast(value="unsigned int")
             int rows,
             @Cast(value="unsigned int")
             int cols,
             @Cast(value="unsigned int")
             int stride,
             @Cast(value="unsigned char*")
             ByteBuffer pData,
             @Cast(value="unsigned int")
             int dataSize,
             @Cast(value="unsigned int")
             int receivedDataSize,
             @Cast(value="FlyCapture2::PixelFormat")
             int format,
             @Cast(value="FlyCapture2::BayerTileFormat")
             int bayerFormat)

Image

public Image(@Cast(value="unsigned int")
             int rows,
             @Cast(value="unsigned int")
             int cols,
             @Cast(value="unsigned int")
             int stride,
             @Cast(value="unsigned char*")
             byte[] pData,
             @Cast(value="unsigned int")
             int dataSize,
             @Cast(value="unsigned int")
             int receivedDataSize,
             @Cast(value="FlyCapture2::PixelFormat")
             int format,
             @Cast(value="FlyCapture2::BayerTileFormat")
             int bayerFormat)

Image
```
public Image(@Cast(value="unsigned char*")
             BytePointer pData,
             @Cast(value="unsigned int")
             int dataSize)
```
Construct an Image object with the specified arguments. Ownership of the image buffer is not transferred to the Image object. It is the user's responsibility to delete the buffer when it is no longer in use.

Parameters:

pData - Pointer to the image buffer.

dataSize - Size of the image buffer.

Image

public Image(@Cast(value="unsigned char*")
             ByteBuffer pData,
             @Cast(value="unsigned int")
             int dataSize)

Image

public Image(@Cast(value="unsigned char*")
             byte[] pData,
             @Cast(value="unsigned int")
             int dataSize)

Image

public Image(@Cast(value="unsigned int")
             int rows,
             @Cast(value="unsigned int")
             int cols,
             @Cast(value="FlyCapture2::PixelFormat")
             int format,
             @Cast(value="FlyCapture2::BayerTileFormat")
             int bayerFormat)

Construct an Image object with the specified arguments.

Parameters:: rows - Rows in the image.; cols - Columns in the image.; format - Pixel format.; bayerFormat - Format of the Bayer tiled raw image.

Image

public Image(@Cast(value="unsigned int")
             int rows,
             @Cast(value="unsigned int")
             int cols,
             @Cast(value="FlyCapture2::PixelFormat")
             int format)

Image

public Image(@Const @ByRef
             FlyCapture2.Image image)

Copy constructor. Both images will point to the same image buffer internally.

Method Detail

position

public FlyCapture2.Image position(long position)

Overrides:: position in class Pointer

SetDefaultColorProcessing
```
@ByVal
public static FlyCapture2.Error SetDefaultColorProcessing(@Cast(value="FlyCapture2::ColorProcessingAlgorithm")
                                                                 int defaultMethod)
```
Set the default color processing algorithm. This method will be used for any image with the DEFAULT algorithm set. The method used is determined at the time of the Convert() call, therefore the most recent execution of this function will take precedence. The default setting is shared within the current process.

Parameters:

defaultMethod - The color processing algorithm to set.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetDefaultColorProcessing()

GetDefaultColorProcessing
```
@Cast(value="FlyCapture2::ColorProcessingAlgorithm")
public static int GetDefaultColorProcessing()
```
Get the default color processing algorithm.

Returns:

The default color processing algorithm.

See Also:

SetDefaultColorProcessing()

SetDefaultOutputFormat
```
@ByVal
public static FlyCapture2.Error SetDefaultOutputFormat(@Cast(value="FlyCapture2::PixelFormat")
                                                              int format)
```
Set the default output pixel format. This format will be used for any call to Convert() that does not specify an output format. The format used will be determined at the time of the Convert() call, therefore the most recent execution of this function will take precedence. The default is shared within the current process.

Parameters:

format - The output pixel format to set.

Returns:

The default color processing algorithm.

See Also:

GetDefaultOutputFormat()

GetDefaultOutputFormat
```
@Cast(value="FlyCapture2::PixelFormat")
public static int GetDefaultOutputFormat()
```
Get the default output pixel format.

Returns:

The default pixel format.

See Also:

SetDefaultOutputFormat()

DetermineBitsPerPixel

@Cast(value="unsigned int")
public static int DetermineBitsPerPixel(@Cast(value="FlyCapture2::PixelFormat")
                                                                    int format)

Calculate the bits per pixel for the specified pixel format.

Parameters:: format - The pixel format.
Returns:: The bits per pixel.

put

@ByRef
 @Name(value="operator =")
public FlyCapture2.Image put(@Const @ByRef
                                                               FlyCapture2.Image image)

Assignment operator. Both images will point to the same image buffer internally. If the Image already has a buffer attached to it, it will will be released.

Parameters:: image - The image to copy from.

get

@Cast(value="unsigned char*")
 @Name(value="operator []")
public BytePointer get(@Cast(value="unsigned int")
                                                                                 int index)

Indexing operator.

Parameters:: index - The index of the byte to return.
Returns:: The address of the specified byte from the image data.

apply

@Cast(value="unsigned char*")
 @Name(value="operator ()")
public BytePointer apply(@Cast(value="unsigned int")
                                                                                   int row,
                                                                                   @Cast(value="unsigned int")
                                                                                   int col)

Indexing operator.

Parameters:: row - The row of the pixel to return.; col - The column of the pixel to return.
Returns:: The address of the specified byte from the image data.

DeepCopy
```
@ByVal
public FlyCapture2.Error DeepCopy(@Const
                                         FlyCapture2.Image pImage)
```
Perform a deep copy of the Image. After this operation, the image contents and member variables will be the same. The Images will not share a buffer. The Image's current buffer will not be released.

Parameters:

pImage - The Image to copy the data from.

Returns:

An Error indicating the success or failure of the function.

SetDimensions

@ByVal
public FlyCapture2.Error SetDimensions(@Cast(value="unsigned int")
                                              int rows,
                                              @Cast(value="unsigned int")
                                              int cols,
                                              @Cast(value="unsigned int")
                                              int stride,
                                              @Cast(value="FlyCapture2::PixelFormat")
                                              int pixelFormat,
                                              @Cast(value="FlyCapture2::BayerTileFormat")
                                              int bayerFormat)

Sets the dimensions of the image object.

Parameters:: rows - Number of rows to set.; cols - Number of cols to set.; stride - Stride to set.; pixelFormat - Pixel format to set.; bayerFormat - Bayer tile format to set.
Returns:: An Error indicating the success or failure of the function.
See Also:: GetDimensions()

SetData

@ByVal
public FlyCapture2.Error SetData(@Cast(value="const unsigned char*")
                                        BytePointer pData,
                                        @Cast(value="unsigned int")
                                        int dataSize)

Set the data of the Image object. Ownership of the image buffer is not transferred to the Image object. It is the user's responsibility to delete the buffer when it is no longer in use.

Parameters:: pData - Pointer to the image buffer.; dataSize - Size of the image buffer.

SetData

@ByVal
public FlyCapture2.Error SetData(@Cast(value="const unsigned char*")
                                        ByteBuffer pData,
                                        @Cast(value="unsigned int")
                                        int dataSize)

SetData

@ByVal
public FlyCapture2.Error SetData(@Cast(value="const unsigned char*")
                                        byte[] pData,
                                        @Cast(value="unsigned int")
                                        int dataSize)

SetBlockId

@ByVal
public FlyCapture2.Error SetBlockId(@Cast(value="const unsigned int")
                                           int blockId)

Set the block id of the Image object.

Parameters:: blockId - The blockId to assign to the image.

GetBlockId
```
@Cast(value="unsigned int")
public int GetBlockId()
```
get the block id of the Image object.

Returns:

The blockId assigned to the image.

GetPixelFormat
```
@Cast(value="FlyCapture2::PixelFormat")
public int GetPixelFormat()
```
Get the current pixel format.

Returns:

The current pixel format.

GetColorProcessing
```
@Cast(value="FlyCapture2::ColorProcessingAlgorithm")
public int GetColorProcessing()
```
Get the current color processing algorithm.

Returns:

The current color processing algorithm.

See Also:

SetColorProcessing()

SetColorProcessing
```
@ByVal
public FlyCapture2.Error SetColorProcessing(@Cast(value="FlyCapture2::ColorProcessingAlgorithm")
                                                   int colorProc)
```
Set the color processing algorithm. This should be set on the input Image object.

Parameters:

colorProc - The color processing algorithm to use.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetColorProcessing()

GetCols
```
@Cast(value="unsigned int")
public int GetCols()
```
Get the number of columns in the image.

Returns:

The number of columns.

GetRows
```
@Cast(value="unsigned int")
public int GetRows()
```
Get the number of rows in the image.

Returns:

The number of rows.

GetStride
```
@Cast(value="unsigned int")
public int GetStride()
```
Get the stride in the image.

Returns:

The stride (The number of bytes between rows of the image).

GetBitsPerPixel
```
@Cast(value="unsigned int")
public int GetBitsPerPixel()
```
Get the bits per pixel of the image.

Returns:

The bits per pixel.

GetBayerTileFormat
```
@Cast(value="FlyCapture2::BayerTileFormat")
public int GetBayerTileFormat()
```
Get the Bayer tile format of the image.

Returns:

The Bayer tile format.

GetDataSize
```
@Cast(value="unsigned int")
public int GetDataSize()
```
Get the size of the buffer associated with the image, in bytes.

Returns:

The size of the buffer, in bytes.

GetReceivedDataSize
```
@Cast(value="unsigned int")
public int GetReceivedDataSize()
```
Get the size of the compressed data, in bytes. A compressed image will have a maximum size equal to GetDataSize(), but may actually contain less data, depending on the compression level. For uncompressed images, a value smaller than the data size may indicate lost data.

Returns:

The size of the compressed data, in bytes. 0 when camera not sending compressed data.

GetDimensions

public void GetDimensions(@Cast(value="unsigned int*")
                          IntPointer pRows,
                          @Cast(value="unsigned int*")
                          IntPointer pCols,
                          @Cast(value="unsigned int*")
                          IntPointer pStride,
                          @Cast(value="FlyCapture2::PixelFormat*")
                          IntPointer pPixelFormat,
                          @Cast(value="FlyCapture2::BayerTileFormat*")
                          IntPointer pBayerFormat)

Get the image dimensions associated with the image.

Parameters:: pRows - Number of rows.; pCols - Number of columns.; pStride - The stride.; pPixelFormat - Pixel format.; pBayerFormat - Bayer tile format.

GetDimensions

public void GetDimensions(@Cast(value="unsigned int*")
                          IntPointer pRows)

GetDimensions

public void GetDimensions(@Cast(value="unsigned int*")
                          IntBuffer pRows,
                          @Cast(value="unsigned int*")
                          IntBuffer pCols,
                          @Cast(value="unsigned int*")
                          IntBuffer pStride,
                          @Cast(value="FlyCapture2::PixelFormat*")
                          IntBuffer pPixelFormat,
                          @Cast(value="FlyCapture2::BayerTileFormat*")
                          IntBuffer pBayerFormat)

GetDimensions

public void GetDimensions(@Cast(value="unsigned int*")
                          IntBuffer pRows)

GetDimensions

public void GetDimensions(@Cast(value="unsigned int*")
                          int[] pRows,
                          @Cast(value="unsigned int*")
                          int[] pCols,
                          @Cast(value="unsigned int*")
                          int[] pStride,
                          @Cast(value="FlyCapture2::PixelFormat*")
                          int[] pPixelFormat,
                          @Cast(value="FlyCapture2::BayerTileFormat*")
                          int[] pBayerFormat)

GetDimensions

public void GetDimensions(@Cast(value="unsigned int*")
                          int[] pRows)

GetData
```
@Cast(value="unsigned char*")
public BytePointer GetData()
```
Get a pointer to the data associated with the image. This function is considered unsafe. The pointer returned could be invalidated if the buffer is resized or released. The pointer may also be invalidated if the Image object is passed to Camera::RetrieveBuffer(). It is recommended that a Image::DeepCopy() be performed if a seperate copy of the Image data is required for further processing.

Returns:

A pointer to the image data.

GetMetadata
```
@ByVal
public FlyCapture2.ImageMetadata GetMetadata()
```
Get the metadata associated with the image. This includes embedded image information.

Returns:

Metadata associated with the image.

CalculateStatistics
```
@ByVal
public FlyCapture2.Error CalculateStatistics(FlyCapture2.ImageStatistics pStatistics)
```
Calculate statistics associated with the image. In order to collect statistics for a particular channel, the enabled flag for the channel must be set to true. Statistics can only be collected for images in Mono8, Mono16, RGB, RGBU, BGR and BGRU.

Parameters:

pStatistics - The ImageStatistics object to hold the statistics.

Returns:

An Error indicating the success or failure of the function.

GetTimeStamp
```
@ByVal
public FlyCapture2.TimeStamp GetTimeStamp()
```
Get the timestamp data associated with the image.

Returns:

Timestamp data associated with the image.

Save

@ByVal
public FlyCapture2.Error Save(@Cast(value="const char*")
                                     BytePointer pFilename,
                                     @Cast(value="FlyCapture2::ImageFileFormat")
                                     int format)

Save the image to the specified file name with the file format specified.

Parameters:: pFilename - Filename to save image with.; format - File format to save in.
Returns:: An Error indicating the success or failure of the function.

Save

@ByVal
public FlyCapture2.Error Save(@Cast(value="const char*")
                                     BytePointer pFilename)

Save

@ByVal
public FlyCapture2.Error Save(String pFilename,
                                     @Cast(value="FlyCapture2::ImageFileFormat")
                                     int format)