zen_api/lm/acquisition/v1/experiment_sw_autofocus_service.proto#
Version: 2026.5.1
Package: zen_api.lm.acquisition.v1
Service ExperimentSwAutofocusService#
The IExperimentSwAutofocusService interface.
Export#
Exports the software autofocus parameters to an xml string.
rpc Export (zen_api.lm.acquisition.v1.ExperimentSwAutofocusServiceExportRequest) returns (zen_api.lm.acquisition.v1.ExperimentSwAutofocusServiceExportResponse);
Request: zen_api.lm.acquisition.v1.ExperimentSwAutofocusServiceExportRequest
Response: zen_api.lm.acquisition.v1.ExperimentSwAutofocusServiceExportResponse
FindAutoFocus#
Gets the the focus position.
rpc FindAutoFocus (zen_api.lm.acquisition.v1.ExperimentSwAutofocusServiceFindAutoFocusRequest) returns (zen_api.lm.acquisition.v1.ExperimentSwAutofocusServiceFindAutoFocusResponse);
Request: zen_api.lm.acquisition.v1.ExperimentSwAutofocusServiceFindAutoFocusRequest
Response: zen_api.lm.acquisition.v1.ExperimentSwAutofocusServiceFindAutoFocusResponse
GetAutofocusParameters#
Gets the software autofocus parameters for the specified experiment.
rpc GetAutofocusParameters (zen_api.lm.acquisition.v1.ExperimentSwAutofocusServiceGetAutofocusParametersRequest) returns (zen_api.lm.acquisition.v1.ExperimentSwAutofocusServiceGetAutofocusParametersResponse);
Request: zen_api.lm.acquisition.v1.ExperimentSwAutofocusServiceGetAutofocusParametersRequest
Response: zen_api.lm.acquisition.v1.ExperimentSwAutofocusServiceGetAutofocusParametersResponse
Import#
Imports the software autofocus parameters from an xml string.
rpc Import (zen_api.lm.acquisition.v1.ExperimentSwAutofocusServiceImportRequest) returns (zen_api.lm.acquisition.v1.ExperimentSwAutofocusServiceImportResponse);
Request: zen_api.lm.acquisition.v1.ExperimentSwAutofocusServiceImportRequest
Response: zen_api.lm.acquisition.v1.ExperimentSwAutofocusServiceImportResponse
SetAutofocusParameters#
Sets the software autofocus parameters for the specified experiment.
rpc SetAutofocusParameters (zen_api.lm.acquisition.v1.ExperimentSwAutofocusServiceSetAutofocusParametersRequest) returns (zen_api.lm.acquisition.v1.ExperimentSwAutofocusServiceSetAutofocusParametersResponse);
Request: zen_api.lm.acquisition.v1.ExperimentSwAutofocusServiceSetAutofocusParametersRequest
Response: zen_api.lm.acquisition.v1.ExperimentSwAutofocusServiceSetAutofocusParametersResponse
Message ExperimentSwAutofocusServiceExportRequest#
The ExperimentSwAutofocusServiceExportRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
experiment_id |
1 | string |
singular | The experiment id. |
Message ExperimentSwAutofocusServiceExportResponse#
Response object representing the values of xml string.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
xml_string |
1 | string |
singular | A value of the xml string. |
Message ExperimentSwAutofocusServiceFindAutoFocusRequest#
The ExperimentSwAutofocusServiceFindAutoFocusRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
experiment_id |
1 | string |
singular | The experiment id. |
timeout |
2 | google.protobuf.DoubleValue |
singular | The timeout in seconds. |
Message ExperimentSwAutofocusServiceFindAutoFocusResponse#
Response object representing the focus position.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
focus_position |
1 | double |
singular | The focus position (unit: m). |
Message ExperimentSwAutofocusServiceGetAutofocusParametersRequest#
The ExperimentSwAutofocusServiceGetAutofocusParametersRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
experiment_id |
1 | string |
singular | The experiment id. |
Message ExperimentSwAutofocusServiceGetAutofocusParametersResponse#
Response object representing the values of software autofocus parameters for the experiment.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
experiment_id |
1 | string |
singular | A value of the experiment id. |
auto_focus_mode |
2 | zen_api.lm.acquisition.v1.AutofocusMode | singular | A value of autofocus mode. |
contrast_measure |
3 | zen_api.lm.acquisition.v1.AutofocusContrastMeasure | singular | A value of sharpness measure for contrast mode. |
search_strategy |
4 | string |
singular | A value of search strategy. Either "Smart", "Full", "FullNoChecks" or the name of an extension strategy. |
autofocus_sampling |
5 | zen_api.lm.acquisition.v1.AutofocusSampling | singular | A value of the predefined step size. |
offset |
6 | double |
singular | A value of the reflection mode offset (unit: m). |
use_acquisition_roi |
7 | bool |
singular | A value indicating whether the acquisition ROI is used for the software autofocus. |
reference_channel_name |
8 | string |
singular | A name of the focus reference channel. |
relative_range_is_automatic |
9 | bool |
singular | A value indicating whether the relative search range size is determined automatically. |
relative_search_range |
10 | double |
singular | A value of the relative search range of the Z drive (unit: m). |
lower_limit |
11 | double |
singular | A value of the lower search range limit of the Z drive (unit: m). |
upper_limit |
12 | double |
singular | A value of the upper search range limit of the Z drive (unit: m). |
Message ExperimentSwAutofocusServiceImportRequest#
The ExperimentSwAutofocusServiceImportRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
experiment_id |
1 | string |
singular | The experiment id. |
xml_string |
2 | string |
singular | Xml string to be imported. |
Message ExperimentSwAutofocusServiceImportResponse#
The ExperimentSwAutofocusServiceImportResponse class.
Message ExperimentSwAutofocusServiceSetAutofocusParametersRequest#
The ExperimentSwAutofocusServiceSetAutofocusParametersRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
experiment_id |
1 | string |
singular | The experiment id. |
autofocus_mode |
2 | zen_api.lm.acquisition.v1.AutofocusMode | singular | The autofocus mode. |
contrast_measure |
3 | zen_api.lm.acquisition.v1.AutofocusContrastMeasure | singular | The sharpness measure for contrast mode. |
search_strategy |
4 | string |
singular | 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 |
5 | zen_api.lm.acquisition.v1.AutofocusSampling | singular | The predefined step size, or null to leave unmodified. |
offset |
6 | google.protobuf.DoubleValue |
singular | The reflection mode offset (unit: m), or null to leave unmodified. |
use_acquisition_roi |
7 | google.protobuf.BoolValue |
singular | True if the acquisition ROI is used for the software autofocus; otherwise, false, or null to leave unmodified. |
reference_channel_name |
8 | string |
singular | The case-insensitive name of the focus reference channel, or null to leave unmodified. |
relative_range_is_automatic |
9 | google.protobuf.BoolValue |
singular | True if the relative search range size is determined automatically; otherwise, false, or null to leave unmodified. |
relative_search_range |
10 | google.protobuf.DoubleValue |
singular | The relative search range in units of the Z drive (unit: m), or null to leave unmodified. |
lower_limit |
11 | google.protobuf.DoubleValue |
singular | The lower search range limit in units of the Z drive (unit: m), or null to leave unmodified. |
upper_limit |
12 | google.protobuf.DoubleValue |
singular | The upper limit in units of the Z drive (unit: m), or null to leave unmodified. |
Message ExperimentSwAutofocusServiceSetAutofocusParametersResponse#
The ExperimentSwAutofocusServiceSetAutofocusParametersResponse class.