---
title: "ScreenPositionAxis"
description: "API documentation for ScreenPositionAxis"
url: https://developer.disguise.one/python-api/docs/screenpositionaxis/
---

# ScreenPositionAxis

See also: [Devices Guide](/plugins/guides/devices)

Base class (inherits properties and methods): _[Resource](/python-api/docs/resource#resource)_

## Properties

#### **acceleration** : _float_

#### **delta** : _float_

#### **destValid** : _bool_ _(Read-Only)_

#### **devicePredictionEnabled** : _bool_ _(Read-Only)_

#### **filterOverrideEnabled** : _int_

When switched on, filter parameters override the parent device’s parameters.

_Options: {0: ‘Off’, 1: ‘On’}  
Category: Output  
UserName: Filter Override Enabled_

#### **frequency** : _float_

#### **frequencyMax** : _float_

#### **frequencyMin** : _float_

#### **graph** : _int_

Create a monitor in the monitoring manager for incoming packet and filter data

_Options: {0: ‘No’, 1: ‘Yes’}  
Category: Output  
UserName: Graph Data_

#### **id** : _str_

Set this to match an ID provided by an active Screen Position Driver

_Category: Configuration  
UserName: ID_

#### **input** : _float_

#### **max\_input** : _float_

These values scale an input range (values in the device’s world) to an output range (values in d3 stage world).  
Move the physical value to its minimum position, copy the current input into ‘minimum input’; then repeat for the maximum.  
Then fill in the corresponding d3 stage values (whether in meters or degrees) to the min and max outputs

_Category: Range  
UserName: Maximum input_

#### **max\_output** : _float_

These values scale an input range (values in the device’s world) to an output range (values in d3 stage world).  
Move the physical value to its minimum position, copy the current input into ‘minimum input’; then repeat for the maximum.  
Then fill in the corresponding d3 stage values (whether in meters or degrees) to the min and max outputs

_Category: Range  
UserName: Maximum output_

#### **min\_input** : _float_

These values scale an input range (values in the device’s world) to an output range (values in d3 stage world).  
Move the physical value to its minimum position, copy the current input into ‘minimum input’; then repeat for the maximum.  
Then fill in the corresponding d3 stage values (whether in meters or degrees) to the min and max outputs

_Category: Range  
UserName: Minimum input_

#### **min\_output** : _float_

These values scale an input range (values in the device’s world) to an output range (values in d3 stage world).  
Move the physical value to its minimum position, copy the current input into ‘minimum input’; then repeat for the maximum.  
Then fill in the corresponding d3 stage values (whether in meters or degrees) to the min and max outputs

_Category: Range  
UserName: Minimum output_

#### **movementThreshold** : _float_

Minimum change needed before updating output value. Helps when data has unwanted movement when intended to be static. 0 means no threshold (disabled)

_Category: Output  
UserName: Movement threshold_

#### **object** : _[Object](/python-api/docs/object#object)_

Set this to the object that will receive the value (position or angle)

_Category: Configuration  
UserName: Object_

#### **offset** : _float_

Offset the final output value.

_Category: Range  
UserName: Offset_

#### **output** : _float_

The output value (specified units).

_Category: Output  
UserName: Output value_

#### **outputRaw** : _float_

#### **outputScaled** : _float_

#### **positionSamples** : _int_

Number of position samples to filter. Use 0 to disable. More samples will introduce higher latency with more smoothing effect. Fewer samples will introduce less latency with less smoothing effect.

_Category: Output  
UserName: Number of Position Samples_

#### **prediction** : _float_

Compensate for time latency between received data and projector output. Use 0 to disable.

_Category: Output  
UserName: Bias/ Prediction (ms)_

#### **predictionEnabled** : _int_

When switched on, prediction uses the ‘bias’ property to predict tracked positions at a future time

_Options: {0: ‘Off’, 1: ‘On’}  
Category: Output  
UserName: Prediction Override Enabled_

#### **property\_** : _str_

_Category: Configuration  
UserName: Property_

#### **smoothingFactor** : _float_

Smoothing Factor (%). Higher values will smooth the data more but will increase latency and therefore the need for prediction. Conversely, for lower values.

_Category: Output  
UserName: Smoothing Factor_

#### **status** : _int_

_Options: {0: ‘Disengaged’, 1: ‘Engaged’}  
Category: Output  
UserName: Status_

#### **timeSamples** : _int_

Number of time samples to filter. Use 0 to disable. More samples will introduce higher latency with more smoothing effect. Fewer samples will introduce less latency with less smoothing effect.

_Category: Output  
UserName: Number of Time Samples_

#### **velocity** : _float_

#### **velocityCalcMode** : _int_

If set to Calculate the system will attempt to calculate velocity data otherwise this will use velocity values from incoming packets.

_Options: {0: ‘Calculate’, 1: ‘From Packet’, 2: ‘Disabled’}  
Category: Velocity  
UserName: Velocity Mode_

#### **wrapInput** : _int_

Input values wrap, jumping from Minimum input to Maximum input or vice versa

_Options: {0: ‘No’, 1: ‘Yes’}  
Category: Range  
UserName: Wrap input_

## Static Methods

#### **axisDirectionToString**(direction: _[AxisDirection](/python-api/docs/axisdirection#axisdirection)_) -> _str_