IDS peak ICV v1.3.0
Loading...
Searching...
No Matches
ImageViewBase Class Referenceabstract
Inheritance diagram for ImageViewBase:

Properties

IntPtr Data [get]
 Returns the pointer to the beginning of the image buffer.
 
nuint SizeInBytes [get]
 Returns the total size number of bytes occupied by the image in the buffer.
 
nuint LineStartOffset [get]
 The byte offset to the first pixel of a line.
 
virtual PixelFormat PixelFormat [get]
 Returns the pixel format used by the image.
 
PixelFormatInfo PixelFormatInfo [get]
 Returns a helper object describing the pixel format in detail. The PixelFormatInfo class provides methods to inspect the layout, size, channel count, channel order, and other attributes of the format returned by IImageView.PixelFormat.
 
Size Size [get]
 Returns the overall size of the image (width × height).
 
virtual uint Width [get]
 Returns the width of the image in pixels.This is a convenience property and effectively forwards to Size.Width.
 
virtual uint Height [get]
 Returns the height of the image in pixels.This is a convenience property and effectively forwards to Size.Height.
 
virtual uint BitsPerPixel [get]
 Returns the number of bits that each pixel occupies.Note that this can also be queried with PixelFormatInfo but is provided for convenience here.
 
nuint BytesPerLine [get]
 Returns the number of bytes in a single image row.
 
Metadata Metadata [get]
 Metadata associated with the image.
 

Detailed Description

Abstract base class for IImageView implementations, providing common shared logic.

This base class simplifies the creation of image views by providing automatic implementations for derived properties such as Width, Height, and BitsPerPixel.

Since
IDSImaging.Peak.Common 1.3

Definition at line 18 of file ImageViewBase.cs.

Property Documentation

◆ BitsPerPixel

virtual uint BitsPerPixel
get

Returns the number of bits that each pixel occupies.Note that this can also be queried with PixelFormatInfo but is provided for convenience here.

Implements IImageView.

Definition at line 45 of file ImageViewBase.cs.

◆ BytesPerLine

nuint BytesPerLine
getabstract

Returns the number of bytes in a single image row.

Implements IImageView.

Definition at line 48 of file ImageViewBase.cs.

◆ Data

IntPtr Data
getabstract

Returns the pointer to the beginning of the image buffer.

Implements IImageView.

Definition at line 21 of file ImageViewBase.cs.

◆ Height

virtual uint Height
get

Returns the height of the image in pixels.This is a convenience property and effectively forwards to Size.Height.

Implements IImageView.

Definition at line 42 of file ImageViewBase.cs.

◆ LineStartOffset

nuint LineStartOffset
getabstract

The byte offset to the first pixel of a line.

Implements IImageView.

Definition at line 27 of file ImageViewBase.cs.

◆ Metadata

Metadata Metadata
getabstract

Metadata associated with the image.

Implements IImageView.

Definition at line 51 of file ImageViewBase.cs.

◆ PixelFormat

virtual PixelFormat PixelFormat
get

Returns the pixel format used by the image.

Implements IImageView.

Definition at line 30 of file ImageViewBase.cs.

◆ PixelFormatInfo

Returns a helper object describing the pixel format in detail. The PixelFormatInfo class provides methods to inspect the layout, size, channel count, channel order, and other attributes of the format returned by IImageView.PixelFormat.

Implements IImageView.

Definition at line 33 of file ImageViewBase.cs.

◆ Size

Size Size
getabstract

Returns the overall size of the image (width × height).

Implements IImageView.

Definition at line 36 of file ImageViewBase.cs.

◆ SizeInBytes

nuint SizeInBytes
getabstract

Returns the total size number of bytes occupied by the image in the buffer.

Implements IImageView.

Definition at line 24 of file ImageViewBase.cs.

◆ Width

virtual uint Width
get

Returns the width of the image in pixels.This is a convenience property and effectively forwards to Size.Width.

Implements IImageView.

Definition at line 39 of file ImageViewBase.cs.