ImageSource Class

An abstract class that is used to define a flexible mechanism for managing large quantities of images without having to keep them all in memory at once.

Inheritance Hierarchy

SystemObject
Atalasoft.ImagingImageSource
Atalasoft.ImagingRandomAccessImageSource

Namespace: Atalasoft.Imaging
Assembly: Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)

Syntax

Copy

public abstract class ImageSource : IDisposable

Public MustInherit Class ImageSource
	Implements IDisposable

The ImageSource type exposes the following members.

Constructors

	Name	Description
	ImageSource	Initializes a new instance of the ImageSource class.

Top

Properties

	Name	Description
	ActiveImages	Gets the active images.
	CulledImages	Gets the culled images.
	Current	Returns the index of the current image.
	ImmediateUnload	Determines if an image should be unloaded from memory immediately.
	MemoryInUse	Returns an estimate of the number of bytes of memory currently in use by images in this ImageSource.
	MemoryLimit	This sets the limit for memory usage for this ImageSource. If memory usage goes beyond this, images will be dropped from memory until memory usage is below the limit.
	TotalImages	Returns the total number of available images in this ImageSource.
	TotalImagesKnown	Gets a value indicating whether or not the total number of images in this image source can be known.

Top

Methods

	Name	Description
	Acquire(Int32)	Obsolete. This method has been deprecated. Use ReAcquire(AtalaImage) instead.
	Acquire(AtalaImage)	Obsolete. This method has been deprecated. Use ReAcquire(AtalaImage) instead.
	AcquireNext	Acquire the next available image from the ImageSource.
	AllImagesAreReleased	Determines if all the images have been released.
	ContainsImage	Determines whether this ImageSource contains the specified image.
	CullNode	Culls the node from the ImageSource
	CullReleasedImages	Culls all released images.
	Dispose	Free up resources used by this ImageSource
	Dispose(Boolean)	Releases unmanaged and - optionally - managed resources.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Finalizes an instance of the ImageSource class. (Overrides ObjectFinalize.)
	Find	Finds the specified image.
	Flush	Flush all released images out of memory.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasMoreImages	Determines if there are more images to load.
	LowLevelAcquireNextImage	Lows level implementation to acquire next image.
	LowLevelDispose	Lows level implementation to dispose the ImageSource.
	LowLevelFlushOnReset	Lows level implementation to determine if there should be a flush on reset.
	LowLevelHasMoreImages	Lows level implementation to determine if the ImageSource has more images.
	LowLevelReplaceImage	Lows level implementation to replace an image.
	LowLevelReset	Lows level implementation of reset.
	LowLevelSkipNextImage	Lows level implementation to skip next image.
	LowLevelTotalImages	Lows level implementation that returns the total number of images.
	LowLevelTotalImagesKnown	Lows level implemtation to return if the total number of images are known.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NotifyChangedImage(AtalaImage)	This method is used to inform an ImageSource that one of its current acquired images has changed.
	NotifyChangedImage(AtalaImage, AtalaImage)	This method is used to inform an ImageSource that one of its current acquired images has changed.
	OnChangedImage	Raises the [E:ChangedImage] event.
	OnReleasing	Called when Release(AtalaImage) was performed on an ImageSourceNode.
	ReAcquire(Int32)	Acquire a previous image by index.
	ReAcquire(AtalaImage)	Acquire an AtalaImage that has been previously acquired.
	Release	Release a previously acquired image.
	ReleaseChangedImage(AtalaImage)	Release an image that has changed, notifying other clients that the image has changed.
	ReleaseChangedImage(AtalaImage, AtalaImage)	Release an image that has changed, notifying other clients that the image has changed.
	Reset	Resets the ImageSource to start over again.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	ChangedImage	This event is fired whenever an image has been replaced.
	Releasing	Raised when the Release(AtalaImage) method is called on an ImageSourceNode.

Top

Remarks

ImageSource objects are configurable for memory usage or for aggressive unloading of images and can be built with a cache to allow transient data sources such as live video to be treated as if they were persistent.

Reference

Atalasoft.Imaging Namespace