Operator Reference

HALCON Operator Reference / Transformations / Dual Quaternions
ClassesClasses | | Operators

dual_quat_to_screwT_dual_quat_to_screwDualQuatToScrewDualQuatToScrewdual_quat_to_screw (Operator)

dual_quat_to_screwT_dual_quat_to_screwDualQuatToScrewDualQuatToScrewdual_quat_to_screw — Convert a unit dual quaternion into a screw.

Signature

Herror T_dual_quat_to_screw(const Htuple DualQuaternion, const Htuple ScrewFormat, Htuple* AxisDirectionX, Htuple* AxisDirectionY, Htuple* AxisDirectionZ, Htuple* AxisMomentOrPointX, Htuple* AxisMomentOrPointY, Htuple* AxisMomentOrPointZ, Htuple* Rotation, Htuple* Translation)

void DualQuatToScrew(const HTuple& DualQuaternion, const HTuple& ScrewFormat, HTuple* AxisDirectionX, HTuple* AxisDirectionY, HTuple* AxisDirectionZ, HTuple* AxisMomentOrPointX, HTuple* AxisMomentOrPointY, HTuple* AxisMomentOrPointZ, HTuple* Rotation, HTuple* Translation)

void HDualQuaternion::DualQuatToScrew(const HString& ScrewFormat, double* AxisDirectionX, double* AxisDirectionY, double* AxisDirectionZ, double* AxisMomentOrPointX, double* AxisMomentOrPointY, double* AxisMomentOrPointZ, double* Rotation, double* Translation) const

void HDualQuaternion::DualQuatToScrew(const char* ScrewFormat, double* AxisDirectionX, double* AxisDirectionY, double* AxisDirectionZ, double* AxisMomentOrPointX, double* AxisMomentOrPointY, double* AxisMomentOrPointZ, double* Rotation, double* Translation) const

void HDualQuaternion::DualQuatToScrew(const wchar_t* ScrewFormat, double* AxisDirectionX, double* AxisDirectionY, double* AxisDirectionZ, double* AxisMomentOrPointX, double* AxisMomentOrPointY, double* AxisMomentOrPointZ, double* Rotation, double* Translation) const   ( Windows only)

static void HOperatorSet.DualQuatToScrew(HTuple dualQuaternion, HTuple screwFormat, out HTuple axisDirectionX, out HTuple axisDirectionY, out HTuple axisDirectionZ, out HTuple axisMomentOrPointX, out HTuple axisMomentOrPointY, out HTuple axisMomentOrPointZ, out HTuple rotation, out HTuple translation)

void HDualQuaternion.DualQuatToScrew(string screwFormat, out double axisDirectionX, out double axisDirectionY, out double axisDirectionZ, out double axisMomentOrPointX, out double axisMomentOrPointY, out double axisMomentOrPointZ, out double rotation, out double translation)

def dual_quat_to_screw(dual_quaternion: Sequence[float], screw_format: str) -> Tuple[float, float, float, float, float, float, float, float]

Description

The operator dual_quat_to_screwdual_quat_to_screwDualQuatToScrewDualQuatToScrewdual_quat_to_screw converts the input unit dual quaternion DualQuaternionDualQuaternionDualQuaterniondualQuaterniondual_quaternion, which represents a 3D rigid transformation, into the parameters of the corresponding screw.

For a brief introduction to dual quaternions, the used notation, and the relationship between dual quaternions and screws, see “Solution Guide III-C - 3D Vision”.

If ScrewFormatScrewFormatScrewFormatscrewFormatscrew_format is set to 'moment'"moment""moment""moment""moment", these parameters are returned in the corresponding parameters AxisDirectionXAxisDirectionXAxisDirectionXaxisDirectionXaxis_direction_x, AxisDirectionYAxisDirectionYAxisDirectionYaxisDirectionYaxis_direction_y, AxisDirectionZAxisDirectionZAxisDirectionZaxisDirectionZaxis_direction_z, AxisMomentOrPointXAxisMomentOrPointXAxisMomentOrPointXaxisMomentOrPointXaxis_moment_or_point_x, AxisMomentOrPointYAxisMomentOrPointYAxisMomentOrPointYaxisMomentOrPointYaxis_moment_or_point_y, AxisMomentOrPointZAxisMomentOrPointZAxisMomentOrPointZaxisMomentOrPointZaxis_moment_or_point_z, RotationRotationRotationrotationrotation, and TranslationTranslationTranslationtranslationtranslation.

For convenience reasons, it is also possible to query the point on the screw axis that is closest to the origin instead of the moment of the screw axis. For this, ScrewFormatScrewFormatScrewFormatscrewFormatscrew_format must be set to 'point'"point""point""point""point". In this case, the coordinates of the point are returned in AxisMomentOrPointXAxisMomentOrPointXAxisMomentOrPointXaxisMomentOrPointXaxis_moment_or_point_x, AxisMomentOrPointYAxisMomentOrPointYAxisMomentOrPointYaxisMomentOrPointYaxis_moment_or_point_y, and AxisMomentOrPointZAxisMomentOrPointZAxisMomentOrPointZaxisMomentOrPointZaxis_moment_or_point_z.

Attention

dual_quat_to_screwdual_quat_to_screwDualQuatToScrewDualQuatToScrewdual_quat_to_screw assumes that the input DualQuaternionDualQuaternionDualQuaterniondualQuaterniondual_quaternion is a unit dual quaternion, and hence represents a 3D rigid transformation. Otherwise the returned screw parameters are not meaningful. Further note that the screw axis for an identity transformation, i.e., no rotation and no translation, is undefined. In this case is arbitrarily set to .

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

DualQuaternionDualQuaternionDualQuaterniondualQuaterniondual_quaternion (input_control)  dual_quaternion → HDualQuaternion, HTupleSequence[float]HTupleHtuple (real) (double) (double) (double)

Unit dual quaternion.

ScrewFormatScrewFormatScrewFormatscrewFormatscrew_format (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Format of the screw parameters.

Default: 'moment' "moment" "moment" "moment" "moment"

List of values: 'moment'"moment""moment""moment""moment", 'point'"point""point""point""point"

AxisDirectionXAxisDirectionXAxisDirectionXaxisDirectionXaxis_direction_x (output_control)  point3d.x → HTuplefloatHTupleHtuple (real) (double) (double) (double)

X component of the direction vector of the screw axis.

AxisDirectionYAxisDirectionYAxisDirectionYaxisDirectionYaxis_direction_y (output_control)  point3d.y → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Y component of the direction vector of the screw axis.

AxisDirectionZAxisDirectionZAxisDirectionZaxisDirectionZaxis_direction_z (output_control)  point3d.z → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Z component of the direction vector of the screw axis.

AxisMomentOrPointXAxisMomentOrPointXAxisMomentOrPointXaxisMomentOrPointXaxis_moment_or_point_x (output_control)  point3d.x → HTuplefloatHTupleHtuple (real) (double) (double) (double)

X component of the moment vector or a point on the screw axis.

AxisMomentOrPointYAxisMomentOrPointYAxisMomentOrPointYaxisMomentOrPointYaxis_moment_or_point_y (output_control)  point3d.y → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Y component of the moment vector or a point on the screw axis.

AxisMomentOrPointZAxisMomentOrPointZAxisMomentOrPointZaxisMomentOrPointZaxis_moment_or_point_z (output_control)  point3d.z → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Z component of the moment vector or a point on the screw axis.

RotationRotationRotationrotationrotation (output_control)  angle.rad → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Rotation angle in radians.

TranslationTranslationTranslationtranslationtranslation (output_control)  real → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Translation.

Possible Predecessors

dual_quat_composedual_quat_composeDualQuatComposeDualQuatComposedual_quat_compose, dual_quat_conjugatedual_quat_conjugateDualQuatConjugateDualQuatConjugatedual_quat_conjugate, dual_quat_interpolatedual_quat_interpolateDualQuatInterpolateDualQuatInterpolatedual_quat_interpolate

Alternatives

dual_quat_to_posedual_quat_to_poseDualQuatToPoseDualQuatToPosedual_quat_to_pose, dual_quat_to_hom_mat3ddual_quat_to_hom_mat3dDualQuatToHomMat3dDualQuatToHomMat3ddual_quat_to_hom_mat3d

See also

pose_to_dual_quatpose_to_dual_quatPoseToDualQuatPoseToDualQuatpose_to_dual_quat, dual_quat_normalizedual_quat_normalizeDualQuatNormalizeDualQuatNormalizedual_quat_normalize, serialize_dual_quatserialize_dual_quatSerializeDualQuatSerializeDualQuatserialize_dual_quat, deserialize_dual_quatdeserialize_dual_quatDeserializeDualQuatDeserializeDualQuatdeserialize_dual_quat, dual_quat_trans_line_3ddual_quat_trans_line_3dDualQuatTransLine3dDualQuatTransLine3ddual_quat_trans_line_3d, dual_quat_trans_point_3ddual_quat_trans_point_3dDualQuatTransPoint3dDualQuatTransPoint3ddual_quat_trans_point_3d, screw_to_dual_quatscrew_to_dual_quatScrewToDualQuatScrewToDualQuatscrew_to_dual_quat

Module

Foundation

ClassesClasses | | Operators