Skip to content

lm.acquisition.v1#

zen_api.lm.acquisition.v1 #

Classes:

AutofocusContrastMeasure #

Bases: Enum

The contrast measures of the software autofocus contrast mode.

Attributes:

  • UNSPECIFIED –

    Default enum value.

  • DEFAULT –

    The default contrast measure.

  • LOW_SIGNAL –

    The contrast measure to use in low-signal and calibration situations.

UNSPECIFIED class-attribute instance-attribute #

UNSPECIFIED = 0

Default enum value.

DEFAULT class-attribute instance-attribute #

DEFAULT = 1

The default contrast measure.

LOW_SIGNAL class-attribute instance-attribute #

LOW_SIGNAL = 2

The contrast measure to use in low-signal and calibration situations.

AutofocusMode #

Bases: Enum

The autofocus modes.

Attributes:

  • UNSPECIFIED –

    Default enum value.

  • CONTRAST –

    Sharpness is measured on the basis of contrast values.

  • INTENSITY –

    Sharpness is measured on the basis of intensity values.

  • AUTO –

    Automatic determination of measure method (Contrast or Intensity) in dependency of used hardware.

  • REFLEX –

    Sharpness is measured with the reflection mode autofocus.

UNSPECIFIED class-attribute instance-attribute #

UNSPECIFIED = 0

Default enum value.

CONTRAST class-attribute instance-attribute #

CONTRAST = 1

Sharpness is measured on the basis of contrast values.

INTENSITY class-attribute instance-attribute #

INTENSITY = 2

Sharpness is measured on the basis of intensity values.

AUTO class-attribute instance-attribute #

AUTO = 3

Automatic determination of measure method (Contrast or Intensity) in dependency of used hardware.

REFLEX class-attribute instance-attribute #

REFLEX = 4

Sharpness is measured with the reflection mode autofocus.

AutofocusSampling #

Bases: Enum

Scales the depth of focus by predefined values given here.

Attributes:

  • UNSPECIFIED –

    Default enum value.

  • FINE –

    Do oversampling.

  • DEFAULT –

    Do sampling according to depth of focus.

  • MEDIUM –

    Do under sampling.

  • COARSE –

    Coarser than medium.

UNSPECIFIED class-attribute instance-attribute #

UNSPECIFIED = 0

Default enum value.

FINE class-attribute instance-attribute #

FINE = 1

Do oversampling.

DEFAULT class-attribute instance-attribute #

DEFAULT = 2

Do sampling according to depth of focus.

MEDIUM class-attribute instance-attribute #

MEDIUM = 3

Do under sampling.

COARSE class-attribute instance-attribute #

COARSE = 4

Coarser than medium.

ChannelInfo dataclass #

ChannelInfo(name: str = betterproto.string_field(1), is_activated: bool = betterproto.bool_field(2))

Bases: Message

Information about a channel.

Attributes:

  • name (str) –

    The channel name.

  • is_activated (bool) –

    A value indicating whether the channel is activated.

name class-attribute instance-attribute #

name: str = string_field(1)

The channel name.

is_activated class-attribute instance-attribute #

is_activated: bool = bool_field(2)

A value indicating whether the channel is activated.

DefiniteFocusServiceFindSurfaceRequest dataclass #

DefiniteFocusServiceFindSurfaceRequest()

Bases: Message

The DefiniteFocusServiceFindSurfaceRequest class.

DefiniteFocusServiceFindSurfaceResponse dataclass #

DefiniteFocusServiceFindSurfaceResponse(zposition: float = betterproto.double_field(1))

Bases: Message

Response for FindSurface.

Attributes:

zposition class-attribute instance-attribute #

zposition: float = double_field(1)

The Z position.

DefiniteFocusServiceLockFocusRequest dataclass #

DefiniteFocusServiceLockFocusRequest(timeout: int = betterproto.int32_field(1))

Bases: Message

The DefiniteFocusServiceLockFocusRequest class.

Attributes:

  • timeout (int) –

    Timeout in seconds.

timeout class-attribute instance-attribute #

timeout: int = int32_field(1)

Timeout in seconds.

DefiniteFocusServiceLockFocusResponse dataclass #

DefiniteFocusServiceLockFocusResponse()

Bases: Message

Response for LockFocus.

DefiniteFocusServiceRecallFocusRequest dataclass #

DefiniteFocusServiceRecallFocusRequest()

Bases: Message

The DefiniteFocusServiceRecallFocusRequest class.

DefiniteFocusServiceRecallFocusResponse dataclass #

DefiniteFocusServiceRecallFocusResponse(zposition: float = betterproto.double_field(1))

Bases: Message

Response for RecallFocus.

Attributes:

zposition class-attribute instance-attribute #

zposition: float = double_field(1)

The Z position.

DefiniteFocusServiceStoreFocusRequest dataclass #

DefiniteFocusServiceStoreFocusRequest()

Bases: Message

The DefiniteFocusServiceStoreFocusRequest class.

DefiniteFocusServiceStoreFocusResponse dataclass #

DefiniteFocusServiceStoreFocusResponse()

Bases: Message

Response for StoreFocus.

DefiniteFocusServiceUnlockFocusRequest dataclass #

DefiniteFocusServiceUnlockFocusRequest()

Bases: Message

The DefiniteFocusServiceUnlockFocusRequest class.

DefiniteFocusServiceUnlockFocusResponse dataclass #

DefiniteFocusServiceUnlockFocusResponse()

Bases: Message

Response for UnlockFocus.

ExperimentSwAutofocusServiceExportRequest dataclass #

ExperimentSwAutofocusServiceExportRequest(experiment_id: str = betterproto.string_field(1))

Bases: Message

The ExperimentSwAutofocusServiceExportRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

The experiment id.

ExperimentSwAutofocusServiceExportResponse dataclass #

ExperimentSwAutofocusServiceExportResponse(xml_string: str = betterproto.string_field(1))

Bases: Message

Response object representing the values of xml string.

Attributes:

xml_string class-attribute instance-attribute #

xml_string: str = string_field(1)

A value of the xml string.

ExperimentSwAutofocusServiceFindAutoFocusRequest dataclass #

ExperimentSwAutofocusServiceFindAutoFocusRequest(experiment_id: str = betterproto.string_field(1), timeout: Optional[float] = betterproto.message_field(2, wraps=(betterproto.TYPE_DOUBLE)))

Bases: Message

The ExperimentSwAutofocusServiceFindAutoFocusRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

The experiment id.

timeout class-attribute instance-attribute #

timeout: Optional[float] = message_field(2, wraps=TYPE_DOUBLE)

The timeout in seconds.

ExperimentSwAutofocusServiceFindAutoFocusResponse dataclass #

ExperimentSwAutofocusServiceFindAutoFocusResponse(focus_position: float = betterproto.double_field(1))

Bases: Message

Response object representing the focus position.

Attributes:

focus_position class-attribute instance-attribute #

focus_position: float = double_field(1)

The focus position (unit: m).

ExperimentSwAutofocusServiceGetAutofocusParametersRequest dataclass #

ExperimentSwAutofocusServiceGetAutofocusParametersRequest(experiment_id: str = betterproto.string_field(1))

Bases: Message

The ExperimentSwAutofocusServiceGetAutofocusParametersRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

The experiment id.

ExperimentSwAutofocusServiceGetAutofocusParametersResponse dataclass #

ExperimentSwAutofocusServiceGetAutofocusParametersResponse(experiment_id: str = betterproto.string_field(1), auto_focus_mode: AutofocusMode = betterproto.enum_field(2), contrast_measure: AutofocusContrastMeasure = betterproto.enum_field(3), search_strategy: str = betterproto.string_field(4), autofocus_sampling: AutofocusSampling = betterproto.enum_field(5), offset: float = betterproto.double_field(6), use_acquisition_roi: bool = betterproto.bool_field(7), reference_channel_name: str = betterproto.string_field(8), relative_range_is_automatic: bool = betterproto.bool_field(9), relative_search_range: float = betterproto.double_field(10), lower_limit: float = betterproto.double_field(11), upper_limit: float = betterproto.double_field(12))

Bases: Message

Response object representing the values of software autofocus parameters for the experiment.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

A value of the experiment id.

auto_focus_mode class-attribute instance-attribute #

auto_focus_mode: AutofocusMode = enum_field(2)

A value of autofocus mode.

contrast_measure class-attribute instance-attribute #

contrast_measure: AutofocusContrastMeasure = enum_field(3)

A value of sharpness measure for contrast mode.

search_strategy class-attribute instance-attribute #

search_strategy: str = string_field(4)

A value of search strategy. Either "Smart", "Full", "FullNoChecks" or the name of an extension strategy.

autofocus_sampling class-attribute instance-attribute #

autofocus_sampling: AutofocusSampling = enum_field(5)

A value of the predefined step size.

offset class-attribute instance-attribute #

offset: float = double_field(6)

A value of the reflection mode offset (unit: m).

use_acquisition_roi class-attribute instance-attribute #

use_acquisition_roi: bool = bool_field(7)

A value indicating whether the acquisition ROI is used for the software autofocus.

reference_channel_name class-attribute instance-attribute #

reference_channel_name: str = string_field(8)

A name of the focus reference channel.

relative_range_is_automatic class-attribute instance-attribute #

relative_range_is_automatic: bool = bool_field(9)

A value indicating whether the relative search range size is determined automatically.

relative_search_range class-attribute instance-attribute #

relative_search_range: float = double_field(10)

A value of the relative search range of the Z drive (unit: m).

lower_limit class-attribute instance-attribute #

lower_limit: float = double_field(11)

A value of the lower search range limit of the Z drive (unit: m).

upper_limit class-attribute instance-attribute #

upper_limit: float = double_field(12)

A value of the upper search range limit of the Z drive (unit: m).

ExperimentSwAutofocusServiceImportRequest dataclass #

ExperimentSwAutofocusServiceImportRequest(experiment_id: str = betterproto.string_field(1), xml_string: str = betterproto.string_field(2))

Bases: Message

The ExperimentSwAutofocusServiceImportRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

The experiment id.

xml_string class-attribute instance-attribute #

xml_string: str = string_field(2)

Xml string to be imported.

ExperimentSwAutofocusServiceImportResponse dataclass #

ExperimentSwAutofocusServiceImportResponse()

Bases: Message

The ExperimentSwAutofocusServiceImportResponse class.

ExperimentSwAutofocusServiceSetAutofocusParametersRequest dataclass #

ExperimentSwAutofocusServiceSetAutofocusParametersRequest(experiment_id: str = betterproto.string_field(1), autofocus_mode: AutofocusMode = betterproto.enum_field(2), contrast_measure: AutofocusContrastMeasure = betterproto.enum_field(3), search_strategy: str = betterproto.string_field(4), autofocus_sampling: AutofocusSampling = betterproto.enum_field(5), offset: Optional[float] = betterproto.message_field(6, wraps=(betterproto.TYPE_DOUBLE)), use_acquisition_roi: Optional[bool] = betterproto.message_field(7, wraps=(betterproto.TYPE_BOOL)), reference_channel_name: str = betterproto.string_field(8), relative_range_is_automatic: Optional[bool] = betterproto.message_field(9, wraps=(betterproto.TYPE_BOOL)), relative_search_range: Optional[float] = betterproto.message_field(10, wraps=(betterproto.TYPE_DOUBLE)), lower_limit: Optional[float] = betterproto.message_field(11, wraps=(betterproto.TYPE_DOUBLE)), upper_limit: Optional[float] = betterproto.message_field(12, wraps=(betterproto.TYPE_DOUBLE)))

Bases: Message

The ExperimentSwAutofocusServiceSetAutofocusParametersRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

The experiment id.

autofocus_mode class-attribute instance-attribute #

autofocus_mode: AutofocusMode = enum_field(2)

The autofocus mode.

contrast_measure class-attribute instance-attribute #

contrast_measure: AutofocusContrastMeasure = enum_field(3)

The sharpness measure for contrast mode.

search_strategy class-attribute instance-attribute #

search_strategy: str = string_field(4)

The strategy, either "Smart", "Full", "FullNoChecks" or the name of an extension strategy, or null to leave unmodified. This parameter is case-insensitive.

autofocus_sampling class-attribute instance-attribute #

autofocus_sampling: AutofocusSampling = enum_field(5)

The predefined step size, or null to leave unmodified.

offset class-attribute instance-attribute #

offset: Optional[float] = message_field(6, wraps=TYPE_DOUBLE)

The reflection mode offset (unit: m), or null to leave unmodified.

use_acquisition_roi class-attribute instance-attribute #

use_acquisition_roi: Optional[bool] = message_field(7, wraps=TYPE_BOOL)

True if the acquisition ROI is used for the software autofocus; otherwise, false, or null to leave unmodified.

reference_channel_name class-attribute instance-attribute #

reference_channel_name: str = string_field(8)

The case-insensitive name of the focus reference channel, or null to leave unmodified.

relative_range_is_automatic class-attribute instance-attribute #

relative_range_is_automatic: Optional[bool] = message_field(9, wraps=TYPE_BOOL)

True if the relative search range size is determined automatically; otherwise, false, or null to leave unmodified.

relative_search_range class-attribute instance-attribute #

relative_search_range: Optional[float] = message_field(10, wraps=TYPE_DOUBLE)

The relative search range in units of the Z drive (unit: m), or null to leave unmodified.

lower_limit class-attribute instance-attribute #

lower_limit: Optional[float] = message_field(11, wraps=TYPE_DOUBLE)

The lower search range limit in units of the Z drive (unit: m), or null to leave unmodified.

upper_limit class-attribute instance-attribute #

upper_limit: Optional[float] = message_field(12, wraps=TYPE_DOUBLE)

The upper limit in units of the Z drive (unit: m), or null to leave unmodified.

ExperimentSwAutofocusServiceSetAutofocusParametersResponse dataclass #

ExperimentSwAutofocusServiceSetAutofocusParametersResponse()

Bases: Message

The ExperimentSwAutofocusServiceSetAutofocusParametersResponse class.

Position3D dataclass #

Position3D(x: float = betterproto.double_field(1), y: float = betterproto.double_field(2), z: float = betterproto.double_field(3))

Bases: Message

A position in three dimensions (XYZ).

Attributes:

  • x (float) –

    The X position (unit: m).

  • y (float) –

    The Y position (unit: m).

  • z (float) –

    The Z position (unit: m).

x class-attribute instance-attribute #

x: float = double_field(1)

The X position (unit: m).

y class-attribute instance-attribute #

y: float = double_field(2)

The Y position (unit: m).

z class-attribute instance-attribute #

z: float = double_field(3)

The Z position (unit: m).

TilesServiceAddEllipseTileRegionRequest dataclass #

TilesServiceAddEllipseTileRegionRequest(experiment_id: str = betterproto.string_field(1), center_x: Optional[float] = betterproto.message_field(2, wraps=(betterproto.TYPE_DOUBLE)), center_y: Optional[float] = betterproto.message_field(3, wraps=(betterproto.TYPE_DOUBLE)), width: Optional[float] = betterproto.message_field(4, wraps=(betterproto.TYPE_DOUBLE)), height: Optional[float] = betterproto.message_field(5, wraps=(betterproto.TYPE_DOUBLE)), z: Optional[float] = betterproto.message_field(6, wraps=(betterproto.TYPE_DOUBLE)))

Bases: Message

The TilesServiceAddEllipseTileRegionRequest class.

Attributes:

  • experiment_id (str) –

    The experiment Id.

  • center_x (Optional[float]) –

    The center x position of the tile region to be added (unit: m).

  • center_y (Optional[float]) –

    The center y position of the tile region to be added (unit: m).

  • width (Optional[float]) –

    The width of the tile region to be added (unit: m).

  • height (Optional[float]) –

    The height of the tile region to be added (unit: m).

  • z (Optional[float]) –

    The z position of the tile region to be added (unit: m).

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

The experiment Id.

center_x class-attribute instance-attribute #

center_x: Optional[float] = message_field(2, wraps=TYPE_DOUBLE)

The center x position of the tile region to be added (unit: m).

center_y class-attribute instance-attribute #

center_y: Optional[float] = message_field(3, wraps=TYPE_DOUBLE)

The center y position of the tile region to be added (unit: m).

width class-attribute instance-attribute #

width: Optional[float] = message_field(4, wraps=TYPE_DOUBLE)

The width of the tile region to be added (unit: m).

height class-attribute instance-attribute #

height: Optional[float] = message_field(5, wraps=TYPE_DOUBLE)

The height of the tile region to be added (unit: m).

z class-attribute instance-attribute #

z: Optional[float] = message_field(6, wraps=TYPE_DOUBLE)

The z position of the tile region to be added (unit: m).

TilesServiceAddEllipseTileRegionResponse dataclass #

TilesServiceAddEllipseTileRegionResponse()

Bases: Message

The TilesServiceAddEllipseTileRegionResponse class.

TilesServiceAddPolygonTileRegionRequest dataclass #

TilesServiceAddPolygonTileRegionRequest(experiment_id: str = betterproto.string_field(1), polygon_points: List[DoublePoint] = betterproto.message_field(2), z: Optional[float] = betterproto.message_field(3, wraps=(betterproto.TYPE_DOUBLE)))

Bases: Message

The TilesServiceAddPolygonTileRegionRequest class.

Attributes:

  • experiment_id (str) –

    The experiment Id.

  • polygon_points (List[DoublePoint]) –

    The list of points which define the polygon.

  • z (Optional[float]) –

    The z position of the tile region to be added (unit: m).

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

The experiment Id.

polygon_points class-attribute instance-attribute #

polygon_points: List[DoublePoint] = message_field(2)

The list of points which define the polygon. This list has to contain at least one point (unit: m).

z class-attribute instance-attribute #

z: Optional[float] = message_field(3, wraps=TYPE_DOUBLE)

The z position of the tile region to be added (unit: m).

TilesServiceAddPolygonTileRegionResponse dataclass #

TilesServiceAddPolygonTileRegionResponse()

Bases: Message

The TilesServiceAddPolygonTileRegionResponse class.

TilesServiceAddPositionsRequest dataclass #

TilesServiceAddPositionsRequest(experiment_id: str = betterproto.string_field(1), positions: List[Position3D] = betterproto.message_field(2))

Bases: Message

The TilesServiceAddPositionsRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

The experiment Id.

positions class-attribute instance-attribute #

positions: List[Position3D] = message_field(2)

The positions to be added.

TilesServiceAddPositionsResponse dataclass #

TilesServiceAddPositionsResponse()

Bases: Message

The TilesServiceAddPositionsResponse class.

TilesServiceAddRectangleTileRegionRequest dataclass #

TilesServiceAddRectangleTileRegionRequest(experiment_id: str = betterproto.string_field(1), center_x: Optional[float] = betterproto.message_field(2, wraps=(betterproto.TYPE_DOUBLE)), center_y: Optional[float] = betterproto.message_field(3, wraps=(betterproto.TYPE_DOUBLE)), width: Optional[float] = betterproto.message_field(4, wraps=(betterproto.TYPE_DOUBLE)), height: Optional[float] = betterproto.message_field(5, wraps=(betterproto.TYPE_DOUBLE)), z: Optional[float] = betterproto.message_field(6, wraps=(betterproto.TYPE_DOUBLE)))

Bases: Message

The TilesServiceAddRectangleTileRegionRequest class.

Attributes:

  • experiment_id (str) –

    Experiment id.

  • center_x (Optional[float]) –

    The center x position of the tile region to be added (unit: m).

  • center_y (Optional[float]) –

    The center y position of the tile region to be added (unit: m).

  • width (Optional[float]) –

    The width of the tile region to be added (unit: m).

  • height (Optional[float]) –

    The height of the tile region to be added (unit: m).

  • z (Optional[float]) –

    The z position of the tile region to be added (unit: m).

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

Experiment id.

center_x class-attribute instance-attribute #

center_x: Optional[float] = message_field(2, wraps=TYPE_DOUBLE)

The center x position of the tile region to be added (unit: m).

center_y class-attribute instance-attribute #

center_y: Optional[float] = message_field(3, wraps=TYPE_DOUBLE)

The center y position of the tile region to be added (unit: m).

width class-attribute instance-attribute #

width: Optional[float] = message_field(4, wraps=TYPE_DOUBLE)

The width of the tile region to be added (unit: m).

height class-attribute instance-attribute #

height: Optional[float] = message_field(5, wraps=TYPE_DOUBLE)

The height of the tile region to be added (unit: m).

z class-attribute instance-attribute #

z: Optional[float] = message_field(6, wraps=TYPE_DOUBLE)

The z position of the tile region to be added (unit: m).

TilesServiceAddRectangleTileRegionResponse dataclass #

TilesServiceAddRectangleTileRegionResponse()

Bases: Message

The TilesServiceAddRectangleTileRegionResponse class.

TilesServiceClearRequest dataclass #

TilesServiceClearRequest(experiment_id: str = betterproto.string_field(1))

Bases: Message

The TilesServiceClearRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

Experiment id.

TilesServiceClearResponse dataclass #

TilesServiceClearResponse()

Bases: Message

The TilesServiceClearResponse class.

TilesServiceIsTilesExperimentRequest dataclass #

TilesServiceIsTilesExperimentRequest(experiment_id: str = betterproto.string_field(1))

Bases: Message

The TilesServiceIsTilesExperimentRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

Experiment id.

TilesServiceIsTilesExperimentResponse dataclass #

TilesServiceIsTilesExperimentResponse(is_tiles_experiment: bool = betterproto.bool_field(1))

Bases: Message

Response object representing the value of IsTiles for the experiment.

Attributes:

  • is_tiles_experiment (bool) –

    A value indicating whether the experiment is a tiles experiment.

is_tiles_experiment class-attribute instance-attribute #

is_tiles_experiment: bool = bool_field(1)

A value indicating whether the experiment is a tiles experiment.

TrackInfo dataclass #

TrackInfo(is_activated: bool = betterproto.bool_field(1), channels: List[ChannelInfo] = betterproto.message_field(2))

Bases: Message

Information about a track.

Attributes:

is_activated class-attribute instance-attribute #

is_activated: bool = bool_field(1)

A value indicating whether the track is activated.

channels class-attribute instance-attribute #

channels: List[ChannelInfo] = message_field(2)

The info for all channels in the track.

TrackServiceActivateChannelRequest dataclass #

TrackServiceActivateChannelRequest(experiment_id: str = betterproto.string_field(1), track_index: int = betterproto.int32_field(2), channel_index: int = betterproto.int32_field(3))

Bases: Message

The TrackServiceActivateChannelRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

Experiment id.

track_index class-attribute instance-attribute #

track_index: int = int32_field(2)

An index of a track.

channel_index class-attribute instance-attribute #

channel_index: int = int32_field(3)

An index of a channel in the track to be activated.

TrackServiceActivateChannelResponse dataclass #

TrackServiceActivateChannelResponse()

Bases: Message

The TrackServiceActivateChannelResponse class.

TrackServiceActivateTrackRequest dataclass #

TrackServiceActivateTrackRequest(experiment_id: str = betterproto.string_field(1), track_index: int = betterproto.int32_field(2))

Bases: Message

The TrackServiceActivateTrackRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

Experiment id.

track_index class-attribute instance-attribute #

track_index: int = int32_field(2)

An index of a track to be activated.

TrackServiceActivateTrackResponse dataclass #

TrackServiceActivateTrackResponse()

Bases: Message

The TrackServiceActivateTrackResponse class.

TrackServiceDeactivateChannelRequest dataclass #

TrackServiceDeactivateChannelRequest(experiment_id: str = betterproto.string_field(1), track_index: int = betterproto.int32_field(2), channel_index: int = betterproto.int32_field(3))

Bases: Message

The TrackServiceDeactivateChannelRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

Experiment id.

track_index class-attribute instance-attribute #

track_index: int = int32_field(2)

An index of a track.

channel_index class-attribute instance-attribute #

channel_index: int = int32_field(3)

An index of a channel in the track to be deactivated.

TrackServiceDeactivateChannelResponse dataclass #

TrackServiceDeactivateChannelResponse()

Bases: Message

The TrackServiceDeactivateChannelResponse class.

TrackServiceDeactivateTrackRequest dataclass #

TrackServiceDeactivateTrackRequest(experiment_id: str = betterproto.string_field(1), track_index: int = betterproto.int32_field(2))

Bases: Message

The TrackServiceDeactivateTrackRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

Experiment id.

track_index class-attribute instance-attribute #

track_index: int = int32_field(2)

An index of a track to be deactivated.

TrackServiceDeactivateTrackResponse dataclass #

TrackServiceDeactivateTrackResponse()

Bases: Message

The TrackServiceDeactivateTrackResponse class.

TrackServiceGetTrackInfoRequest dataclass #

TrackServiceGetTrackInfoRequest(experiment_id: str = betterproto.string_field(1))

Bases: Message

The TrackServiceGetTrackInfoRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

Experiment id.

TrackServiceGetTrackInfoResponse dataclass #

TrackServiceGetTrackInfoResponse(track_info: List[TrackInfo] = betterproto.message_field(1))

Bases: Message

Response object representing the value of track information.

Attributes:

track_info class-attribute instance-attribute #

track_info: List[TrackInfo] = message_field(1)

The track information.

ZStackServiceGetZStackInfoRequest dataclass #

ZStackServiceGetZStackInfoRequest(experiment_id: str = betterproto.string_field(1))

Bases: Message

The ZStackServiceGetZStackInfoRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

The experiment Id.

ZStackServiceGetZStackInfoResponse dataclass #

ZStackServiceGetZStackInfoResponse(interval: float = betterproto.double_field(1), first_slice: float = betterproto.double_field(2), last_slice: float = betterproto.double_field(3), range: float = betterproto.double_field(5), num_slices: int = betterproto.int32_field(6), is_center_mode: bool = betterproto.bool_field(7), offset: float = betterproto.double_field(8))

Bases: Message

Response object representing the value of GetZStackInfo for the experiment.

Attributes:

  • interval (float) –

    The value of the interval between 2 slices (unit: m).

  • first_slice (float) –

    The position of the first slice in Z-stack (unit: m).

  • last_slice (float) –

    The position of the last slice in Z-stack (unit: m).

  • range (float) –

    The distance between the first and last slice (unit: m).

  • num_slices (int) –

    The number of slices.

  • is_center_mode (bool) –

    A value indicating whether the Z-stack is in center mode.

  • offset (float) –

    The value of the offset which is applied to the whole Z-stack.

interval class-attribute instance-attribute #

interval: float = double_field(1)

The value of the interval between 2 slices (unit: m).

first_slice class-attribute instance-attribute #

first_slice: float = double_field(2)

The position of the first slice in Z-stack (unit: m).

last_slice class-attribute instance-attribute #

last_slice: float = double_field(3)

The position of the last slice in Z-stack (unit: m).

range class-attribute instance-attribute #

range: float = double_field(5)

The distance between the first and last slice (unit: m).

num_slices class-attribute instance-attribute #

num_slices: int = int32_field(6)

The number of slices.

is_center_mode class-attribute instance-attribute #

is_center_mode: bool = bool_field(7)

A value indicating whether the Z-stack is in center mode.

offset class-attribute instance-attribute #

offset: float = double_field(8)

The value of the offset which is applied to the whole Z-stack.

ZStackServiceIsZStackExperimentRequest dataclass #

ZStackServiceIsZStackExperimentRequest(experiment_id: str = betterproto.string_field(1))

Bases: Message

The ZStackServiceIsZStackExperimentRequest class.

Attributes:

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

The experiment Id.

ZStackServiceIsZStackExperimentResponse dataclass #

ZStackServiceIsZStackExperimentResponse(is_zstack_experiment: bool = betterproto.bool_field(1))

Bases: Message

Response object representing the value of IsZStackExperiment for the experiment.

Attributes:

  • is_zstack_experiment (bool) –

    A value indicating whether the experiment is a Z-Stack experiment.

is_zstack_experiment class-attribute instance-attribute #

is_zstack_experiment: bool = bool_field(1)

A value indicating whether the experiment is a Z-Stack experiment.

ZStackServiceModifyZStackCenterRangeRequest dataclass #

ZStackServiceModifyZStackCenterRangeRequest(experiment_id: str = betterproto.string_field(1), center: Optional[float] = betterproto.message_field(2, wraps=(betterproto.TYPE_DOUBLE)), interval: Optional[float] = betterproto.message_field(3, wraps=(betterproto.TYPE_DOUBLE)), range: Optional[float] = betterproto.message_field(4, wraps=(betterproto.TYPE_DOUBLE)))

Bases: Message

The ZStackServiceModifyZStackCenterRangeRequest class.

Attributes:

  • experiment_id (str) –

    The experiment Id.

  • center (Optional[float]) –

    The center position between the first and last slice (unit: m).

  • interval (Optional[float]) –

    The interval between 2 slices (unit: m).

  • range (Optional[float]) –

    Distance between the first and last slice (unit: m).

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

The experiment Id.

center class-attribute instance-attribute #

center: Optional[float] = message_field(2, wraps=TYPE_DOUBLE)

The center position between the first and last slice (unit: m).

interval class-attribute instance-attribute #

interval: Optional[float] = message_field(3, wraps=TYPE_DOUBLE)

The interval between 2 slices (unit: m).

range class-attribute instance-attribute #

range: Optional[float] = message_field(4, wraps=TYPE_DOUBLE)

Distance between the first and last slice (unit: m).

ZStackServiceModifyZStackCenterRangeResponse dataclass #

ZStackServiceModifyZStackCenterRangeResponse()

Bases: Message

The ZStackServiceModifyZStackCenterRangeResponse class.

ZStackServiceModifyZStackFirstLastRequest dataclass #

ZStackServiceModifyZStackFirstLastRequest(experiment_id: str = betterproto.string_field(1), first: Optional[float] = betterproto.message_field(2, wraps=(betterproto.TYPE_DOUBLE)), last: Optional[float] = betterproto.message_field(3, wraps=(betterproto.TYPE_DOUBLE)), interval: Optional[float] = betterproto.message_field(4, wraps=(betterproto.TYPE_DOUBLE)))

Bases: Message

The ZStackServiceModifyZStackFirstLastRequest class.

Attributes:

  • experiment_id (str) –

    The experiment Id.

  • first (Optional[float]) –

    Position of the first slice in Z-stack (unit: m).

  • last (Optional[float]) –

    Position of the last slice in Z-stack (unit: m).

  • interval (Optional[float]) –

    The interval between 2 slices (unit: m).

experiment_id class-attribute instance-attribute #

experiment_id: str = string_field(1)

The experiment Id.

first class-attribute instance-attribute #

first: Optional[float] = message_field(2, wraps=TYPE_DOUBLE)

Position of the first slice in Z-stack (unit: m).

last class-attribute instance-attribute #

last: Optional[float] = message_field(3, wraps=TYPE_DOUBLE)

Position of the last slice in Z-stack (unit: m).

interval class-attribute instance-attribute #

interval: Optional[float] = message_field(4, wraps=TYPE_DOUBLE)

The interval between 2 slices (unit: m).

ZStackServiceModifyZStackFirstLastResponse dataclass #

ZStackServiceModifyZStackFirstLastResponse()

Bases: Message

The ZStackServiceModifyZStackFirstLastResponse class.