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

# AlignmentData

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

Subclasses: _[AlignmentDataPose](/python-api/docs/alignmentdatapose#alignmentdatapose)_

## Properties

#### **alignPos** : _[Vec](/python-api/docs/vec#vec)_

Planned offset for captured point cloud, set by alignment.  
Affects all calibrated cameras and projectors, to align them with the d3 coordinate system.

_UserName: Offset_

#### **alignRot** : _[Vec](/python-api/docs/vec#vec)_

Planned rotation for captured point cloud, set by alignment.  
Affects all calibrated projectors to align them with the d3 coordinate system.

_UserName: Rotation_

#### **alignScale** : _float_

Planned scale for captured point cloud, set by alignment.  
Affects all calibrated projectors to align them with the d3 coordinate system.

_UserName: Scale_

#### **alignmentPointsToCoordinates** : _List\[[AlignmentPointToCoordinates](/python-api/docs/alignmentpointtocoordinates#alignmentpointtocoordinates)\]_

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

_UserName: Master screen_

#### **maxAlignmentCoordinatesPerCamera** : _int_ _(Read-Only)_

Current largest number of Alignment Coordinates (lined up Alignment Points) for any single camera. Need 3 or more for at least 2 cameras for QuickAlign to work.

_UserName: Max camera alignments_

#### **nAlignmentPoints** : _int_ _(Read-Only)_

Current total number of Alignment Points accross all screens.

_UserName: Alignment points (total)_

#### **nTotalAlignmentCoordinates** : _int_ _(Read-Only)_

Total number of Alignment Coordinates (lined up Alignment Points) accross all screens and cameras.

_UserName: Alignments (total)_

#### **nonUniformReshapeScaling** : _bool_

Apply non-uniform scale to mesh vertices before applying reshape.

_UserName: Use reshape scaling_

#### **reshapeAlgorithm** : _[ReshapeAlgorithm](/python-api/docs/reshapealgorithm#reshapealgorithm)_

_UserName: Reshape algorithm_

#### **screenScaling** : _bool_

Apply uniform scale to non-master screens. Useful for correcting a screen’s scale without using reshape points to change its mesh.

_UserName: Use screen scaling_

#### **secondaryAlignmentScreens** : _List\[[Object](/python-api/docs/object#object)\]_ _(Read-Only)_

_UserName: Screens_

## Methods

#### **addAlignmentCoordinate**(self, aptc: _[AlignmentPointToCoordinates](/python-api/docs/alignmentpointtocoordinates#alignmentpointtocoordinates)_, coord: _[Vec2](/python-api/docs/vec2#vec2) | [Int2](/python-api/docs/int2#int2) | [Vec](/python-api/docs/vec#vec)_, cam: _str_)

#### **addAlignmentPoint**(self, cameraMats: _[CameraMats](/python-api/docs/cameramats#cameramats)_, coord: _[Vec2](/python-api/docs/vec2#vec2) | [Int2](/python-api/docs/int2#int2) | [Vec](/python-api/docs/vec#vec)_, scr: _[Object](/python-api/docs/object#object)_, isDeformPoint: _bool_, uiViewScale: _float_) -> _int_

#### **filterAlignmentPointsToCoordinates**(self, camName: _str_, scr: _[Object](/python-api/docs/object#object)_, includeUnalignedPoints: _bool_) -> _List\[int\]_

#### **getAlignmentPointCoordsFromCam**(self, camName: _str_, scr: _[Object](/python-api/docs/object#object)_, cm: _[CameraMats](/python-api/docs/cameramats#cameramats)_, includeUnalignedPoints: _bool_) -> _List\[[Vec2](/python-api/docs/vec2#vec2)\]_

#### **getAlignmentScreens**(self, camName: _str_) -> _List\[[Object](/python-api/docs/object#object)\]_

#### **getAlignmentScreensWithChangedMeshes**(self) -> _List\[[Object](/python-api/docs/object#object)\]_

#### **importReferencePoints**(self) -> _List\[str\]_

#### **isBasePose**(self) -> _bool_

#### **multiStageDeleteAlignmentPoint**(self, aptc: _[AlignmentPointToCoordinates](/python-api/docs/alignmentpointtocoordinates#alignmentpointtocoordinates)_, camName: _str_)

#### **resetAllScreensAlignmentData**(self)

#### **resetScreenAlignmentData**(self, scr: _[Object](/python-api/docs/object#object)_)