Description

The Image class.

Object Model

































Remarks

This coclass is not creatable.

Members

Methods
AddFrames

Add empty (blank) frames to an image.

AttachPseudoColor

This method supports setting the image's pseudo-coloring.

BeginEndUpdateBlock

Begin or end a block of image changed notifications.

Clear

Clear a portion of the image to a constant value

Close

Remove the image from the collection of images if it is part of it.

CompareSignature

Compare given signature to current image signature

Convert

Creates a copy of the Aoi of this image with a different type.

ConvertEx

Creates a copy of the AOI of this image with a different type.

CopyToNewImage

Copy all or a portion of an image to a new image.

CreateRegionAccess

Create an McRegionAccess interface for read/write pixel access.

CreateRegionAccessEx

Create an McRegionAccess interface for pixel access, where access may be read-only, write-only or read-write.

Duplicate

Create a clone of the Aoi of this image.

GetArea

Get a block of pixel values from the image

GetCurrentPseudoColor

This method supports getting the image's pseudo-coloring.

GetLine

Get a line of pixels values.

GetPixel

Get a pixel value.

ImportProperties

This method imports selected properties from a source image.

MoveFrames

Move frames from one image to another.

PrepareToClose

Does any preparation necessary before closing the image.

PutArea

Change a block of pixel values of the image.

PutLine

Change the pixel values of a line of the image.

PutPixel

Set a pixel value.

Reload

Reload this image from the file it was originally loaded from.

RemoveFrames

Remove frames from an image

ReorderFrames

This method re-orders the frames of an image.

Save

Saves this image to the file it was originally loaded from.

SaveAs

Saves this image into a file.

SetInitialSignature

Set the initial 128-bit image signature

SetNextAccessPriority

Sets the next access priority for specified frames

SignalImageChanged

Notify the image that a frame has changed via means external to the McImage methods.


Properties
ActiveFrameIndexRead-write property

Get the 0-based index value of the active frame

ActiveFrameRangeRead-write property

The range(s) of active frames.

ActiveFrameUpdateCountRead-only property

A count of updates to the active frame's pixels.

AllFramesUpdateCountRead-only property

A count of updates to all frame's pixels.

AnnotationOverlayRead-only propertyOverlay layer for annotations
AoiRead-only property

A read-only property giving the current area-of-interest (AOI)

ArtistRead-write property

Get the “Artist” property of the image.

BackgroundRead-only propertyBackground operations
BitsPerChannelRead-only property

Get the number of bits per channels of the image

BytesPerChannelRead-only property

Get the number of bytes per channel of an image.

CaptureRead-only property

A McCapture operator used to capture into an existing IMcImage.

CastingSourceRangeRead-write property

The source luminance range for pixel value casts during CreateRegionAccess

CollectionRead-write propertyproperty Collection
ColorMapRead-write property

A property representing the image's color map.

ColorMapLengthRead-only property

A read-only property returning the length of the image's color map.

ColorModelRead-only propertyColor Model operator
CopyrightRead-only property

A copyright text string for the image.

CurrentSignatureRead-only property

Get the current 128-bit image signature, as a string

DateRead-write property

A read/write property reflecting the date and time of creation of the image or of a frame of the image.

DescriptionRead-write property

Get the “Description” property of the image.

DisplayRead-only propertyDisplay Operator
DisplayNameRead-write property

A read/write property reflecting a display name for the image.

DotsPerInchXRead-write property

Get the number of dots per inch along the X axis of the image (horizontal axis).

DotsPerInchYRead-write property

A read/write property reflecting the number of dots per inch along the Y axis of the image (vertical axis).

EdgesRead-only propertyEdges Operator
EnhanceRead-only propertyEnhance Operator
FFTRead-only propertyFFT Operator
FileRead-only property

A McStream instance for writing the image to file.

FilterRead-only propertyFilter Operator
FrameRead-only property

Returns one of the frames being managed by this image

FrameCountRead-only property

Get the number of frames in the image

FramesRead-only property

A new image frames collection (McFrames).

FramesPerSecondRead-write property

Sequence playback frame rate.

GeometryRead-only propertyGeometric operations
HeightRead-only propertyproperty Height
HistogramRead-only propertyHistogram operator
ImageToolsOverlayRead-only propertyOverlay layer for image tools
InitialSignatureRead-only property

Get the initial 128-bit image signature, as a string

IntensityCalibrationRead-write property

A default IntensityCalibration

InterpretationRead-only property

Get the type multi-channel image.

LastActiveToolRead-only propertyLastActiveTool property
LineFeaturesRead-only propertyLineFeatures Operator
LookupTableRead-only property

Get the McLookupTable interface corresponding to the first LUT.

LookupTablesRead-only property

Get an LUT collection interface (McLookupTables).

ModifiedRead-write property

Indicates whether image frame data have been changed.

MorphoRead-only propertyMorpho Operator
NameRead-write property

A read/write property reflecting a parseable name for the image.

NewOperatorRead-only propertyNewOperator Operator
NumberOfChannelsRead-only property

Get the number of channels in the image

OpRead-only propertyArithmetic and logical operations
PixelDataTypeRead-only propertyproperty PixelDataType
PointFeaturesRead-only propertyPointFeatures Operator
PropertiesRead-only property

Get pointer to image properties interface (McProperties).

PropertyRead-only property

Get a property from the properties collection attached to the image. Same as Properties.get_Item.

PropertyChangeCountRead-only property

A count of changes to image properties.

QuickTypeRead-only property

Get an enumerated image type.

RangeMaxRead-write property

A double floating point variable representing the maximum pixel value allowed by the image type.

RangeMinRead-write property

A double floating point variable representing the minimum pixel value allowed by the image type.

RegionFeaturesRead-only propertyRegionFeatures Operator
SpatialCalibrationRead-write property

A default SpatialCalibration

TitleRead-write property

Get the “Title” property of the image.

TypeRead-only property

Describes the image properties via the McImageType object.

UndoStackRead-only propertyproperty UndoStack
UseActiveFrameRangeRead-write property

Determines whether operations will apply to the active frame or the active range of frames.

ViewsRead-only propertyImage views collection
VisibleRead-write property

A read/write property reflecting whether the image should be visible in the application.

WarpRead-only propertyWarping operator
WidthRead-only property

Get the width of the image, in pixels.


Events
Activate

Event fired when McEngine.ActiveImage changes or when the last image is closed.

AfterImportProperties

Fired by McImage.ImportProperties after doing the property import

AfterSave

Event fired after the save process is complete.

AoiChanged

Event fired when an McImage.Aoi property is assigned a new value or when the Aoi features change.

BeforeClose

Event fired before an image is closed by McImages.Remove

BeforeImportProperties

Fired by McImage.ImportProperties before doing the property import

BeforeNew

Event fired before a new image is created by McImages.Add.

BeforeOpen

Event fired before an image is opened by McImages.Open

BeforeSave

Event fired before an image is saved by McImage.Save or McImage.SaveAs

Close

Event fired after the an image is removed from the collection.

Deactivate

Event fired when an image that was previously the McEngine.ActiveImage is no longer the ActiveImage.

FrameAdded

Event fired when one or more frames are appended, inserted or reordered after the initial creation of an image.

FrameOpen

Event fired by the McStream object after each frame of an image has been opened but before it is read

FrameRemoved

Event fired when one or more frames are removed after the initial creation of an image.

FrameSave

Event fired by the McStream object after each frame of an image has been opened but before it is saved

ImageChanged

Event fired after the pixel data of one or more frames has been changed.

LutChanged

Event fired when an McImage.LookupTables property LUT is realise.

MultipleFramesChanged

Event fired by McImage.BeginEndUpdateBlock when exiting a block if multiple frame's pixel data was changed.

New

Event fired after an image has been created by McImages.Add

Open

Event fired after an image has been opened by McImages.Open or by McImage.Reload

PropertyChanged

Event fired when an McImage property is assigned a new value.

Save

Event fired during the save process after the McStream has been opened but before the image data is written to file.