lm.hardware.v1#
zen_api.lm.hardware.v1
#
Classes:
-
ConfiguredContainerInfo–Contains the information about a configured container in an experiment.
-
FocusServiceGetAccelerationRequest–The FocusServiceGetAccelerationRequest class.
-
FocusServiceGetAccelerationResponse–Acceleration of the focus in %.
-
FocusServiceGetPositionRequest–The FocusServiceGetPositionRequest class.
-
FocusServiceGetPositionResponse–Position of the focus in µm.
-
FocusServiceGetSpeedRequest–The FocusServiceGetSpeedRequest class.
-
FocusServiceGetSpeedResponse–Speed of the focus in %.
-
FocusServiceMoveToRequest–The FocusServiceMoveToRequest class.
-
FocusServiceMoveToResponse–Describes the result of a Focus.MoveTo request.
-
FocusServiceSetAccelerationRequest–The FocusServiceSetAccelerationRequest class.
-
FocusServiceSetAccelerationResponse–The FocusServiceSetAccelerationResponse class.
-
FocusServiceSetSpeedRequest–The FocusServiceSetSpeedRequest class.
-
FocusServiceSetSpeedResponse–The FocusServiceSetSpeedResponse class.
-
FocusServiceStopRequest–The FocusServiceStopRequest class.
-
FocusServiceStopResponse–The FocusServiceStopResponse class.
-
SampleCarrierServiceActivateContainerRangeRequest–The SampleCarrierServiceActivateContainerRangeRequest class.
-
SampleCarrierServiceActivateContainerRangeResponse–The SampleCarrierServiceActivateContainerRangeResponse class.
-
SampleCarrierServiceActivateContainerRequest–The SampleCarrierServiceActivateContainerRequest class.
-
SampleCarrierServiceActivateContainerResponse–The SampleCarrierServiceActivateContainerResponse class.
-
SampleCarrierServiceActivateContainersRequest–The SampleCarrierServiceActivateContainersRequest class.
-
SampleCarrierServiceActivateContainersResponse–The SampleCarrierServiceActivateContainersResponse class.
-
SampleCarrierServiceDeactivateContainerRangeRequest–The SampleCarrierServiceDeactivateContainerRangeRequest class.
-
SampleCarrierServiceDeactivateContainerRangeResponse–The SampleCarrierServiceDeactivateContainerRangeResponse class.
-
SampleCarrierServiceDeactivateContainerRequest–The SampleCarrierServiceDeactivateContainerRequest class.
-
SampleCarrierServiceDeactivateContainerResponse–The SampleCarrierServiceDeactivateContainerResponse class.
-
SampleCarrierServiceDeactivateContainersRequest–The SampleCarrierServiceDeactivateContainersRequest class.
-
SampleCarrierServiceDeactivateContainersResponse–The SampleCarrierServiceDeactivateContainersResponse class.
-
SampleCarrierServiceGetConfiguredContainersRequest–The SampleCarrierServiceGetConfiguredContainersRequest class.
-
SampleCarrierServiceGetConfiguredContainersResponse–Contains the information about the configured containers in an experiment.
-
SampleCarrierServiceGetCurrentContainerRequest–The SampleCarrierServiceGetCurrentContainerRequest class.
-
SampleCarrierServiceGetCurrentContainerResponse–Contains the information in which container of the sample carrier the stage is positioned at.
-
SampleCarrierServiceGetInfoRequest–The SampleCarrierServiceGetInfoRequest class.
-
SampleCarrierServiceGetInfoResponse–Contains the sample carrier information.
-
SampleCarrierServiceMoveToContainerRequest–The SampleCarrierServiceMoveToContainerRequest class.
-
SampleCarrierServiceMoveToContainerResponse–The SampleCarrierServiceMoveToContainerResponse class.
-
FocusServiceStub– -
SampleCarrierServiceStub– -
FocusServiceBase– -
SampleCarrierServiceBase–
ConfiguredContainerInfo
dataclass
#
ConfiguredContainerInfo(container_name: str = betterproto.string_field(1), is_activated: bool = betterproto.bool_field(2))
Bases: Message
Contains the information about a configured container in an experiment.
Attributes:
-
container_name(str) –The name of the container (e.g., "B1").
-
is_activated(bool) –A value indicating whether the container is activated or not.
container_name
class-attribute
instance-attribute
#
container_name: str = betterproto.string_field(1)
The name of the container (e.g., "B1").
is_activated
class-attribute
instance-attribute
#
is_activated: bool = betterproto.bool_field(2)
A value indicating whether the container is activated or not.
FocusServiceGetAccelerationRequest
dataclass
#
FocusServiceGetAccelerationRequest()
Bases: Message
The FocusServiceGetAccelerationRequest class.
FocusServiceGetAccelerationResponse
dataclass
#
FocusServiceGetAccelerationResponse(value: float = betterproto.double_field(1))
FocusServiceGetPositionRequest
dataclass
#
FocusServiceGetPositionRequest()
Bases: Message
The FocusServiceGetPositionRequest class.
FocusServiceGetPositionResponse
dataclass
#
FocusServiceGetPositionResponse(value: float = betterproto.double_field(1))
FocusServiceGetSpeedRequest
dataclass
#
FocusServiceGetSpeedRequest()
Bases: Message
The FocusServiceGetSpeedRequest class.
FocusServiceGetSpeedResponse
dataclass
#
FocusServiceGetSpeedResponse(value: float = betterproto.double_field(1))
FocusServiceMoveToRequest
dataclass
#
FocusServiceMoveToRequest(value: float = betterproto.double_field(1))
FocusServiceMoveToResponse
dataclass
#
FocusServiceMoveToResponse(position_changed: bool = betterproto.bool_field(1))
Bases: Message
Describes the result of a Focus.MoveTo request.
Attributes:
-
position_changed(bool) –A value indicating whether the position was changed.
position_changed
class-attribute
instance-attribute
#
position_changed: bool = betterproto.bool_field(1)
A value indicating whether the position was changed.
FocusServiceSetAccelerationRequest
dataclass
#
FocusServiceSetAccelerationRequest(acceleration: float = betterproto.double_field(1))
Bases: Message
The FocusServiceSetAccelerationRequest class.
Attributes:
-
acceleration(float) –Acceleration in percent, i.e. values from range [0;100].
acceleration
class-attribute
instance-attribute
#
acceleration: float = betterproto.double_field(1)
Acceleration in percent, i.e. values from range [0;100].
FocusServiceSetAccelerationResponse
dataclass
#
FocusServiceSetAccelerationResponse()
Bases: Message
The FocusServiceSetAccelerationResponse class.
FocusServiceSetSpeedRequest
dataclass
#
FocusServiceSetSpeedRequest(speed: float = betterproto.double_field(1))
FocusServiceSetSpeedResponse
dataclass
#
FocusServiceSetSpeedResponse()
Bases: Message
The FocusServiceSetSpeedResponse class.
FocusServiceStopRequest
dataclass
#
FocusServiceStopRequest()
Bases: Message
The FocusServiceStopRequest class.
FocusServiceStopResponse
dataclass
#
FocusServiceStopResponse()
Bases: Message
The FocusServiceStopResponse class.
SampleCarrierServiceActivateContainerRangeRequest
dataclass
#
SampleCarrierServiceActivateContainerRangeRequest(experiment_id: str = betterproto.string_field(1), start_container_name: str = betterproto.string_field(2), end_container_name: str = betterproto.string_field(3))
Bases: Message
The SampleCarrierServiceActivateContainerRangeRequest class.
Attributes:
-
experiment_id(str) –Experiment ID.
-
start_container_name(str) –Name of the container where the range starts (e.g., "C3").
-
end_container_name(str) –Name of the container where the range ends (e.g., "D8").
experiment_id
class-attribute
instance-attribute
#
experiment_id: str = betterproto.string_field(1)
Experiment ID.
start_container_name
class-attribute
instance-attribute
#
start_container_name: str = betterproto.string_field(2)
Name of the container where the range starts (e.g., "C3").
end_container_name
class-attribute
instance-attribute
#
end_container_name: str = betterproto.string_field(3)
Name of the container where the range ends (e.g., "D8").
SampleCarrierServiceActivateContainerRangeResponse
dataclass
#
SampleCarrierServiceActivateContainerRangeResponse()
Bases: Message
The SampleCarrierServiceActivateContainerRangeResponse class.
SampleCarrierServiceActivateContainerRequest
dataclass
#
SampleCarrierServiceActivateContainerRequest(experiment_id: str = betterproto.string_field(1), container_name: str = betterproto.string_field(2))
Bases: Message
The SampleCarrierServiceActivateContainerRequest class.
Attributes:
-
experiment_id(str) –Experiment ID.
-
container_name(str) –Name of the container (e.g., "B1").
SampleCarrierServiceActivateContainerResponse
dataclass
#
SampleCarrierServiceActivateContainerResponse()
Bases: Message
The SampleCarrierServiceActivateContainerResponse class.
SampleCarrierServiceActivateContainersRequest
dataclass
#
SampleCarrierServiceActivateContainersRequest(experiment_id: str = betterproto.string_field(1), container_names: List[str] = betterproto.string_field(2))
Bases: Message
The SampleCarrierServiceActivateContainersRequest class.
Attributes:
-
experiment_id(str) –Experiment ID.
-
container_names(List[str]) –Names of the containers (e.g., ["A1", "A2", "B7"]).
SampleCarrierServiceActivateContainersResponse
dataclass
#
SampleCarrierServiceActivateContainersResponse()
Bases: Message
The SampleCarrierServiceActivateContainersResponse class.
SampleCarrierServiceDeactivateContainerRangeRequest
dataclass
#
SampleCarrierServiceDeactivateContainerRangeRequest(experiment_id: str = betterproto.string_field(1), start_container_name: str = betterproto.string_field(2), end_container_name: str = betterproto.string_field(3))
Bases: Message
The SampleCarrierServiceDeactivateContainerRangeRequest class.
Attributes:
-
experiment_id(str) –Experiment ID.
-
start_container_name(str) –Name of the container where the range starts (e.g., "C3").
-
end_container_name(str) –Name of the container where the range ends (e.g., "D8").
experiment_id
class-attribute
instance-attribute
#
experiment_id: str = betterproto.string_field(1)
Experiment ID.
start_container_name
class-attribute
instance-attribute
#
start_container_name: str = betterproto.string_field(2)
Name of the container where the range starts (e.g., "C3").
end_container_name
class-attribute
instance-attribute
#
end_container_name: str = betterproto.string_field(3)
Name of the container where the range ends (e.g., "D8").
SampleCarrierServiceDeactivateContainerRangeResponse
dataclass
#
SampleCarrierServiceDeactivateContainerRangeResponse()
Bases: Message
The SampleCarrierServiceDeactivateContainerRangeResponse class.
SampleCarrierServiceDeactivateContainerRequest
dataclass
#
SampleCarrierServiceDeactivateContainerRequest(experiment_id: str = betterproto.string_field(1), container_name: str = betterproto.string_field(2))
Bases: Message
The SampleCarrierServiceDeactivateContainerRequest class.
Attributes:
-
experiment_id(str) –Experiment ID.
-
container_name(str) –Name of the container (e.g., "B1").
SampleCarrierServiceDeactivateContainerResponse
dataclass
#
SampleCarrierServiceDeactivateContainerResponse()
Bases: Message
The SampleCarrierServiceDeactivateContainerResponse class.
SampleCarrierServiceDeactivateContainersRequest
dataclass
#
SampleCarrierServiceDeactivateContainersRequest(experiment_id: str = betterproto.string_field(1), container_names: List[str] = betterproto.string_field(2))
Bases: Message
The SampleCarrierServiceDeactivateContainersRequest class.
Attributes:
-
experiment_id(str) –Experiment ID.
-
container_names(List[str]) –Names of the containers (e.g., ["A1", "A2", "B7"]).
SampleCarrierServiceDeactivateContainersResponse
dataclass
#
SampleCarrierServiceDeactivateContainersResponse()
Bases: Message
The SampleCarrierServiceDeactivateContainersResponse class.
SampleCarrierServiceGetConfiguredContainersRequest
dataclass
#
SampleCarrierServiceGetConfiguredContainersRequest(experiment_id: str = betterproto.string_field(1))
Bases: Message
The SampleCarrierServiceGetConfiguredContainersRequest class.
Attributes:
-
experiment_id(str) –Experiment ID.
experiment_id
class-attribute
instance-attribute
#
experiment_id: str = betterproto.string_field(1)
Experiment ID.
SampleCarrierServiceGetConfiguredContainersResponse
dataclass
#
SampleCarrierServiceGetConfiguredContainersResponse(configured_containers: List[ConfiguredContainerInfo] = betterproto.message_field(1))
Bases: Message
Contains the information about the configured containers in an experiment.
Attributes:
-
configured_containers(List[ConfiguredContainerInfo]) –The information about the configured containers in an experiment.
configured_containers
class-attribute
instance-attribute
#
configured_containers: List[ConfiguredContainerInfo] = betterproto.message_field(1)
The information about the configured containers in an experiment.
SampleCarrierServiceGetCurrentContainerRequest
dataclass
#
SampleCarrierServiceGetCurrentContainerRequest()
Bases: Message
The SampleCarrierServiceGetCurrentContainerRequest class.
SampleCarrierServiceGetCurrentContainerResponse
dataclass
#
SampleCarrierServiceGetCurrentContainerResponse(row_index: int = betterproto.int32_field(1), column_index: int = betterproto.int32_field(2))
Bases: Message
Contains the information in which container of the sample carrier the stage is positioned at.
Attributes:
-
row_index(int) –The row index of the container in the sample carrier (starts with index 0).
-
column_index(int) –The column index of the container in the sample carrier (starts with index 0).
row_index
class-attribute
instance-attribute
#
row_index: int = betterproto.int32_field(1)
The row index of the container in the sample carrier (starts with index 0).
column_index
class-attribute
instance-attribute
#
column_index: int = betterproto.int32_field(2)
The column index of the container in the sample carrier (starts with index 0).
SampleCarrierServiceGetInfoRequest
dataclass
#
SampleCarrierServiceGetInfoRequest()
Bases: Message
The SampleCarrierServiceGetInfoRequest class.
SampleCarrierServiceGetInfoResponse
dataclass
#
SampleCarrierServiceGetInfoResponse(rows: int = betterproto.int32_field(1), columns: int = betterproto.int32_field(2), name: str = betterproto.string_field(3), material: str = betterproto.string_field(4), thickness: float = betterproto.double_field(5), skirt: float = betterproto.double_field(6), refractive_index: float = betterproto.double_field(7))
Bases: Message
Contains the sample carrier information.
Attributes:
-
rows(int) –The number of rows in the sample carrier.
-
columns(int) –The number of columns in the sample carrier.
-
name(str) –The name of the sample carrier.
-
material(str) –The bottom material which is used for this sample carrier.
-
thickness(float) –The bottom thickness of this sample carrier (in meters).
-
skirt(float) –The skirt (i.e. bottom offset) of this sample carrier (in meters).
-
refractive_index(float) –The refractive index of the bottom material of this sample carrier.
rows
class-attribute
instance-attribute
#
rows: int = betterproto.int32_field(1)
The number of rows in the sample carrier.
columns
class-attribute
instance-attribute
#
columns: int = betterproto.int32_field(2)
The number of columns in the sample carrier.
name
class-attribute
instance-attribute
#
name: str = betterproto.string_field(3)
The name of the sample carrier.
material
class-attribute
instance-attribute
#
material: str = betterproto.string_field(4)
The bottom material which is used for this sample carrier.
thickness
class-attribute
instance-attribute
#
thickness: float = betterproto.double_field(5)
The bottom thickness of this sample carrier (in meters).
skirt
class-attribute
instance-attribute
#
skirt: float = betterproto.double_field(6)
The skirt (i.e. bottom offset) of this sample carrier (in meters).
refractive_index
class-attribute
instance-attribute
#
refractive_index: float = betterproto.double_field(7)
The refractive index of the bottom material of this sample carrier.
SampleCarrierServiceMoveToContainerRequest
dataclass
#
SampleCarrierServiceMoveToContainerRequest(row_index: int = betterproto.int32_field(1), column_index: int = betterproto.int32_field(2))
Bases: Message
The SampleCarrierServiceMoveToContainerRequest class.
Attributes:
-
row_index(int) –The row index of the container (starts with index 0).
-
column_index(int) –The column index of the container (starts with index 0).
SampleCarrierServiceMoveToContainerResponse
dataclass
#
SampleCarrierServiceMoveToContainerResponse()
Bases: Message
The SampleCarrierServiceMoveToContainerResponse class.
FocusServiceStub
#
Bases: ServiceStub
Methods:
-
get_acceleration–Gets the focus acceleration.
-
get_position–Gets the focus position.
-
get_speed–Gets the focus speed.
-
move_to–Moves the focus to the given position in µm.
-
set_acceleration–Sets the acceleration of the focus in percent.
-
set_speed–Sets the speed of the focus in percent.
-
stop–Stops the focus if it is moving.
get_acceleration
async
#
get_acceleration(focus_service_get_acceleration_request: FocusServiceGetAccelerationRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> FocusServiceGetAccelerationResponse
Gets the focus acceleration.
get_position
async
#
get_position(focus_service_get_position_request: FocusServiceGetPositionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> FocusServiceGetPositionResponse
Gets the focus position.
get_speed
async
#
get_speed(focus_service_get_speed_request: FocusServiceGetSpeedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> FocusServiceGetSpeedResponse
Gets the focus speed.
move_to
async
#
move_to(focus_service_move_to_request: FocusServiceMoveToRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> FocusServiceMoveToResponse
Moves the focus to the given position in µm.
set_acceleration
async
#
set_acceleration(focus_service_set_acceleration_request: FocusServiceSetAccelerationRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> FocusServiceSetAccelerationResponse
Sets the acceleration of the focus in percent.
set_speed
async
#
set_speed(focus_service_set_speed_request: FocusServiceSetSpeedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> FocusServiceSetSpeedResponse
Sets the speed of the focus in percent.
stop
async
#
stop(focus_service_stop_request: FocusServiceStopRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> FocusServiceStopResponse
Stops the focus if it is moving.
SampleCarrierServiceStub
#
Bases: ServiceStub
Methods:
-
activate_container–Activates a tile region or position that is placed in the specified container.
-
activate_container_range–Activates all tile regions and/or positions that are placed in the specified container range
-
activate_containers–Activates all tile regions and/or positions that are placed in the specified containers
-
deactivate_container–Deactivates a tile region or position that is placed in the specified container.
-
deactivate_container_range–Deactivates all tile regions and/or positions that are placed in the specified container
-
deactivate_containers–Deactivates all tile regions and/or positions that are placed in the specified containers
-
get_configured_containers–Gets the information about the configured containers in an experiment.
-
get_current_container–Gets the information in which container of the sample carrier the stage is positioned at.
-
get_info–Gets the information of the currently inserted sample carrier.
-
move_to_container–Move the stage to a sample holder container.
activate_container
async
#
activate_container(sample_carrier_service_activate_container_request: SampleCarrierServiceActivateContainerRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SampleCarrierServiceActivateContainerResponse
Activates a tile region or position that is placed in the specified container.
activate_container_range
async
#
activate_container_range(sample_carrier_service_activate_container_range_request: SampleCarrierServiceActivateContainerRangeRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SampleCarrierServiceActivateContainerRangeResponse
Activates all tile regions and/or positions that are placed in the specified container range (e.g., "C3-D8").
activate_containers
async
#
activate_containers(sample_carrier_service_activate_containers_request: SampleCarrierServiceActivateContainersRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SampleCarrierServiceActivateContainersResponse
Activates all tile regions and/or positions that are placed in the specified containers (e.g., ["A1", "A2", "B7"]).
deactivate_container
async
#
deactivate_container(sample_carrier_service_deactivate_container_request: SampleCarrierServiceDeactivateContainerRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SampleCarrierServiceDeactivateContainerResponse
Deactivates a tile region or position that is placed in the specified container.
deactivate_container_range
async
#
deactivate_container_range(sample_carrier_service_deactivate_container_range_request: SampleCarrierServiceDeactivateContainerRangeRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SampleCarrierServiceDeactivateContainerRangeResponse
Deactivates all tile regions and/or positions that are placed in the specified container range (e.g., "C3-D8").
deactivate_containers
async
#
deactivate_containers(sample_carrier_service_deactivate_containers_request: SampleCarrierServiceDeactivateContainersRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SampleCarrierServiceDeactivateContainersResponse
Deactivates all tile regions and/or positions that are placed in the specified containers (e.g., ["A1", "A2", "B7"]).
get_configured_containers
async
#
get_configured_containers(sample_carrier_service_get_configured_containers_request: SampleCarrierServiceGetConfiguredContainersRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SampleCarrierServiceGetConfiguredContainersResponse
Gets the information about the configured containers in an experiment.
get_current_container
async
#
get_current_container(sample_carrier_service_get_current_container_request: SampleCarrierServiceGetCurrentContainerRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SampleCarrierServiceGetCurrentContainerResponse
Gets the information in which container of the sample carrier the stage is positioned at. Note that the stage might not be positioned exactly in the center of the container.
get_info
async
#
get_info(sample_carrier_service_get_info_request: SampleCarrierServiceGetInfoRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SampleCarrierServiceGetInfoResponse
Gets the information of the currently inserted sample carrier.
move_to_container
async
#
move_to_container(sample_carrier_service_move_to_container_request: SampleCarrierServiceMoveToContainerRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SampleCarrierServiceMoveToContainerResponse
Move the stage to a sample holder container.
FocusServiceBase
#
Bases: ServiceBase
Methods:
-
get_acceleration–Gets the focus acceleration.
-
get_position–Gets the focus position.
-
get_speed–Gets the focus speed.
-
move_to–Moves the focus to the given position in µm.
-
set_acceleration–Sets the acceleration of the focus in percent.
-
set_speed–Sets the speed of the focus in percent.
-
stop–Stops the focus if it is moving.
get_acceleration
async
#
get_acceleration(focus_service_get_acceleration_request: FocusServiceGetAccelerationRequest) -> FocusServiceGetAccelerationResponse
Gets the focus acceleration.
get_position
async
#
get_position(focus_service_get_position_request: FocusServiceGetPositionRequest) -> FocusServiceGetPositionResponse
Gets the focus position.
get_speed
async
#
get_speed(focus_service_get_speed_request: FocusServiceGetSpeedRequest) -> FocusServiceGetSpeedResponse
Gets the focus speed.
move_to
async
#
move_to(focus_service_move_to_request: FocusServiceMoveToRequest) -> FocusServiceMoveToResponse
Moves the focus to the given position in µm.
set_acceleration
async
#
set_acceleration(focus_service_set_acceleration_request: FocusServiceSetAccelerationRequest) -> FocusServiceSetAccelerationResponse
Sets the acceleration of the focus in percent.
set_speed
async
#
set_speed(focus_service_set_speed_request: FocusServiceSetSpeedRequest) -> FocusServiceSetSpeedResponse
Sets the speed of the focus in percent.
stop
async
#
stop(focus_service_stop_request: FocusServiceStopRequest) -> FocusServiceStopResponse
Stops the focus if it is moving.
SampleCarrierServiceBase
#
Bases: ServiceBase
Methods:
-
activate_container–Activates a tile region or position that is placed in the specified container.
-
activate_container_range–Activates all tile regions and/or positions that are placed in the specified container range
-
activate_containers–Activates all tile regions and/or positions that are placed in the specified containers
-
deactivate_container–Deactivates a tile region or position that is placed in the specified container.
-
deactivate_container_range–Deactivates all tile regions and/or positions that are placed in the specified container
-
deactivate_containers–Deactivates all tile regions and/or positions that are placed in the specified containers
-
get_configured_containers–Gets the information about the configured containers in an experiment.
-
get_current_container–Gets the information in which container of the sample carrier the stage is positioned at.
-
get_info–Gets the information of the currently inserted sample carrier.
-
move_to_container–Move the stage to a sample holder container.
activate_container
async
#
activate_container(sample_carrier_service_activate_container_request: SampleCarrierServiceActivateContainerRequest) -> SampleCarrierServiceActivateContainerResponse
Activates a tile region or position that is placed in the specified container.
activate_container_range
async
#
activate_container_range(sample_carrier_service_activate_container_range_request: SampleCarrierServiceActivateContainerRangeRequest) -> SampleCarrierServiceActivateContainerRangeResponse
Activates all tile regions and/or positions that are placed in the specified container range (e.g., "C3-D8").
activate_containers
async
#
activate_containers(sample_carrier_service_activate_containers_request: SampleCarrierServiceActivateContainersRequest) -> SampleCarrierServiceActivateContainersResponse
Activates all tile regions and/or positions that are placed in the specified containers (e.g., ["A1", "A2", "B7"]).
deactivate_container
async
#
deactivate_container(sample_carrier_service_deactivate_container_request: SampleCarrierServiceDeactivateContainerRequest) -> SampleCarrierServiceDeactivateContainerResponse
Deactivates a tile region or position that is placed in the specified container.
deactivate_container_range
async
#
deactivate_container_range(sample_carrier_service_deactivate_container_range_request: SampleCarrierServiceDeactivateContainerRangeRequest) -> SampleCarrierServiceDeactivateContainerRangeResponse
Deactivates all tile regions and/or positions that are placed in the specified container range (e.g., "C3-D8").
deactivate_containers
async
#
deactivate_containers(sample_carrier_service_deactivate_containers_request: SampleCarrierServiceDeactivateContainersRequest) -> SampleCarrierServiceDeactivateContainersResponse
Deactivates all tile regions and/or positions that are placed in the specified containers (e.g., ["A1", "A2", "B7"]).
get_configured_containers
async
#
get_configured_containers(sample_carrier_service_get_configured_containers_request: SampleCarrierServiceGetConfiguredContainersRequest) -> SampleCarrierServiceGetConfiguredContainersResponse
Gets the information about the configured containers in an experiment.
get_current_container
async
#
get_current_container(sample_carrier_service_get_current_container_request: SampleCarrierServiceGetCurrentContainerRequest) -> SampleCarrierServiceGetCurrentContainerResponse
Gets the information in which container of the sample carrier the stage is positioned at. Note that the stage might not be positioned exactly in the center of the container.
get_info
async
#
get_info(sample_carrier_service_get_info_request: SampleCarrierServiceGetInfoRequest) -> SampleCarrierServiceGetInfoResponse
Gets the information of the currently inserted sample carrier.
move_to_container
async
#
move_to_container(sample_carrier_service_move_to_container_request: SampleCarrierServiceMoveToContainerRequest) -> SampleCarrierServiceMoveToContainerResponse
Move the stage to a sample holder container.