Skip to content

com.inscoper.api

Classes

Name
class com.inscoper.api.AbstractSubDevice
AbstractSubDevice class implements custom sub-devices.
class com.inscoper.api.AbstractSystem
AbstractSystem class is the base class for all device types.
class com.inscoper.api.AdvancedConnectionConfig
AdvancedConnectionConfig class provides required information for most connections: Analog, TTL, PWM, RS232/UART.
class com.inscoper.api.Bridge
The Bridge class is the main class of The Inscoper API.
class com.inscoper.api.Camera
Camera class defines the interface for camera devices.
class com.inscoper.api.ChildStatusParam
ChildStatusParam class represents a dependent status parameter.
class com.inscoper.api.Config
Config class provides information for global configuration.
class com.inscoper.api.ConnectionConfig
Base class for connection configuration.
class com.inscoper.api.ConnectionConfigVector
class com.inscoper.api.ConnectionDescription
ConnectionDescription class provides connection information coming from the device controller.
class com.inscoper.api.ConnectionDescriptionVector
class com.inscoper.api.Constraint
Constraint class defines limits and valid values for a parameter.
class com.inscoper.api.CurrentStatusAction
CurrentStatusAction class allows executing code after status updates.
class com.inscoper.api.CustomDriverConfig
CustomDriverConfig class provides information for custom devices.
class com.inscoper.api.CustomDriverDescription
CustomDriverDescription class provides information for custom drivers.
class com.inscoper.api.DeviceConfig
DeviceConfig class provides information for device configuration.
class com.inscoper.api.DeviceConfigVector
class com.inscoper.api.DeviceDescription
DeviceDescription class provides device information coming from drivers.
class com.inscoper.api.DeviceDescriptionVector
class com.inscoper.api.DiagResults
DiagResults class contains the results from a device diagnostic.
class com.inscoper.api.DiagResultsVector
class com.inscoper.api.Dimension
Dimension class manages the parameters of a dimension (within a multi-dimensional acquisition).
class com.inscoper.api.DimensionParam
DimensionParam class holds status parameters for a dimension.
class com.inscoper.api.DimensionParamVector
class com.inscoper.api.DimensionVector
class com.inscoper.api.DriverConfig
Base class for driver configuration.
class com.inscoper.api.DriverDescription
DriverDescription base class.
enum com.inscoper.api.EBoxType
EBoxType enum defines the device controller types.
enum com.inscoper.api.EConnectionType
EConnectionType enum defines the types of device connections.
enum com.inscoper.api.EConnectionTypeDesc
EConnectionTypeDesc enum defines types of driver connection descriptors.
enum com.inscoper.api.EConnectorType
EConnectorType enum defines specific connector interfaces.
enum com.inscoper.api.EDeviceType
The EDeviceType enum defines the type of devices, among Micro-Manager and custom devices.
enum com.inscoper.api.EDriverType
EDriverType enum defines the driver type.
enum com.inscoper.api.EFunctionStatus
EFunctionStatus enum defines the status of a function.
enum com.inscoper.api.EFunctionType
EFunctionType enum defines the types of operations for sub-device functions.
enum com.inscoper.api.ELogLevel
ELogLevel enum defines the severity levels for logging.
enum com.inscoper.api.ELogMode
ELogMode enum defines the output destinations for logs.
enum com.inscoper.api.EOperation
EOperation enum defines mathematical operations for child status parameters.
enum com.inscoper.api.EParamType
EParamType enum defines data types.
enum com.inscoper.api.EPixelType
EPixelType enum defines the pixel formats.
enum com.inscoper.api.ERecipeElementType
ERecipeElementType enum defines the types of recipe elements.
class com.inscoper.api.ErrorListener
ErrorListener class allows receiving errors.
enum com.inscoper.api.ESequencePreparationStatus
ESequencePreparationStatus enum defines the progress state of a sequence preparation.
enum com.inscoper.api.ESubDeviceStatus
ESubDeviceStatus enum defines the state of a sub-device.
enum com.inscoper.api.ESubDeviceType
ESubDeviceType enum defines types of sub-devices.
class com.inscoper.api.EthernetConnectionConfig
EthernetConnectionConfig class provides required information for Ethernet devices configuration.
class com.inscoper.api.ExternalDriverDescription
ExternalDriverDescription class for external device drivers.
class com.inscoper.api.FunctionDescription
FunctionDescription class provides function information coming from drivers.
class com.inscoper.api.FunctionDescriptionVector
class com.inscoper.api.FunctionListener
FunctionListener class allows receiving notifications when a function is executed.
class com.inscoper.api.Image
Image class represents an image with associated metadata.
class com.inscoper.api.ImageListener
Interface for receiving images during acquisition.
class com.inscoper.api.ImageVector
class com.inscoper.api.Inscoper
class com.inscoper.api.InscoperBoxDriverConfig
InscoperBoxDriverConfig class provides information for devices controlled by the device controller.
class com.inscoper.api.InscoperBoxDriverDescription
The InscoperBoxDriverDescription class provides information for devices supported by the device controller.
interface com.inscoper.api.InscoperConstants
class com.inscoper.api.InscoperException
InscoperException class is the custom exception class.
class com.inscoper.api.InscoperJNI
class com.inscoper.api.LogListener
Interface for receiving log messages.
class com.inscoper.api.Metadata
Metadata class represents a container for image metadata.
class com.inscoper.api.MetadataList
class com.inscoper.api.MetadataMap
class com.inscoper.api.MicroManagerDriverConfig
MicroManagerDriverConfig class provides information for Micro-Manager devices.
class com.inscoper.api.MicroManagerDriverDescription
MicroManagerDriverDescription class provides information for Micro-Manager drivers.
class com.inscoper.api.ModifiableStatusParam
ModifiableStatusParam class represents a status parameter that can be modified during a sequence execution.
class com.inscoper.api.ModifiableStatusParamVector
class com.inscoper.api.ParamConfig
ParamConfig class provides required information for parameter configuration.
class com.inscoper.api.ParamConfigVector
class com.inscoper.api.ParamDescription
ParamDescription class provides parameter information coming from drivers.
class com.inscoper.api.ParamDescriptionVector
class com.inscoper.api.ParentStatusParam
ParentStatusParam class is a specialized StatusParam that allows hierarchical relationships.
class com.inscoper.api.Recipe
Recipe class represents the protocol to create a sequence of operations.
class com.inscoper.api.RecipeElement
RecipeElement class is the abstract base class for all recipe elements.
class com.inscoper.api.RecipeElementEvent
RecipeElementEvent class represents the check of an event within a recipe.
class com.inscoper.api.RecipeElementGroup
RecipeElementGroup class represents a recipe element that holds other recipe elements.
class com.inscoper.api.RecipeElementSimple
RecipeElementSimple class represents a basic recipe step with actions and conditions.
class com.inscoper.api.RecipeElementSimpleVector
class com.inscoper.api.RecipeElementVector
class com.inscoper.api.RecipeVector
class com.inscoper.api.RoiCrop
RoiCrop class defines a Region Of Interest for cropping.
class com.inscoper.api.RoiCropVector
class com.inscoper.api.SequenceHandler
SequenceHandler class manages sequence preparation progress and cancellation.
class com.inscoper.api.SequenceListener
SequenceListener class provides sequence completion notifications.
class com.inscoper.api.Shutter
Shutter class defines the interface for shutter devices.
class com.inscoper.api.Stage
Stage class defines the interface for 1D-positioning devices.
class com.inscoper.api.Status
Status class represents a state of the system.
class com.inscoper.api.StatusParam
StatusParam class pairs a sub-device with a value.
class com.inscoper.api.StatusParamVector
class com.inscoper.api.StatusVector
class com.inscoper.api.StringBoolMap
class com.inscoper.api.StringStringMap
class com.inscoper.api.StringVector
class com.inscoper.api.SubDeviceConfig
SubDeviceConfig class provides required information for sub-device configuration.
class com.inscoper.api.SubDeviceConfigVector
class com.inscoper.api.SubDeviceDescription
SubDeviceDescription class provides sub-device information coming from drivers.
class com.inscoper.api.SubDeviceDescriptionVector
class com.inscoper.api.SubDeviceId
SubDeviceId class uniquely identifies a sub-device.
class com.inscoper.api.SubDeviceIdVector
class com.inscoper.api.SWIGTYPE_p_std__type_info
class com.inscoper.api.UCharVector
class com.inscoper.api.UIntVector
class com.inscoper.api.USBConnectionConfig
USBConnectionConfig class provides required information for USB devices configuration.
class com.inscoper.api.UsbInfo
UsbInfo class contains all USB devices information connected to the device controller.
class com.inscoper.api.UsbInfoVector
class com.inscoper.api.UShortESubDeviceStatusMap
class com.inscoper.api.UShortUCharMap
class com.inscoper.api.UShortVector
class com.inscoper.api.Utils
Utils class provides utility functions.
class com.inscoper.api.ValueCondition
ValueCondition class defines a condition based on a sub-device value.
class com.inscoper.api.ValueConditionVector
class com.inscoper.api.XMLAttribute
XMLAttribute class represents an attribute of an XML node.
class com.inscoper.api.XMLAttributeVector
class com.inscoper.api.XMLDocument
XMLDocument class represents an entire XML document.
class com.inscoper.api.XMLNode
XMLNode class represents a node in an XML document.
class com.inscoper.api.XMLNodeVector
class com.inscoper.api.XYStage
XYStage class defines the interface for 2D-positioning devices.

Updated on 2026-04-02 at 10:55:37 +0200