Theodolite Measurement and Calculation¶

Description¶

Module: geocompy.geo.tmc

Definitions for the GeoCOM Theodolite measurement and calculation subsystem.

Types¶

GeoComTMC

Definitions¶

class GeoComTMC(parent: GeoComType)[source]¶

Theodolite measurement and calculation subsystem of the GeoCOM protocol.

This subsystem is the central module of measurement, calculation and geodetic control.

The module handles:

measurement functions
measurement control functions
data setup functions
information functions
configuration functions

Possible return codes:

System: General use codes.
Informative/Warning: Function terminated with success, but some restrictions may apply (e.g.: angle measurement succeded, distance measurement failed).
Error: Non-successful function termination.

Parameters:

parent: GeoComType¶: The parent protocol instance of this subsystem.

do_measurement(command: Measurement | str = Measurement.DISTANCE, inclination: Inclination | str = Inclination.AUTO) → GeoComResponse[None][source]¶

RPC 2008, TMC_DoMeasure

Carries out a distance measurement with the specified measurement program and inclination correction mode. The results are not returned, but kept in memory until the next measurement command.

Parameters:

command: Measurement | str = Measurement.DISTANCE¶: Distance measurement program, by default Measurement.DISTANCE
inclination: Inclination | str = Inclination.AUTO¶: Inclination correction mode, by default Inclination.AUTO

Return type:

GeoComResponse

get_angle(mode: Inclination | str = Inclination.AUTO) → GeoComResponse[tuple[Angle, Angle]][source]¶

RPC 2107, TMC_GetAngle5

Takes an angular measurement with the selected inclination correction mode.

Parameters:

mode: Inclination | str = Inclination.AUTO¶: Inclination correction mode, by default Inclination.AUTO

Returns:

Params:

Angle: Horizontal angle.
Angle: Vertical angle.

Warning codes:

TMC_ACCURACY_GUARANTEE: Accuracy is not guaranteed, because the measurement contains data with unverified accuracy. Coordinates are available.
TMC_NO_FULL_CORRECTION: Results are not corrected by all sensors. Coordinates are available. Run check commands to determine the missing correction.
TMC_ANGLE_NO_FULL_CORRECTION: Only angles are measured, but the accuracy cannot be guaranteed. Tilt measurement might not be available.
TMC_ANGLE_OK: Angles are measured, but no valid distance was found.
TMC_ANGLE_NO_ACC_GUARANTY: Only angle measurement is valid, but the accuracy cannot be guaranteed.

Error codes:

TMC_DIST_ERROR: Error is distance measurement, target not found. Repeat sighting and measurement!
TMC_DIST_PPM: Wrong EDM settings.
TMC_ANGLE_ERROR: Angle or inclination measurement error. Check inclination mode!
TMC_BUSY: TMC is currently busy. Repeat measurement!
ABORT: Measurement aborted.
SHUT_DOWN: System shutdown.

Return type:

GeoComResponse

get_angle_correction() → GeoComResponse[tuple[bool, bool, bool, bool]][source]¶

RPC 2014, TMC_GetAngSwitch

Gets the current status of the angular corrections.

Returns:

Params:

bool: Inclination correction.
bool: Standing axis correction.
bool: Collimation error correction.
bool: Tilting axis correction.

Return type:

GeoComResponse

See also

set_angle_correction

get_angle_inclination(mode: Inclination | str = Inclination.AUTO) → GeoComResponse[tuple[Angle, Angle, Angle, int, Angle, Angle, Angle, int, Face]][source]¶

RPC 2003, TMC_GetAngle

Takes an angular measurement with the selected inclination measurement mode.

Parameters:

mode: Inclination | str = Inclination.AUTO¶: Inclination meaurement mode, by default INCLINEPRG.AUTO

Returns:

Params:

Angle: Horizontal angle.
Angle: Vertical angle.
Angle: Angular accuracy.
int: Time of angle measurement.
Angle: Cross inclination.
Angle: Lengthwise inclination.
Angle: Inclination accuracy.
int: Time of inclination measurement.
Face: Instrument face.

Warning codes:

TMC_ACCURACY_GUARANTEE: Accuracy is not guaranteed, because the measurement contains data with unverified accuracy. Coordinates are available.
TMC_NO_FULL_CORRECTION: Results are not corrected by all sensors. Coordinates are available. Run check commands to determine the missing correction.
TMC_ANGLE_NO_FULL_CORRECTION: Only angles are measured, but the accuracy cannot be guaranteed. Tilt measurement might not be available.
TMC_ANGLE_OK: Angles are measured, but no valid distance was found.
TMC_ANGLE_NO_ACC_GUARANTY: Only angle measurement is valid, but the accuracy cannot be guaranteed.

Error codes:

TMC_DIST_ERROR: Error is distance measurement, target not found. Repeat sighting and measurement!
TMC_DIST_PPM: Wrong EDM settings.
TMC_ANGLE_ERROR: Angle or inclination measurement error. Check inclination mode!
TMC_BUSY: TMC is currently busy. Repeat measurement!
ABORT: Measurement aborted.
SHUT_DOWN: System shutdown.

Return type:

GeoComResponse

See also

get_angle, get_simple_measurement

get_atmospheric_correction_ppm() → GeoComResponse[float][source]¶

RPC 2151, TMC_GetAtmPpm

Added in version GeoCOM-TPS1200.

Gets the current atmospheric correction factor.

Returns:

Params:

float: Atmospheric correction factor [ppm].

Return type:

GeoComResponse

get_atmospheric_corrections() → GeoComResponse[tuple[float, float, float, float]][source]¶

RPC 2029, TMC_GetAtmCorr

Gets current parameters of the atmospheric correction.

Returns:

Params:

float: EDM transmitter wavelength.
float: Atmospheric pressure [mbar].
float: Dry temperature [°C].
float: Wet temperature [°C].

Return type:

GeoComResponse

See also

set_atmospheric_corrections

get_compensator_status() → GeoComResponse[bool][source]¶

RPC 2007, TMC_GetInclineSwitch

Gets the current status of the dual axis compensator.

Returns:

Params:

bool: Compensator is enabled.

Return type:

GeoComResponse

See also

switch_compensator

get_complete_measurement(wait: int = 5, mode: Inclination | str = Inclination.AUTO) → GeoComResponse[tuple[Angle, Angle, float]][source]¶

RPC 2167, TMC_GetFullMeas

Added in version GeoCOM-TPS1200.

Takes an angular measurement with the selected inclination correction mode, and returns measurements with a previously measured distance, as well as accuracy indicators. The distance has to be measured in advance. As the distance measurement takes some time to complete, a wait time can be specified for the process, to wait for the completion of the measurement.

Parameters:

wait: int = 5¶: Wait time for EDM process [s], by default 5
mode: Inclination | str = Inclination.AUTO¶: Inclination correction mode, by default Inclination.AUTO

Returns:

Params:

Angle: Horizontal angle.
Angle: Vertical angle.
Angle: Angular accuracy.
Angle: Cross inclination.
Angle: Lengthwise inclination.
Angle: Inclination accuracy.
float: Slope distance.
float: Distance measurement time [ms].

Warning codes:

TMC_ACCURACY_GUARANTEE: Accuracy is not guaranteed, because the measurement contains data with unverified accuracy. Coordinates are available.
TMC_NO_FULL_CORRECTION: Results are not corrected by all sensors. Coordinates are available. Run check commands to determine the missing correction.
TMC_ANGLE_NO_FULL_CORRECTION: Only angles are measured, but the accuracy cannot be guaranteed. Tilt measurement might not be available.
TMC_ANGLE_OK: Angles are measured, but no valid distance was found.
TMC_ANGLE_NO_ACC_GUARANTY: Only angle measurement is valid, but the accuracy cannot be guaranteed.

Error codes:

TMC_DIST_ERROR: Error is distance measurement, target not found. Repeat sighting and measurement!
TMC_DIST_PPM: Wrong EDM settings.
TMC_ANGLE_ERROR: Angle or inclination measurement error. Check inclination mode!
TMC_BUSY: TMC is currently busy. Repeat measurement!
ABORT: Measurement aborted.
SHUT_DOWN: System shutdown.

Return type:

GeoComResponse

See also

do_measurement, get_angle

get_coordinate(wait: int = 5, mode: Inclination | str = Inclination.AUTO) → GeoComResponse[tuple[Coordinate, int, Coordinate, int]][source]¶

RPC 2082, TMC_GetCoordinate

Takes an angular measurement with the selected inclination correction mode, and calculates coordinates from an previously measured distance. The distance has to be measured in advance. As the distance measurement takes some time to complete, a wait time can be specified for the calculation, to wait for the completion of the measurement.

Parameters:

wait: int = 5¶: Wait time for EDM process [s], by default 5
mode: Inclination | str = Inclination.AUTO¶: Inclination correction mode, by default Inclination.AUTO

Returns:

Params:

COORDINATE: Calculated coordinate.
int: Time of the coordinate acquisition.
COORDINATE: Continuously calculated coordinate.
int: Time of the coordinate acquisition.

Warning codes:

TMC_ACCURACY_GUARANTEE: Accuracy is not guaranteed, because the measurement contains data with unverified accuracy. Coordinates are available.
TMC_NO_FULL_CORRECTION: Results are not corrected by all sensors. Coordinates are available. Run check commands to determine the missing correction.

Error codes:

TMC_ANGLE_OK: Angles are measured, but no valid distance was found.
TMC_ANGLE_NO_FULL_CORRECTION: Only angles are measured, but the accuracy cannot be guaranteed. Tilt measurement might not be available.
TMC_DIST_ERROR: Error is distance measurement, target not found. Repeat sighting and measurement!
TMC_DIST_PPM: Wrong EDM settings.
TMC_ANGLE_ERROR: Angle or inclination measurement error. Check inclination mode!
TMC_BUSY: TMC is currently busy. Repeat measurement!
ABORT: Measurement aborted.
SHUT_DOWN: System shutdown.

Return type:

GeoComResponse

get_distance_correction() → GeoComResponse[tuple[float, float]][source]¶

RPC 2126, TMC_GetSlopDistCorr

Added in version GeoCOM-TPS1100.

Gets the total correction (atmospheric + geometric) applied to the distance measurements, as well as the current prism constant.

Returns:

Params:

float: Total corrections [ppm].
float: Prism constant.

Return type:

GeoComResponse

get_edm_mode_v1() → GeoComResponse[EDMModeV1][source]¶

RPC 2021, TMC_GetEdmMode

Removed in version GeoCOM-TPS1100.

Gets the current EDM measurement mode.

Returns:

Params:

EDMMode: Current EDM mode (EDMModeV1).

Return type:

GeoComResponse

See also

set_edm_mode_v1

get_edm_mode_v2() → GeoComResponse[EDMModeV2][source]¶

RPC 2021, TMC_GetEdmMode

Added in version GeoCOM-TPS1100.

Gets the current EDM measurement mode.

Returns:

Params:

EDMMode: Current EDM mode (EDMModeV2).

Return type:

GeoComResponse

See also

set_edm_mode_v2

get_face() → GeoComResponse[Face][source]¶

RPC 2026, TMC_GetFace

Gets which face the telescope is corrently positioned in. The face information is only valid, if the instrument is in active state.

Returns:

Params:

Face: Current face.

Return type:

GeoComResponse

See also

aut.change_face

get_geometric_correction_ppm() → GeoComResponse[tuple[bool, float, float, float, float]][source]¶

RPC 2154, TMC_GetGeoPpm

Added in version GeoCOM-TPS1200.

Gets the current geometric correction factors.

Returns:

Params:

bool: Autmatically apply geometric corrections.
float: Scale factor on central meridian.
float: Offset from central meridian.
float: Length reduction from projection to reference level.
float: Individual correction [ppm].

Return type:

GeoComResponse

get_prism_correction() → GeoComResponse[float][source]¶

RPC 2023, TMC_GetPrismCorr

Gets the current prism constant.

Returns:

Params:

float: Prism constant.

Return type:

GeoComResponse

See also

set_prism_correction

get_refractive_correction() → GeoComResponse[tuple[bool, float, float]][source]¶

RPC 2031, TMC_GetRefractiveCorr

Gets current refraction correction coefficients.

Returns:

Params:

bool: Refraction correction enabled.
float: Radius of the Earth.
float: Refraction coefficient.

Return type:

GeoComResponse

See also

set_refractive_correction

get_refractive_method() → GeoComResponse[int][source]¶

RPC 2091, TMC_GetRefractiveMethod

Gets the current refraction mode.

Returns:

Params:

int: Refraction method.

Return type:

GeoComResponse

See also

set_refractive_method

get_signal() → GeoComResponse[tuple[float, int]][source]¶

RPC 2022, TMC_GetSignal

Gets information about the intensity of the EDM signal. The EDM most be started in signal measuring mode in advance, and has to be cleared afterwards.

Returns:

Params:

float: Return signal intensity [%].
int: Time of the signal measurement.

Error codes:

TMC_SIGNAL_ERROR: Error in signal measurement.
ABORT: Measurement was aborted.
SHUT_DOWN: System shutdown.

Return type:

GeoComResponse

See also

do_measurement

get_simple_coordinate(wait: int = 5, inclination: Inclination | str = Inclination.AUTO) → GeoComResponse[Coordinate][source]¶

RPC 2116, TMC_GetSimpleCoord

Parameters:

wait: int = 5¶: Wait time for EDM process [s], by default 5
inclination: Inclination | str = Inclination.AUTO¶: Inclination correction mode, by default Inclination.AUTO

Returns:

Params:

Coordinate: Calculated coordinate.

Warning codes:

TMC_ACCURACY_GUARANTEE: Accuracy is not guaranteed, because the measurement contains data with unverified accuracy. Coordinates are available.
TMC_NO_FULL_CORRECTION: Results are not corrected by all sensors. Coordinates are available. Run check commands to determine the missing correction.

Error codes:

TMC_ANGLE_OK: Angles are measured, but no valid distance was found.
TMC_ANGLE_NO_FULL_CORRECTION: Only angles are measured, but the accuracy cannot be guaranteed. Tilt measurement might not be available.
TMC_DIST_ERROR: Error is distance measurement, target not found. Repeat sighting and measurement!
TMC_DIST_PPM: Wrong EDM settings.
TMC_ANGLE_ERROR: Angle or inclination measurement error. Check inclination mode!
TMC_BUSY: TMC is currently busy. Repeat measurement!
ABORT: Measurement aborted.
SHUT_DOWN: System shutdown.

Return type:

GeoComResponse

get_simple_measurement(wait: int = 5, mode: Inclination | str = Inclination.AUTO) → GeoComResponse[tuple[Angle, Angle, float]][source]¶

RPC 2108, TMC_GetSimpleMea

Takes an angular measurement with the selected inclination correction mode, and returns measurements with a previously measured distance. The distance has to be measured in advance. As the distance measurement takes some time to complete, a wait time can be specified for the process, to wait for the completion of the measurement.

Parameters:

wait: int = 5¶: Wait time for EDM process [s], by default 5
mode: Inclination | str = Inclination.AUTO¶: Inclination correction mode, by default Inclination.AUTO

Returns:

Params:

Angle: Horizontal angle.
Angle: Vertical angle.
float: Slope distance.

Warning codes:

TMC_ACCURACY_GUARANTEE: Accuracy is not guaranteed, because the measurement contains data with unverified accuracy. Coordinates are available.
TMC_NO_FULL_CORRECTION: Results are not corrected by all sensors. Coordinates are available. Run check commands to determine the missing correction.
TMC_ANGLE_NO_FULL_CORRECTION: Only angles are measured, but the accuracy cannot be guaranteed. Tilt measurement might not be available.
TMC_ANGLE_OK: Angles are measured, but no valid distance was found.
TMC_ANGLE_NO_ACC_GUARANTY: Only angle measurement is valid, but the accuracy cannot be guaranteed.

Error codes:

TMC_DIST_ERROR: Error is distance measurement, target not found. Repeat sighting and measurement!
TMC_DIST_PPM: Wrong EDM settings.
TMC_ANGLE_ERROR: Angle or inclination measurement error. Check inclination mode!
TMC_BUSY: TMC is currently busy. Repeat measurement!
ABORT: Measurement aborted.
SHUT_DOWN: System shutdown.

Return type:

GeoComResponse

See also

do_measurement, get_angle

get_station() → GeoComResponse[tuple[Coordinate, float]][source]¶

RPC 2009, TMC_GetStation

Gets the current station coordinates and instrument height.

Returns:

Params:

Coordinate: Station coordinates.
float: Height of instrument.

Return type:

GeoComResponse

See also

set_station

get_target_height() → GeoComResponse[float][source]¶

RPC 2011, TMC_GetHeight

Gets the current target height.

Returns:

Params:

float: Current target height.

Return type:

GeoComResponse

See also

set_target_height

quick_distance() → GeoComResponse[tuple[Angle, Angle, float]][source]¶

RPC 2117, TMC_QuickDist

Starts an EDM tracking measurement and waits until a distance is measured.

Returns:

Params:

Angle: Horizontal angle.
Angle: Vertical angle.
float: Slope distance.

Warning codes:

TMC_ACCURACY_GUARANTEE: Accuracy is not guaranteed, because the measurement contains data with unverified accuracy. Coordinates are available.
TMC_NO_FULL_CORRECTION: Results are not corrected by all sensors. Coordinates are available. Run check commands to determine the missing correction.
TMC_ANGLE_NO_FULL_CORRECTION: Only angles are measured, but the accuracy cannot be guaranteed. Tilt measurement might not be available.
TMC_ANGLE_OK: Angles are measured, but no valid distance was found.
TMC_ANGLE_NO_ACC_GUARANTY: Only angle measurement is valid, but the accuracy cannot be guaranteed.

Error codes:

TMC_DIST_ERROR: Error is distance measurement, target not found. Repeat sighting and measurement!
TMC_DIST_PPM: Wrong EDM settings.
TMC_ANGLE_ERROR: Angle or inclination measurement error. Check inclination mode!
TMC_BUSY: TMC is currently busy. Repeat measurement!
ABORT: Measurement aborted.
SHUT_DOWN: System shutdown.

Return type:

GeoComResponse

set_angle_correction(inclinecorr: bool, stdaxiscorr: bool, collimcorr: bool, tiltaxiscorr: bool) → GeoComResponse[None][source]¶

RPC 2014, TMC_SetAngSwitch

Sets the status of the angular corrections.

Parameters:

inclinecorr: bool¶: Inclination correction.
stdaxiscorr: bool¶: Standing axis correction.
collimcorr: bool¶: Collimation error correction.
tiltaxiscorr: bool¶: Tilting axis correction,

Returns:

Error codes:

TMC_BUSY: TMC is busy.

Return type:

GeoComResponse

set_atmospheric_correction_ppm(ppm: float) → GeoComResponse[None][source]¶

RPC 2148, TMC_SetAtmPpm

Added in version GeoCOM-TPS1200.

Sets the atmospheric correction factor.

Parameters:

ppm: float¶: Atmospheric correction factor [ppm].

Return type:

GeoComResponse

set_atmospheric_corrections(wavelength: float, pressure: float, drytemp: float, wettemp: float) → GeoComResponse[None][source]¶

RPC 2028, TMC_SetAtmCorr

Sets the parameters of the atmospheric correction.

Parameters:

wavelength: float¶: EDM transmitter wavelength.
pressure: float¶: Atmospheric pressure [mbar].
drytemp: float¶: Dry temperature [°C],
wettemp: float¶: Wet temperature [°C],

Return type:

GeoComResponse

See also

get_atmospheric_corrections

set_azimuth(azimuth: SupportsFloat) → GeoComResponse[None][source]¶

RPC 2113, TMC_SetOrientation

Sets the internal horizontal orientation offset so that the angular measurement reads the same as the provided angle. Previously measured distances must be cleared before orienting.

Parameters:

azimuth: SupportsFloat¶: Azimuth angle to set.

Returns:

Warning codes:

TMC_ACCURACY_GUARANTEE: Accuracy is not guaranteed, because the measurement contains data with unverified accuracy. Coordinates are available.
TMC_NO_FULL_CORRECTION: Results are not corrected by all sensors. Coordinates are available. Run check commands to determine the missing correction.
TMC_ANGLE_NO_FULL_CORRECTION: Only angles are measured, but the accuracy cannot be guaranteed. Tilt measurement might not be available.
TMC_ANGLE_OK: Angles are measured, but no valid distance was found.
TMC_ANGLE_NO_ACC_GUARANTY: Only angle measurement is valid, but the accuracy cannot be guaranteed.

Error codes:

TMC_DIST_ERROR: Error is distance measurement, target not found. Repeat sighting and measurement!
TMC_DIST_PPM: Wrong EDM settings.
TMC_ANGLE_ERROR: Angle or inclination measurement error. Check inclination mode!
TMC_BUSY: TMC is currently busy. Repeat measurement!
ABORT: Measurement aborted.
SHUT_DOWN: System shutdown.

Return type:

GeoComResponse

set_edm_mode_v1(mode: EDMModeV1 | str) → GeoComResponse[None][source]¶

RPC 2020, TMC_SetEdmMode

Removed in version GeoCOM-TPS1100.

Sets the EDM measurement mode.

Parameters:

mode: EDMModeV1 | str¶: EDM mode to activate (expects EDMModeV1).

Return type:

GeoComResponse

See also

get_edm_mode_v1

set_edm_mode_v2(mode: EDMModeV2 | str) → GeoComResponse[None][source]¶

RPC 2020, TMC_SetEdmMode

Added in version GeoCOM-TPS1100.

Sets the EDM measurement mode.

Parameters:

mode: EDMModeV2 | str¶: EDM mode to activate (expects EDMModeV2).

Return type:

GeoComResponse

See also

get_edm_mode_v2

set_geometric_correction_ppm(automatic: bool, meridianscale: float, meridianoffset: float, reduction: float, individual: float) → GeoComResponse[None][source]¶

RPC 2153, TMC_SetGeoPpm

Added in version GeoCOM-TPS1200.

Sets the geometric correction factors.

Parameters:

automatic: bool¶: Automatically apply geometric corrections.
meridianscale: float¶: Scale factor on central meridian.
meridianoffset: float¶: Offset from central meridian.
reduction: float¶: Length reduction from projection to reference level [ppm].
individual: float¶: Individual correction [ppm].

Return type:

GeoComResponse

set_manual_distance(distance: float, offset: float, inclination: Inclination | str = Inclination.AUTO) → GeoComResponse[None][source]¶

RPC 2019, TMC_SetHandDist

Sets slope distance and height offset from separately measured values. An angular and an inclination measurement is taken automatically to calculate the position of the target.

Parameters:

distance: float¶: Slope distance to set.
offset: float¶: Height offset.
inclination: Inclination | str = Inclination.AUTO¶: Inclination correction mode, by default Inclination.AUTO

Returns:

Warning codes:

TMC_ACCURACY_GUARANTEE: Accuracy is not guaranteed, because the measurement contains data with unverified accuracy. Coordinates are available.
TMC_NO_FULL_CORRECTION: Results are not corrected by all sensors. Coordinates are available. Run check commands to determine the missing correction.
TMC_ANGLE_NO_FULL_CORRECTION: Only angles are measured, but the accuracy cannot be guaranteed. Tilt measurement might not be available.
TMC_ANGLE_OK: Angles are measured, but no valid distance was found.
TMC_ANGLE_NO_ACC_GUARANTY: Only angle measurement is valid, but the accuracy cannot be guaranteed.

Error codes:

TMC_DIST_ERROR: Error is distance measurement, target not found. Repeat sighting and measurement!
TMC_DIST_PPM: Wrong EDM settings.
TMC_ANGLE_ERROR: Angle or inclination measurement error. Check inclination mode!
TMC_BUSY: TMC is currently busy. Repeat measurement!
ABORT: Measurement aborted.
SHUT_DOWN: System shutdown.

Return type: