IMcExperimentDocument Interface

An interface for a document containing an experiment as implemented in MediaCy.Viewers.Experiment.

Namespace: MediaCy.IQL.Application
Assembly: MediaCy.IQL.Application (in MediaCy.IQL.Application.dll) Version: 3.1.0.0

Syntax

Public Interface IMcExperimentDocument

The IMcExperimentDocument type exposes the following members.

Properties

	Name	Description
	Description	Description of the experiment
	Name	Short name of the experiment
	Position	The position of the experiement in calibrated units
	Size	Overall size of the experiment in pixels
	Units	Unit is usually mm
	UnitsPerPixel	Number of units per pixel in both X and Y dimension

Methods

	Name	Description
	AddDocument	Add a new document (image, VLI or set) to the experiment, at the specified location expressed in pixels. The size (in pixels) is an indication of how much space is occupied on the experiment map.
	AddDocumentPhysical	Add a new document (image, VLI or set) to the experiment, at the specified location expressed in physical coordinates. The document must be calibrated, and the physical coordinates are expressed in the units of the calibration. The coordinates are relative to an unknown physical fiduciary. The size (in calibrated units) is an indication of how much space the sample occupies in the experiment. The document will be fitted into the existing experiment extent if possible, and the experiment space (and map) will be expanded as needed.
	AddImageMap	Add a new image map for the experiment. All image maps are combined when creating the experiment view.
	AddImageMapPhysical	Add a new image map for the experiment. All image maps are combined when creating the experiment view.
	IsUniqueDocumentName	Check whether a given name would be unique in the document collection
	Read	Read an experiment from an MCE file
	Write	Writes the MCE experiment file, paths are all made relative to the file location

Remarks