Description

McRegionAccess Class

Object Model



Members

Methods
BeginEndUpdateBlock

used to prevent “Image Changed” notifications when the client is applying a series of updates.

ConvertImage

Create an image that converts the image data using the region access's area and casting as the source, and the supplied type as the destination.

CopyInEntireArea

Copy in the entire region access area from a source region access.

CreateImage

Create an image that duplicates the image data using the region access's area and casting.

GetArea

Read a block of pixel values from the image.

GetBounds

Retrieves the ROI coordinates for the current McRegionAccess object.

GetLine

Read an entire row of an image.

GetLinePointer

Return a memory pointer to a line of the image.

GetPixel

Read a single pixel from an image.

GetRegionMaskOffset

Returns the current RegionMask offset values

LineSegmentIntensities

Gets optionally calibrated intensities for a segment of one line

PixelIntensities

Gets interpolated and optionally calibrated intensities at zero or more given coordiantes

PutArea

Write a block of pixels to an image.

PutLine

Writes an entire row of pixels into an image.

PutPixel

Read a single pixel from an image.

RefreshIfCast

Refreshes the image if it is based on another image and that image has changed.

SetRegionMaskOffset

Sets the current RegionMask offset values

SetToConstant

Sets an area of the image to a single value.

SignalImageChanged

Used by clients, especially the Capture Module, to inform the system that the contents of the frame have changed via processes external to the McImage methods..

UnlockPixelPointer

Unlock pixel memory


Properties
AccessedImageRead-only property

The parent McImage.

BottomRead-only property

The image coordinate of the bottom side of the McRegionAccess ROI.

ChannelToProcessRead-write property

A property that allows access and modifications to only a specific channel of a multi-spectral image.

FastAccessRead-write property

A flag that specifies the client is willing and capable of direct access to the image pixel.

FrameIndexRead-only property

A property containing the zero-based frame number of the McImage being displayed.

HeightRead-only property

The height of the McRegionAccess ROI.

LeftRead-only property

The image coordinate of the left side of the McRegionAccess ROI.

LinesAboveRead-write property

The number of lines above the current line to be locked in memory.

LinesBelowRead-write property

The number of lines below the current line to be locked in memory.

RangeMaxRead-write property

The maximum pixel value expected within the image. This property does not scan the image to find a maximum value. This property is a scalar and represents the image luminance value.

RangeMinRead-write property

The minimum pixel value expected within the image. This property does not scan the image to find a minimum value. This property is a scalar and represents the image luminance value.

RegionMaskRead-write property

A McRegions instance to specify image masking.

RightRead-only property

The image coordinate of the right side of the McRegionAccess ROI.

ROIRead-only property

The region-of-interest exposed as a LONGRECT

TopRead-only property

The image coordinate of the top side of the McRegionAccess ROI.

TraversalModeRead-write property

Optimizes large frame access by specifying how the ROI will be traversed.

TypeRead-only property

Describes the region access properties via the McImageType object.

WidthRead-only property

The width of the McRegionAccess ROI.