Types specific for the Phenom APIs. More...

Classes
struct	Error
	Error structure, thrown as exception on error by Phenom API calls. More...
struct	Position
	2D (Stage) position, in meters More...
struct	StageModeAndPosition
struct	StageStroke
	Valid range for stage positions. More...
struct	Range
struct	Size
struct	CamParams
	Parameters from a NavCam acquisition. More...
struct	ScanParams
	Parameters for the SEM scan pattern definition. More...
struct	SEMViewingMode
	Viewing mode parameters for the SEM. More...
struct	Image
	Image descriptor struct. More...
struct	AcquisitionState
	Metadata describing microscope state at the time of acquisition. More...
struct	Acquisition
	Acquisition: combination of image and metadata. More...
Enumerations
enum	RetVal { OM_OK = om__RetVal__OM_OK, OM_FAIL = om__RetVal__OM_FAIL, OM_CONTEXT = om__RetVal__OM_CONTEXT, OM_COMM_ERROR = om__RetVal__OM_COMM_ERROR, OM_CLIPPED = om__RetVal__OM_CLIPPED, OM_UNCAL = om__RetVal__OM_UNCAL, ACCESSDENIED = -13, EXCLUSIVE = -16, INVALID_ADDRESS = -22, UNREACHABLE = -1000, NORESPONSE = -19, OTHER = -1 }
	Possible return values for each low-level API call on the WebService. More...
enum	InstrumentMode { INSTRUMENT_MODE_OFF = om__instrumentMode__INSTRUMENT_MODE_OFF, INSTRUMENT_MODE_OPERATIONAL = om__instrumentMode__INSTRUMENT_MODE_OPERATIONAL, INSTRUMENT_MODE_STANDBY = om__instrumentMode__INSTRUMENT_MODE_STANDBY, INSTRUMENT_MODE_HIBERNATE = om__instrumentMode__INSTRUMENT_MODE_HIBERNATE, INSTRUMENT_MODE_INITIALIZING = om__instrumentMode__INSTRUMENT_MODE_INITIALIZING, INSTRUMENT_MODE_CLOSINGDOWN = om__instrumentMode__INSTRUMENT_MODE_CLOSINGDOWN, INSTRUMENT_MODE_ERROR = om__instrumentMode__INSTRUMENT_MODE_ERROR }
enum	OperationalMode { OPERATIONAL_MODE_UNAVAILABLE = om__operationalMode__OPERATIONAL_MODE_UNAVAILABLE, OPERATIONAL_MODE_LOADPOS = om__operationalMode__OPERATIONAL_MODE_LOADPOS, OPERATIONAL_MODE_UNLOADING = om__operationalMode__OPERATIONAL_MODE_UNLOADING, OPERATIONAL_MODE_SELECTINGNAVCAM = om__operationalMode__OPERATIONAL_MODE_SELECTINGNAVCAM, OPERATIONAL_MODE_SELECTINGSEM = om__operationalMode__OPERATIONAL_MODE_SELECTINGSEM, OPERATIONAL_MODE_LIVENAVCAM = om__operationalMode__OPERATIONAL_MODE_LIVENAVCAM, OPERATIONAL_MODE_LIVESEM = om__operationalMode__OPERATIONAL_MODE_LIVESEM, OPERATIONAL_MODE_ACQUIRENAVCAMIMAGE = om__operationalMode__OPERATIONAL_MODE_ACQUIRENAVCAMIMAGE, OPERATIONAL_MODE_ACQUIRESEMIMAGE = om__operationalMode__OPERATIONAL_MODE_ACQUIRESEMIMAGE }
enum	ImagingDevice { NAVCAMIMDEV = om__imagingDevice__NAVCAMIMDEV, SEMIMDEV = om__imagingDevice__SEMIMDEV }
enum	StageNavigationMode { STAGE_NAVIGATION_MODE_NOT_AVAILABLE = om__stageNavigMode__STAGE_NAVIGATION_MODE_NOT_AVAILABLE, STAGE_NAVIGATION_MODE_REST = om__stageNavigMode__STAGE_NAVIGATION_MODE_REST, STAGE_NAVIGATION_MODE_PTP = om__stageNavigMode__STAGE_NAVIGATION_MODE_PTP, STAGE_NAVIGATION_MODE_JOG = om__stageNavigMode__STAGE_NAVIGATION_MODE_JOG, STAGE_NAVIGATION_MODE_NOT_HOMED = om__stageNavigMode__STAGE_NAVIGATION_MODE_NOT_HOMED }
	Current status of the stage. More...
enum	NavigationAlgorithm { NAVIGATION_AUTO = om__navigationAlgorithm__NAVIGATION_AUTO, NAVIGATION_BACKLASH_ONLY = om__navigationAlgorithm__NAVIGATION_BACKLASH_ONLY, NAVIGATION_RAW = om__navigationAlgorithm__NAVIGATION_RAW }
	Algorithm for stage moves during navigation. More...
enum	AutoFocusAlgorithm { AUTOFOCUS_AUTO = om__autoFocusAlgorithm__AUTOFOCUS_AUTO, AUTOFOCUS_COARSE_FINE = om__autoFocusAlgorithm__AUTOFOCUS_COARSE_FINE, AUTOFOCUS_FINE_ONLY = om__autoFocusAlgorithm__AUTOFOCUS_FINE_ONLY }
enum	DetectorSegment { OM_SEM_DETECTOR_SEGMENT_OFF = om__detectorSegment__OM_SEM_DETECTOR_SEGMENT_OFF, OM_SEM_DETECTOR_SEGMENT_ON = om__detectorSegment__OM_SEM_DETECTOR_SEGMENT_ON, OM_SEM_DETECTOR_SEGMENT_INVERT = om__detectorSegment__OM_SEM_DETECTOR_SEGMENT_INVERT }
enum	DetectorMode { SEM_DETECTOR_MODE_ALL = om__detector__SEM_DETECTOR_MODE_ALL, SEM_DETECTOR_MODE_NORTHSOUTH = om__detector__SEM_DETECTOR_MODE_NORTHSOUTH, SEM_DETECTOR_MODE_EASTWEST = om__detector__SEM_DETECTOR_MODE_EASTWEST, SEM_DETECTOR_MODE_A = om__detector__SEM_DETECTOR_MODE_A, SEM_DETECTOR_MODE_B = om__detector__SEM_DETECTOR_MODE_B, SEM_DETECTOR_MODE_C = om__detector__SEM_DETECTOR_MODE_C, SEM_DETECTOR_MODE_D = om__detector__SEM_DETECTOR_MODE_D }
	Detector mode for the SEM. More...
enum	ScanMode { SEM_SCAN_MODE_BLANK = om__scanMode__SEM_SCAN_MODE_BLANK, SEM_SCAN_MODE_IMAGING = om__scanMode__SEM_SCAN_MODE_IMAGING, SEM_SCAN_MODE_SPOT = om__scanMode__SEM_SCAN_MODE_SPOT }
	Possible values for SEM scanning mode. More...
enum	Encoding { Unsigned8, Unsigned16, RGB }
	Possible values for image data types. More...
enum	AcquisitionType { ACQUISITION_NAVCAM = om__acquisitionType__OM_ACQ_TYPE_NAVCAM, ACQUISITION_SEM = om__acquisitionType__OM_ACQ_TYPE_SEM }
Functions
const char *	string (RetVal e)
	Convert a RetVal enum value to a human-readable string.
RetVal	OMRetVal (om__RetVal retVal)
const char *	string (InstrumentMode m)
	Convert an InstrumentMode enum value to a human-readable string.
const char *	string (OperationalMode m)
	Convert an OperationalMode enum value to a human-readable string.
const char *	string (ImagingDevice d)
	Convert an ImagingDevice enum value to a human-readable string.
const char *	string (StageNavigationMode m)
	Convert a StageNavigationMode enum value to a human-readable string.
const char *	string (NavigationAlgorithm a)
	Convert an NavigationAlgorithm enum value to a human-readable string.
const char *	string (AutoFocusAlgorithm a)
	Convert an AutoFocusAlgorithm enum value to a human-readable string.
const char *	string (DetectorSegment d)
	Convert a DetectorSegment enum value to a human-readable string.
const char *	shortstring (DetectorSegment d)
	Convert a DetectorSegment enum value to a human-readable character representation (0 = off, + = add, - = invert)
const char *	string (DetectorMode m)
	Convert a DetectorMode enum value to a human-readable string.
const char *	string (ScanMode m)
	Convert a ScanMode enum value to a human-readable string.
Variables
const Position	CenterPosition
	Constant denoting the center of the field-of-view.

Detailed Description

Types specific for the Phenom APIs.

Enumeration Type Documentation

enum PhenomTypes::AcquisitionType

Enumerator:

ACQUISITION_NAVCAM	NavCam acquisition.
ACQUISITION_SEM	SEM acquisition.

enum PhenomTypes::AutoFocusAlgorithm

See also:: Phenom::SEMAutoFocus

Enumerator:

AUTOFOCUS_AUTO	Perform coarse sweep if above a certain magnification, then a fine sweep.
AUTOFOCUS_COARSE_FINE	Always perform a coarse sweep followed by a fine sweep.
AUTOFOCUS_FINE_ONLY	Perform a quick fine sweep only.

enum PhenomTypes::DetectorMode

Detector mode for the SEM.

Enumerator:

SEM_DETECTOR_MODE_ALL	Use all detector segments.
SEM_DETECTOR_MODE_NORTHSOUTH	Subtract bottom two segments from top two.
SEM_DETECTOR_MODE_EASTWEST	Subtract left two segments from right two.
SEM_DETECTOR_MODE_A	Select only segment A.
SEM_DETECTOR_MODE_B	Select only segment B.
SEM_DETECTOR_MODE_C	Select only segment C.
SEM_DETECTOR_MODE_D	Select only segment D.

enum PhenomTypes::DetectorSegment

Enumerator:

OM_SEM_DETECTOR_SEGMENT_OFF	Don't use this detector segment.
OM_SEM_DETECTOR_SEGMENT_ON	Add signals from this detector segment.
OM_SEM_DETECTOR_SEGMENT_INVERT	Subtract signals from this detector segment.

enum PhenomTypes::Encoding

Possible values for image data types.

Enumerator:

Unsigned8	Unsigned, 8 bit samples (0 .. 255)
Unsigned16	Unsigned, 16 bit samples (0 .. 65535)
RGB	Color (NavCam) samples, 8 bits per channel.

enum PhenomTypes::ImagingDevice

See also:: Phenom::SelectImagingDevice

Enumerator:

NAVCAMIMDEV	The optical microscope ("NavCam")
SEMIMDEV	The scanning electron microscope ("SEM")

enum PhenomTypes::InstrumentMode

See also:: Phenom::GetInstrumentMode, Phenom::SetInstrumentMode

Enumerator:

INSTRUMENT_MODE_OFF	Phenom is in "off" state (but still running)
INSTRUMENT_MODE_OPERATIONAL	Phenom is operational.
INSTRUMENT_MODE_STANDBY	Phenom is standby (takes approx. 5 minutes to become operational)
INSTRUMENT_MODE_HIBERNATE	Phenom is in hibernation mode (takes approx. 6 minutes to become operational)
INSTRUMENT_MODE_INITIALIZING	Phenom is initializing.
INSTRUMENT_MODE_CLOSINGDOWN	Phenom is closing down (going to "off" state)
INSTRUMENT_MODE_ERROR	Phenom is in error condition.

enum PhenomTypes::NavigationAlgorithm

Algorithm for stage moves during navigation.

The Phenom stage is accurate to about 35 µm in point-to-point movements, but can achieve considerably better accuracy if so-called "backlash correction" is applied, in which the stage is programmed to approach the destination position always from the same direction. This mode is not available from the GUI, which always uses direct single stage movements or jogging.

Note:: Backlash correction only increases point-to-point accuracy when the previous stage movements also used the correction. Immediately after a single direct movement or a stage jogging movement, the accuracy of the next backlash-corrected stage movement will not be better.

Enumerator:

NAVIGATION_AUTO	Let the Phenom decide which algorithm to use.
NAVIGATION_BACKLASH_ONLY	Always perform backlash correction.
NAVIGATION_RAW	Use single stage moves only.

enum PhenomTypes::OperationalMode

See also:: Phenom::GetOperationalMode, Phenom::SetOperationalMode

Enumerator:

OPERATIONAL_MODE_UNAVAILABLE	Phenom is unavailable.
OPERATIONAL_MODE_LOADPOS	Sample is in loading position.
OPERATIONAL_MODE_UNLOADING	Sample is moving to unload position.
OPERATIONAL_MODE_SELECTINGNAVCAM	Sample is moving to NavCam.
OPERATIONAL_MODE_SELECTINGSEM	Sample is moving to SEM.
OPERATIONAL_MODE_LIVENAVCAM	Phenom is in live viewing mode under the NavCam.
OPERATIONAL_MODE_LIVESEM	Phenom is in live viewing mode under the SEM.
OPERATIONAL_MODE_ACQUIRENAVCAMIMAGE	Phenom is currently performing a NavCam acquisition.
OPERATIONAL_MODE_ACQUIRESEMIMAGE	Phenom is currently performing a SEM acquisition.

enum PhenomTypes::RetVal

Possible return values for each low-level API call on the WebService.

Enumerator:

OM_OK	No error.
OM_FAIL	Generic Failure.
OM_CONTEXT	Command currently rejected; Phenom busy.
OM_COMM_ERROR	Communication problem.
OM_CLIPPED	Value was clipped to available range.
OM_UNCAL	Phenom is in an uncalibrated state.
ACCESSDENIED	Access Denied (check HTTP authentication credentials)
EXCLUSIVE	Another client has claimed exclusive access.
INVALID_ADDRESS	Invalid address specified.
UNREACHABLE	Specified host was unreachable.
NORESPONSE	Specified host did not reply (perhaps not a Phenom?)

enum PhenomTypes::ScanMode

Possible values for SEM scanning mode.

Enumerator:

SEM_SCAN_MODE_BLANK	Blank the beam (to minimize sample damage)
SEM_SCAN_MODE_IMAGING	Normal imaging mode.
SEM_SCAN_MODE_SPOT	Single spot mode.

enum PhenomTypes::StageNavigationMode

Current status of the stage.

The stage will detect whether it is still correctly homed ("calibrated") and will perform a homing procedure when needed. This is the sound you hear the stage make when starting up the Phenom.

See also:: Phenom::GetStageModeAndPosition

Enumerator:

STAGE_NAVIGATION_MODE_NOT_AVAILABLE	Stage currently not available.
STAGE_NAVIGATION_MODE_REST	Stage is not moving.
STAGE_NAVIGATION_MODE_PTP	Stage is performing a point-to-point move.
STAGE_NAVIGATION_MODE_JOG	Stage is performing a jogging move.
STAGE_NAVIGATION_MODE_NOT_HOMED	Stage is not homed.

Classes

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation