Skip to content

lm.slide_scan.v1#

zen_api.lm.slide_scan.v1 #

Classes:

SlideState #

Bases: Enum

This enumeration names all possible slide processing states.

Attributes:

UNSPECIFIED class-attribute instance-attribute #

UNSPECIFIED = 0

Default value if status is not specified.

STOPPED class-attribute instance-attribute #

STOPPED = 1

Processing was stopped.

NEW class-attribute instance-attribute #

NEW = 2

New (not processed).

PREVIEW_IN_PROGRESS class-attribute instance-attribute #

PREVIEW_IN_PROGRESS = 3

Preview currently in work.

INPUT_REQUIRED class-attribute instance-attribute #

INPUT_REQUIRED = 4

Preview processing finished, but input required.

PREVIEWED class-attribute instance-attribute #

PREVIEWED = 5

Preview processing finished.

SCAN_IN_PROGRESS class-attribute instance-attribute #

SCAN_IN_PROGRESS = 6

Scan currently in work.

FINISHED class-attribute instance-attribute #

FINISHED = 7

Processing finished.

ERROR class-attribute instance-attribute #

ERROR = 8

Processing error occurred.

SKIPPED class-attribute instance-attribute #

SKIPPED = 9

Slide was skipped by user.

TraySlotState #

Bases: Enum

Enum defining the states of slide scanner slot LEDs.

Attributes:

UNSPECIFIED class-attribute instance-attribute #

UNSPECIFIED = 0

Default value if status is not specified.

SLOT_OPEN_SYSTEM_PAUSED class-attribute instance-attribute #

SLOT_OPEN_SYSTEM_PAUSED = 1

Slot swiveled out for assembling.

SLOT_OPEN_TRAY_LOADED class-attribute instance-attribute #

SLOT_OPEN_TRAY_LOADED = 2

Slot swiveled out for assembling but Tray is on stage.

SLOT_CLOSED_TRAY_NOT_PROCESSED class-attribute instance-attribute #

SLOT_CLOSED_TRAY_NOT_PROCESSED = 3

Slot swiveled in with tray containing unprocessed slides.

SLOT_CLOSED_TRAY_PROCESSED class-attribute instance-attribute #

SLOT_CLOSED_TRAY_PROCESSED = 4

Slot swiveled in with tray containing processed slides.

SLOT_CLOSED_PROCESS_ERROR class-attribute instance-attribute #

SLOT_CLOSED_PROCESS_ERROR = 5

Slot swiveled in with tray but an processing error was occurred.

SLOT_CLOSED_TRAY_PRESCANNED class-attribute instance-attribute #

SLOT_CLOSED_TRAY_PRESCANNED = 6

Slot swiveled in with tray containing pre-scanned slides.

SLOT_CLOSED_TRAY_LOADED class-attribute instance-attribute #

SLOT_CLOSED_TRAY_LOADED = 7

Slot swiveled in and tray is on stage.

SLOT_CLOSED_NO_TRAY class-attribute instance-attribute #

SLOT_CLOSED_NO_TRAY = 8

Slot swiveled in without tray.

SLOT_CLOSED_TRAY_IN_SYSTEM_AND_SLOT class-attribute instance-attribute #

SLOT_CLOSED_TRAY_IN_SYSTEM_AND_SLOT = 9

Slot swiveled in with tray and a tray on the stage (Error case).

SLOT_CLOSED_UNKNOWN_TRAY class-attribute instance-attribute #

SLOT_CLOSED_UNKNOWN_TRAY = 10

Slot swiveled in with an unknown tray type.

SLOT_CLOSED_NO_SLIDES class-attribute instance-attribute #

SLOT_CLOSED_NO_SLIDES = 11

Slot swiveled in with an empty tray.

SLOT_CLOSED_TRAY_PARTLY_PROCESSED_WITH_ERRORS class-attribute instance-attribute #

SLOT_CLOSED_TRAY_PARTLY_PROCESSED_WITH_ERRORS = 12

Slot swiveled in with tray containing processed slides.

UNKNOWN class-attribute instance-attribute #

UNKNOWN = 255

Unknown type (tray is inserted but could not be determined).

TrayType #

Bases: Enum

Enum defining the types of slide scanner trays.

Attributes:

  • UNSPECIFIED –

    Default value if status is not specified.

  • NONE –

    No tray.

  • SCAN1X3 –

    Scan tray for 4 slides of size 1'x3'.

  • SCAN2X3 –

    Scan tray for 2 slides of size 2'x3'.

  • SCAN1X3_2X3 –

    Scan tray for 2 slides, one of size 1'x3', one of size 2'x3'.

  • CALIBRATION_STAGE –

    Stage calibration slide holder tray.

  • SCAN1X3_BASIC –

    Scan tray for 4 slides of size 1'x3', basic design.

  • SCAN4X3 –

    Scan tray for 1 slide of size 4'x3' or a combination of slides of unknown size.

  • PARKING –

    Arbitrary tray type to indicate the parking position. Is only available at parking position of the magazine changer.

  • UNKNOWN –

    Unknown type (tray is inserted but could not be determined).

UNSPECIFIED class-attribute instance-attribute #

UNSPECIFIED = 0

Default value if status is not specified.

NONE class-attribute instance-attribute #

NONE = 1

No tray.

SCAN1X3 class-attribute instance-attribute #

SCAN1X3 = 2

Scan tray for 4 slides of size 1'x3'.

SCAN2X3 class-attribute instance-attribute #

SCAN2X3 = 3

Scan tray for 2 slides of size 2'x3'.

SCAN1X3_2X3 class-attribute instance-attribute #

SCAN1X3_2X3 = 4

Scan tray for 2 slides, one of size 1'x3', one of size 2'x3'.

CALIBRATION_STAGE class-attribute instance-attribute #

CALIBRATION_STAGE = 5

Stage calibration slide holder tray.

SCAN1X3_BASIC class-attribute instance-attribute #

SCAN1X3_BASIC = 6

Scan tray for 4 slides of size 1'x3', basic design.

SCAN4X3 class-attribute instance-attribute #

SCAN4X3 = 7

Scan tray for 1 slide of size 4'x3' or a combination of slides of unknown size.

PARKING class-attribute instance-attribute #

PARKING = 152

Arbitrary tray type to indicate the parking position. Is only available at parking position of the magazine changer.

UNKNOWN class-attribute instance-attribute #

UNKNOWN = 153

Unknown type (tray is inserted but could not be determined).

TrayWorkingState #

Bases: Enum

Enum defining the types of slide scanner trays working state.

Attributes:

  • UNSPECIFIED –

    Default value if status is not specified.

  • NOT_SCANNED –

    The tray is not scanned.

  • PRESCANNED –

    The tray was pre scanned.

  • SCANNED –

    The tray was successfully scanned.

  • ERROR –

    There occurred an error while scanning or pre scanning the tray.

  • NOT_AVAILABLE –

    There is no tray available at this position.

UNSPECIFIED class-attribute instance-attribute #

UNSPECIFIED = 0

Default value if status is not specified.

NOT_SCANNED class-attribute instance-attribute #

NOT_SCANNED = 1

The tray is not scanned.

PRESCANNED class-attribute instance-attribute #

PRESCANNED = 2

The tray was pre scanned.

SCANNED class-attribute instance-attribute #

SCANNED = 3

The tray was successfully scanned.

ERROR class-attribute instance-attribute #

ERROR = 4

There occurred an error while scanning or pre scanning the tray.

NOT_AVAILABLE class-attribute instance-attribute #

NOT_AVAILABLE = 5

There is no tray available at this position.

ResponseCode #

Bases: Enum

Numerical result code.

Attributes:

UNSPECIFIED class-attribute instance-attribute #

UNSPECIFIED = 0

Default value if the status is not specified.

INVALID_ARGUMENT class-attribute instance-attribute #

INVALID_ARGUMENT = 1

The required parameter is missing.

NOT_FOUND class-attribute instance-attribute #

NOT_FOUND = 2

The requested resource could not be found.

NOT_ALLOWED class-attribute instance-attribute #

NOT_ALLOWED = 3

The operation is not allowed.

ResponseType #

Bases: Enum

Kind of failure with implication to error recovery.

Attributes:

  • UNSPECIFIED –

    Default value if the ResponseType is not specified.

  • SUCCESS –

    The API call is accepted and will be processed.

  • WARNING –

    The API call is accepted and will be processed.

  • FAILED –

    Something went wrong. This is the usual error type.

  • EXCEPTION –

    The call threw an exeption.

UNSPECIFIED class-attribute instance-attribute #

UNSPECIFIED = 0

Default value if the ResponseType is not specified.

SUCCESS class-attribute instance-attribute #

SUCCESS = 1

The API call is accepted and will be processed. In this case the response code can be unspecified.

WARNING class-attribute instance-attribute #

WARNING = 2

The API call is accepted and will be processed. In this case, the response contains an indication of possible problem settings.

FAILED class-attribute instance-attribute #

FAILED = 3

Something went wrong. This is the usual error type.

EXCEPTION class-attribute instance-attribute #

EXCEPTION = 4

The call threw an exeption.

ChannelSettings dataclass #

ChannelSettings(channel_identifier: str = betterproto.string_field(1), channel_name: str = betterproto.string_field(2), channel_description: str = betterproto.string_field(3), dye_name: str = betterproto.string_field(4), intensity: float = betterproto.double_field(5), exposure_time: float = betterproto.double_field(6))

Bases: Message

Settings for a channel.

Attributes:

channel_identifier class-attribute instance-attribute #

channel_identifier: str = string_field(1)

The identifier for the master channel.

channel_name class-attribute instance-attribute #

channel_name: str = string_field(2)

The name for the channel.

channel_description class-attribute instance-attribute #

channel_description: str = string_field(3)

The description for the channel.

dye_name class-attribute instance-attribute #

dye_name: str = string_field(4)

The fluorescence dye.

intensity class-attribute instance-attribute #

intensity: float = double_field(5)

The lamp intensity that should be used for a channel. The intensity is set in percent. (Values ranging from 0 to 100).

exposure_time class-attribute instance-attribute #

exposure_time: float = double_field(6)

The exposure time that should be used for a channel. The exposure time is set in milliseconds. (Values ranging from 0.1 to 2000ms).

ProfileInformation dataclass #

ProfileInformation(profile_name: str = betterproto.string_field(1))

Bases: Message

ProfileInformation contains information about the scan profile associated with a specific slide.

Attributes:

  • profile_name (str) –

    The profile name associated with the slides acquisition.

profile_name class-attribute instance-attribute #

profile_name: str = string_field(1)

The profile name associated with the slides acquisition.

SlideInformation dataclass #

SlideInformation(slide_on_frame_position: int = betterproto.int32_field(1), state: SlideState = betterproto.enum_field(2), profile_information: ProfileInformation = betterproto.message_field(3), is_selected_for_processing: bool = betterproto.bool_field(4), barcode: str = betterproto.string_field(5), label_image_path: str = betterproto.string_field(6), preview_image_path: str = betterproto.string_field(7), scan_image_path: str = betterproto.string_field(8), state_last_error: str = betterproto.string_field(9), prescan_image_path: str = betterproto.string_field(10))

Bases: Message

SlideInformation holds information about an Axioscan slide.

Attributes:

slide_on_frame_position class-attribute instance-attribute #

slide_on_frame_position: int = int32_field(1)

The slide position on the frame - range [1, 4]. The maximum value depending on frame type.

state class-attribute instance-attribute #

state: SlideState = enum_field(2)

The ZenApi.LM.SlideScan.V1.SlideState of the slide.

profile_information class-attribute instance-attribute #

profile_information: ProfileInformation = message_field(3)

The corresponding ZenApi.LM.SlideScan.V1.SlideInformation.ProfileInformation of the slide.

is_selected_for_processing class-attribute instance-attribute #

is_selected_for_processing: bool = bool_field(4)

A value indicating whether this slide is selected for processing.

barcode class-attribute instance-attribute #

barcode: str = string_field(5)

The barcode of the slide.

label_image_path class-attribute instance-attribute #

label_image_path: str = string_field(6)

The path to the label image.

preview_image_path class-attribute instance-attribute #

preview_image_path: str = string_field(7)

The path to the preview image.

scan_image_path class-attribute instance-attribute #

scan_image_path: str = string_field(8)

The path to the scan image.

state_last_error class-attribute instance-attribute #

state_last_error: str = string_field(9)

The SlideItem.LastError of the slide.

prescan_image_path class-attribute instance-attribute #

prescan_image_path: str = string_field(10)

The path to the prescan image.

TrayInformation dataclass #

TrayInformation(position: int = betterproto.int32_field(1), type: TrayType = betterproto.enum_field(2), working_state: TrayWorkingState = betterproto.enum_field(3), slot_state: TraySlotState = betterproto.enum_field(4), slides: List[SlideInformation] = betterproto.message_field(5))

Bases: Message

TrayInformation contains information about an Axioscan tray.

Attributes:

  • position (int) –

    The position of the tray inside the Axioscan magazine in the range of [1, 26].

  • type (TrayType) –

    The ZenApi.LM.SlideScan.V1.TrayType of the tray. The type determines the number of possible slides on the tray.

  • working_state (TrayWorkingState) –

    The ZenApi.LM.SlideScan.V1.TrayWorkingState of the tray. The working state of the entire tray.

  • slot_state (TraySlotState) –

    The ZenApi.LM.SlideScan.V1.TraySlotState of the tray. The status of the tray slot ( open/closed statuses).

  • slides (List[SlideInformation]) –

    ZenApi.LM.SlideScan.V1.SlideInformation of the slides.

position class-attribute instance-attribute #

position: int = int32_field(1)

The position of the tray inside the Axioscan magazine in the range of [1, 26].

type class-attribute instance-attribute #

type: TrayType = enum_field(2)

The ZenApi.LM.SlideScan.V1.TrayType of the tray. The type determines the number of possible slides on the tray.

working_state class-attribute instance-attribute #

working_state: TrayWorkingState = enum_field(3)

The ZenApi.LM.SlideScan.V1.TrayWorkingState of the tray. The working state of the entire tray.

slot_state class-attribute instance-attribute #

slot_state: TraySlotState = enum_field(4)

The ZenApi.LM.SlideScan.V1.TraySlotState of the tray. The status of the tray slot ( open/closed statuses).

slides class-attribute instance-attribute #

slides: List[SlideInformation] = message_field(5)

ZenApi.LM.SlideScan.V1.SlideInformation of the slides.

InformationBase dataclass #

InformationBase(simple_information: SimpleInformation = betterproto.message_field(1, group='subtype'), slide_scan_system_information: SlideScanSystemInformation = betterproto.message_field(2, group='subtype'), magazine_information: MagazineInformation = betterproto.message_field(3, group='subtype'))

Bases: Message

Base class for all information types.

MagazineInformation dataclass #

MagazineInformation(is_door_closed: bool = betterproto.bool_field(1), trays: List[TrayInformation] = betterproto.message_field(2))

Bases: Message

Data container for inforamtion about the magazine state.

Attributes:

  • is_door_closed (bool) –

    A value indicating whether the Axioscan tray door is closed.

  • trays (List[TrayInformation]) –

    The magazine state by providing the list of available trays.

is_door_closed class-attribute instance-attribute #

is_door_closed: bool = bool_field(1)

A value indicating whether the Axioscan tray door is closed.

trays class-attribute instance-attribute #

trays: List[TrayInformation] = message_field(2)

The magazine state by providing the list of available trays.

SimpleInformation dataclass #

SimpleInformation(message: str = betterproto.string_field(1))

Bases: Message

Data container for a simple message inforamtion.

Attributes:

  • message (str) –

    The simple string message.

message class-attribute instance-attribute #

message: str = string_field(1)

The simple string message.

SlideScanSystemInformation dataclass #

SlideScanSystemInformation(is_idle: bool = betterproto.bool_field(1), is_scan_running: bool = betterproto.bool_field(2), is_preview_scan_running: bool = betterproto.bool_field(3), is_tray_initializing: bool = betterproto.bool_field(4))

Bases: Message

Data container for information about the hardware state.

Attributes:

  • is_idle (bool) –

    A value indicating whether an Axioscan system is idle.

  • is_scan_running (bool) –

    A value indicating whether a scan is running.

  • is_preview_scan_running (bool) –

    A value indicating whether a preview scan is running.

  • is_tray_initializing (bool) –

    A value indicating whether a tray is being initialized.

is_idle class-attribute instance-attribute #

is_idle: bool = bool_field(1)

A value indicating whether an Axioscan system is idle.

is_scan_running class-attribute instance-attribute #

is_scan_running: bool = bool_field(2)

A value indicating whether a scan is running.

is_preview_scan_running class-attribute instance-attribute #

is_preview_scan_running: bool = bool_field(3)

A value indicating whether a preview scan is running. This property is deprecated. Use IsScanRunning instead.

is_tray_initializing class-attribute instance-attribute #

is_tray_initializing: bool = bool_field(4)

A value indicating whether a tray is being initialized.

RegionDefinition dataclass #

RegionDefinition(contour: RegionContour = betterproto.message_field(1))

Bases: Message

Represents definition of scan region.

Attributes:

contour class-attribute instance-attribute #

contour: RegionContour = message_field(1)

The region contour definition. The type of the contour can be: ZenApi.LM.Acquisition.V2.RegionRectangle, ZenApi.LM.Acquisition.V2.RegionEllipse or ZenApi.LM.Acquisition.V2.RegionPolygon.

ScanProfileOptionsOverride dataclass #

ScanProfileOptionsOverride(make_prescan_preview: Optional[bool] = betterproto.message_field(1, wraps=(betterproto.TYPE_BOOL)), use_manual_segmentation: Optional[bool] = betterproto.message_field(2, wraps=(betterproto.TYPE_BOOL)), disable_label_detection: Optional[bool] = betterproto.message_field(3, wraps=(betterproto.TYPE_BOOL)))

Bases: Message

Data container for overriding options of a scan profile.

Attributes:

  • make_prescan_preview (Optional[bool]) –

    A value indicating whether the prescan preview should be made or only a preview with the preview cam.

  • use_manual_segmentation (Optional[bool]) –

    A value indicating whether the segmentation mode shall be manual.

  • disable_label_detection (Optional[bool]) –

    A value indicating whether the label detection shall be disabled.

make_prescan_preview class-attribute instance-attribute #

make_prescan_preview: Optional[bool] = message_field(1, wraps=TYPE_BOOL)

A value indicating whether the prescan preview should be made or only a preview with the preview cam. If set to perform a prescan, the prescan will be done according to existing settings in the scan profile without modifications (resp. default settings will be used).

use_manual_segmentation class-attribute instance-attribute #

use_manual_segmentation: Optional[bool] = message_field(2, wraps=TYPE_BOOL)

A value indicating whether the segmentation mode shall be manual. If not set or set to false, the segmentation will be performed as defined in the scan profile.

disable_label_detection class-attribute instance-attribute #

disable_label_detection: Optional[bool] = message_field(3, wraps=TYPE_BOOL)

A value indicating whether the label detection shall be disabled. If set to true, the barcode and ocr recognition will be disabled. If not set or set to false, the label detection will be performed as defined in the scan profile.

SlidePositionInformation dataclass #

SlidePositionInformation(slide_on_frame_position: int = betterproto.int32_field(1), tray_position: int = betterproto.int32_field(2), image_name: str = betterproto.string_field(3))

Bases: Message

SlidePositionInformation holds information about an AxioScan slide position.

Attributes:

  • slide_on_frame_position (int) –

    The slide position on the frame - range [1, 4]. The maximum value depending on frame type.

  • tray_position (int) –

    The position of the tray inside the Axioscan magazine in the range of [1, 26].

  • image_name (str) –

    The image name for the slide.

slide_on_frame_position class-attribute instance-attribute #

slide_on_frame_position: int = int32_field(1)

The slide position on the frame - range [1, 4]. The maximum value depending on frame type.

tray_position class-attribute instance-attribute #

tray_position: int = int32_field(2)

The position of the tray inside the Axioscan magazine in the range of [1, 26].

image_name class-attribute instance-attribute #

image_name: str = string_field(3)

The image name for the slide.

GeneralResponse dataclass #

GeneralResponse(type: ResponseType = betterproto.enum_field(1), code: ResponseCode = betterproto.enum_field(2), description: str = betterproto.string_field(3), user_message: str = betterproto.string_field(4))

Bases: Message

A general response for all asynchronous requests that do not return any results or data.

Attributes:

type class-attribute instance-attribute #

type: ResponseType = enum_field(1)

The type of resonse message.

code class-attribute instance-attribute #

code: ResponseCode = enum_field(2)

The code of resonse message.

description class-attribute instance-attribute #

description: str = string_field(3)

A description. Explanation text, for developers only.

user_message class-attribute instance-attribute #

user_message: str = string_field(4)

A message suitable to be shown in user interfaces, will be translated by Api.

SlideScanServiceGetChannelSettingsRequest dataclass #

SlideScanServiceGetChannelSettingsRequest(scan_profile_path: str = betterproto.string_field(1))

Bases: Message

Describes the input parameters for retrieving the configured channels.

Attributes:

scan_profile_path class-attribute instance-attribute #

scan_profile_path: str = string_field(1)

The path of the specified scan profile.

SlideScanServiceGetChannelSettingsResponse dataclass #

SlideScanServiceGetChannelSettingsResponse(channel_setting_list: List[ChannelSettings] = betterproto.message_field(1))

Bases: Message

Lists the configured channel settings in the specified scan profile.

Attributes:

channel_setting_list class-attribute instance-attribute #

channel_setting_list: List[ChannelSettings] = message_field(1)

The configured channel settings.

SlideScanServiceGetMagazineStateRequest dataclass #

SlideScanServiceGetMagazineStateRequest()

Bases: Message

Describes the input parameters for a call to retrieve the magazine state.

SlideScanServiceGetMagazineStateResponse dataclass #

SlideScanServiceGetMagazineStateResponse(trays: List[TrayInformation] = betterproto.message_field(1))

Bases: Message

Lists the populated slides of each tray.

Attributes:

trays class-attribute instance-attribute #

trays: List[TrayInformation] = message_field(1)

The loaded slides per tray.

SlideScanServiceGetStorageFolderRequest dataclass #

SlideScanServiceGetStorageFolderRequest()

Bases: Message

Describes the input parameters for a call to retrieve the storage folder for slide scans.

SlideScanServiceGetStorageFolderResponse dataclass #

SlideScanServiceGetStorageFolderResponse(path: str = betterproto.string_field(1))

Bases: Message

Describes the result for a call to retrieve the storage folder for slide scans.

Attributes:

  • path (str) –

    The storage folder path.

path class-attribute instance-attribute #

path: str = string_field(1)

The storage folder path.

SlideScanServiceObserveRequest dataclass #

SlideScanServiceObserveRequest()

Bases: Message

Describes the input parameters for a call to observe the events and progress that happen either during acquisition or while the microscope is idling.

SlideScanServiceObserveResponse dataclass #

SlideScanServiceObserveResponse(information: InformationBase = betterproto.message_field(1))

Bases: Message

Describes the output parameters for a call to observe the events, progress and additional information like warnings and errors of a running scan profile acquisition. The response might be a stream of different information types (e.g. Progress, Error, Hardware State, ...).

Attributes:

information class-attribute instance-attribute #

information: InformationBase = message_field(1)

The flexible, variable information.

SlideScanServiceResetSlideStatesRequest dataclass #

SlideScanServiceResetSlideStatesRequest(slide_position_list: List[SlidePositionInformation] = betterproto.message_field(1))

Bases: Message

Describes the input parameters for resetting the state of specified slides to new.

Attributes:

slide_position_list class-attribute instance-attribute #

slide_position_list: List[SlidePositionInformation] = message_field(1)

The position of the slide list to be reset.

SlideScanServiceResetSlideStatesResponse dataclass #

SlideScanServiceResetSlideStatesResponse(response: GeneralResponse = betterproto.message_field(1))

Bases: Message

Describes the output parameters for resetting the state of specified slides.

Attributes:

response class-attribute instance-attribute #

response: GeneralResponse = message_field(1)

A general response about the success/error state of the request.

SlideScanServiceSetStorageFolderRequest dataclass #

SlideScanServiceSetStorageFolderRequest(path: str = betterproto.string_field(1))

Bases: Message

Describes the input parameters for setting the storage folder for slide scans.

Attributes:

  • path (str) –

    The path to the storage folder where slide scans should be stored.

path class-attribute instance-attribute #

path: str = string_field(1)

The path to the storage folder where slide scans should be stored.

SlideScanServiceSetStorageFolderResponse dataclass #

SlideScanServiceSetStorageFolderResponse(response: GeneralResponse = betterproto.message_field(1))

Bases: Message

Describes the result for a call to set the storage folder.

Attributes:

response class-attribute instance-attribute #

response: GeneralResponse = message_field(1)

A general response to inform about the requests success/error state.

SlideScanServiceStartScanPreviewRequest dataclass #

SlideScanServiceStartScanPreviewRequest(scan_profile_name: str = betterproto.string_field(1), slide_position_list: List[SlidePositionInformation] = betterproto.message_field(2), scan_profile_options_override: ScanProfileOptionsOverride = betterproto.message_field(3))

Bases: Message

Describes the input parameters for the preview start.

Attributes:

scan_profile_name class-attribute instance-attribute #

scan_profile_name: str = string_field(1)

The name of the scan profile that should be started.

slide_position_list class-attribute instance-attribute #

slide_position_list: List[SlidePositionInformation] = message_field(2)

The list of tray/slides to be processed.

scan_profile_options_override class-attribute instance-attribute #

scan_profile_options_override: ScanProfileOptionsOverride = message_field(3)

Optional overrides for scan profile options.

SlideScanServiceStartScanPreviewResponse dataclass #

SlideScanServiceStartScanPreviewResponse(response: GeneralResponse = betterproto.message_field(1))

Bases: Message

Response of starting a preview in the slide scan service.

Attributes:

response class-attribute instance-attribute #

response: GeneralResponse = message_field(1)

A general response to inform about the requests success/error state.

SlideScanServiceStartScanProfileRequest dataclass #

SlideScanServiceStartScanProfileRequest(scan_profile_name: str = betterproto.string_field(1), slide_position_list: List[SlidePositionInformation] = betterproto.message_field(2), channel_settings: List[ChannelSettings] = betterproto.message_field(3), region_definitions: List[RegionDefinition] = betterproto.message_field(4), scan_profile_options_override: ScanProfileOptionsOverride = betterproto.message_field(5))

Bases: Message

Describes the input parameters for the scan profile start.

Attributes:

scan_profile_name class-attribute instance-attribute #

scan_profile_name: str = string_field(1)

The name of the scan profile that should be started.

slide_position_list class-attribute instance-attribute #

slide_position_list: List[SlidePositionInformation] = message_field(2)

The list of tray/slides to be processed.

channel_settings class-attribute instance-attribute #

channel_settings: List[ChannelSettings] = message_field(3)

The list of changed channel settings.

region_definitions class-attribute instance-attribute #

region_definitions: List[RegionDefinition] = message_field(4)

The list of region contour definition.

scan_profile_options_override class-attribute instance-attribute #

scan_profile_options_override: ScanProfileOptionsOverride = message_field(5)

Optional overrides for scan profile options.

SlideScanServiceStartScanProfileResponse dataclass #

SlideScanServiceStartScanProfileResponse(response: GeneralResponse = betterproto.message_field(1))

Bases: Message

Describes the output parameters for a call to start the scan profile.

Attributes:

response class-attribute instance-attribute #

response: GeneralResponse = message_field(1)

A general response to inform about the requests success/error state.

SlideScanServiceStopScanPreviewRequest dataclass #

SlideScanServiceStopScanPreviewRequest()

Bases: Message

Represents a request to stop the preview in the SlideScan service.

SlideScanServiceStopScanPreviewResponse dataclass #

SlideScanServiceStopScanPreviewResponse(response: GeneralResponse = betterproto.message_field(1))

Bases: Message

Represents the response for stopping the preview in the slide scan service.

Attributes:

response class-attribute instance-attribute #

response: GeneralResponse = message_field(1)

A general response to inform about the requests success/error state.

SlideScanServiceStopScanProfileRequest dataclass #

SlideScanServiceStopScanProfileRequest()

Bases: Message

Describes the input parameters for stopping the scan profile.

SlideScanServiceStopScanProfileResponse dataclass #

SlideScanServiceStopScanProfileResponse(response: GeneralResponse = betterproto.message_field(1))

Bases: Message

Describes the output parameters for a call to stop the scan profile.

Attributes:

response class-attribute instance-attribute #

response: GeneralResponse = message_field(1)

A general response to inform about the requests success/error state.

SlideScanServiceUnmarkSlidesRequest dataclass #

SlideScanServiceUnmarkSlidesRequest(slide_position_list: List[SlidePositionInformation] = betterproto.message_field(1))

Bases: Message

Describes the input parameters for unmark slides.

Attributes:

slide_position_list class-attribute instance-attribute #

slide_position_list: List[SlidePositionInformation] = message_field(1)

The position of the slide list to be unmarked.

SlideScanServiceUnmarkSlidesResponse dataclass #

SlideScanServiceUnmarkSlidesResponse(response: GeneralResponse = betterproto.message_field(1))

Bases: Message

Describes the output parameters for a call to unmark slides.

Attributes:

response class-attribute instance-attribute #

response: GeneralResponse = message_field(1)

A general response to inform about the requests success/error state.