ItalaApiNET  1.3.3
Public Member Functions | Properties | List of all members
Itala.IImage Interface Reference

Image interface. It represents the image buffer grabbed from the device. The instance must be disposed when it's no longer required via IImage.Dispose. More...

Inherits IDisposable, and ICloneable.

Inherited by Itala.ItalaImage.

Public Member Functions

GenApi.INode GetChunkNode (string name)
 Get the specified node from the internal chunk data nodemap. More...
 
GetChunkNode< T > (string name)
 Get the specified node from the internal chunk data nodemap. Use generic with the correspoding value interface of the node you are trying to retrive. More...
 
IImage Coverter (PfncFormat dest_format)
 Creates a new image converted from the current one with its own allocated memory and the specified pixel format.It needs to be disposed when it's no longer required via Dispose(). More...
 

Properties

Int64 Width [get]
 Width of the image in pixels. More...
 
Int64 Height [get]
 Height of the image in pixels. More...
 
Int64 OffsetX [get]
 Offsex along the X axis of the image, in pixels. More...
 
Int64 OffsetY [get]
 Offsex along the Y axis of the image, in pixels. More...
 
Int64 PaddingX [get]
 Padding along the X axis of the image, in pixels. More...
 
Int64 PaddingY [get]
 Padding along the Y axis of the image, in pixels. More...
 
PfncFormat PixelFormat [get]
 Pixel format of the image. The PFNC standard from GenICam is used to identify the format. More...
 
UInt64 FrameID [get]
 ID of the image. More...
 
UInt64 Timestamp [get]
 Timestamp of the image. More...
 
Int64 PayloadSize [get]
 Payload size of the image, in bytes. More...
 
bool IsIncomplete [get]
 Reports wether the grabbed image is incomplete, i.e. some bytes are missing due to transfer issues. More...
 
Int64 BytesFilled [get]
 The amount of bytes actually stored in the buffer. More...
 
IntPtr Data [get]
 Get the pointer to the memory buffer containing the grabbed data. The content is retrieved directly from the device and, if chunk data functionality is enabled, the chunks are also included in the buffer. More...
 
bool HasChunckData [get]
 Report wether the buffer contains chunk data or not. More...
 

Detailed Description

Image interface. It represents the image buffer grabbed from the device. The instance must be disposed when it's no longer required via IImage.Dispose.

Member Function Documentation

◆ GetChunkNode()

GenApi.INode Itala.IImage.GetChunkNode ( string  name)

Get the specified node from the internal chunk data nodemap.

Parameters
nameName of the node in the chunk data.
Returns
Reference to the node INode.

◆ GetChunkNode< T >()

T Itala.IImage.GetChunkNode< T > ( string  name)

Get the specified node from the internal chunk data nodemap. Use generic with the correspoding value interface of the node you are trying to retrive.

Use case:

IInteger chunkFrameId = img.GetChunkNode<IInteger>("ChunkFrameID");
Parameters
nameName of the node in the chunk data.
Returns
Reference to the node T.
Type Constraints
T :GenApi.IValue 

◆ Coverter()

IImage Itala.IImage.Coverter ( PfncFormat  dest_format)

Creates a new image converted from the current one with its own allocated memory and the specified pixel format.It needs to be disposed when it's no longer required via Dispose().

Parameters
dest_formatFormat you want to objtain as result of conversion
Returns
Reference to the converted image instance.

Property Documentation

◆ Width

Int64 Itala.IImage.Width
get

Width of the image in pixels.

◆ Height

Int64 Itala.IImage.Height
get

Height of the image in pixels.

◆ OffsetX

Int64 Itala.IImage.OffsetX
get

Offsex along the X axis of the image, in pixels.

◆ OffsetY

Int64 Itala.IImage.OffsetY
get

Offsex along the Y axis of the image, in pixels.

◆ PaddingX

Int64 Itala.IImage.PaddingX
get

Padding along the X axis of the image, in pixels.

◆ PaddingY

Int64 Itala.IImage.PaddingY
get

Padding along the Y axis of the image, in pixels.

◆ PixelFormat

PfncFormat Itala.IImage.PixelFormat
get

Pixel format of the image. The PFNC standard from GenICam is used to identify the format.

◆ FrameID

UInt64 Itala.IImage.FrameID
get

ID of the image.

◆ Timestamp

UInt64 Itala.IImage.Timestamp
get

Timestamp of the image.

◆ PayloadSize

Int64 Itala.IImage.PayloadSize
get

Payload size of the image, in bytes.

◆ IsIncomplete

bool Itala.IImage.IsIncomplete
get

Reports wether the grabbed image is incomplete, i.e. some bytes are missing due to transfer issues.

◆ BytesFilled

Int64 Itala.IImage.BytesFilled
get

The amount of bytes actually stored in the buffer.

◆ Data

IntPtr Itala.IImage.Data
get

Get the pointer to the memory buffer containing the grabbed data. The content is retrieved directly from the device and, if chunk data functionality is enabled, the chunks are also included in the buffer.

◆ HasChunckData

bool Itala.IImage.HasChunckData
get

Report wether the buffer contains chunk data or not.


The documentation for this interface was generated from the following file: