PySpin.Scan3DParameters¶

class Scan3DParameters(*args)¶

FromStereoCameraParameters(self, params)¶: Parameters¶

params: Spinnaker::StereoCameraParameters const &

Populate Scan3D data from StereoCameraParameters struct. For backward compatibility with legacy stereo processing code.

GetAllCoordinateParams(self) → std::map< Spinnaker::Scan3dCoordinateSelectorEnums,Spinnaker::CoordinateDependentParams >¶

GetAxisMax(self, coordinate=Scan3dCoordinateSelector_CoordinateC) → float64_t¶: Parameters¶

coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums

GetAxisMin(self, coordinate=Scan3dCoordinateSelector_CoordinateC) → float64_t¶: Parameters¶

coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums

GetBaseline(self) → float64_t¶: Description: Displays the baseline in meters as the physical distance of two image sensors in the stereo camera. Visibility:

GetCoordinateOffset(self, coordinate=Scan3dCoordinateSelector_CoordinateC) → float64_t¶: Parameters¶

coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums

GetCoordinateParams(self, coordinate=Scan3dCoordinateSelector_CoordinateC) → CoordinateDependentParams¶: Parameters¶

coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums

GetCoordinateReferenceSelector(self) → Spinnaker::Scan3dCoordinateReferenceSelectorEnums¶: Description: Sets the index to read a coordinate system reference value defining the transform of a point from the current (Anchor or Transformed) system to the reference system. Visibility: Expert

GetCoordinateReferenceValue(self) → float64_t¶: Description: Returns the reference value selected. Reads the value of a rotation or translation value for the current (Anchor or Transformed) coordinate system transformation to the Reference system. Visibility: Expert

GetCoordinateScale(self, coordinate=Scan3dCoordinateSelector_CoordinateC) → float64_t¶: Parameters¶

coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums

GetCoordinateSelector(self) → Spinnaker::Scan3dCoordinateSelectorEnums¶: Description: Selects the individual coordinates in the vectors for 3D information/transformation. Visibility: Expert

GetCoordinateSystem(self) → Spinnaker::Scan3dCoordinateSystemEnums¶: Description: Specifies the Coordinate system to use for the device. Visibility: Expert

GetCoordinateSystemReference(self) → Spinnaker::Scan3dCoordinateSystemReferenceEnums¶: Description: Defines coordinate system reference location. Visibility: Expert

GetCoordinateTransformSelector(self) → Spinnaker::Scan3dCoordinateTransformSelectorEnums¶: Description: Sets the index to read/write a coordinate transform value. Visibility: Expert

GetDistanceUnit(self) → Spinnaker::Scan3dDistanceUnitEnums¶: Description: Specifies the unit used when delivering (calibrated) distance data. Visibility: Expert

GetFocalLength(self) → float64_t¶: Description: Displays the focal length of the camera in pixels. Visibility:

GetInvalidDataFlag(self, coordinate=Scan3dCoordinateSelector_CoordinateC) → bool¶: Parameters¶

coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums

GetInvalidDataValue(self, coordinate=Scan3dCoordinateSelector_CoordinateC) → float64_t¶: Parameters¶

coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums

GetOutputMode(self) → Spinnaker::Scan3dOutputModeEnums¶: Description: Controls the Calibration and data organization of the device and the coordinates transmitted. Visibility: Expert

GetPrincipalPointU(self) → float64_t¶: Description: Displays the value of the horizontal position of the principal point, relative to the region origin, i.e. OffsetX . Visibility:

GetPrincipalPointV(self) → float64_t¶: Description: Displays the value of the vertical position of the principal point, relative to the region origin, i.e. OffsetY. Visibility:

GetTransformValue(self) → float64_t¶: Description: Specifies the transform value selected. For translations (Scan3dCoordinateTransformSelector = TranslationX/Y/Z) it is expressed in the distance unit of the system, for rotations (Scan3dCoordinateTransformSelector =RotationX/Y/Z) in degrees. Visibility: Expert

SetAllCoordinateParams(self, params)¶: Parameters¶

params: std::map< Spinnaker::Scan3dCoordinateSelectorEnums,Spinnaker::CoordinateDependentParams > const &

SetAxisMax(self, value, coordinate=Scan3dCoordinateSelector_CoordinateC)¶: Parameters¶

value: float64_t coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums

SetAxisMin(self, value, coordinate=Scan3dCoordinateSelector_CoordinateC)¶: Parameters¶

value: float64_t coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums

SetBaseline(self, value)¶: Parameters¶

value: float64_t

Description: Displays the baseline in meters as the physical distance of two image sensors in the stereo camera. Visibility:

SetCoordinateOffset(self, value, coordinate=Scan3dCoordinateSelector_CoordinateC)¶: Parameters¶

value: float64_t coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums

SetCoordinateParams(self, params, coordinate=Scan3dCoordinateSelector_CoordinateC)¶: Parameters¶

params: Spinnaker::CoordinateDependentParams const & coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums

SetCoordinateReferenceSelector(self, value)¶: Parameters¶

value: enum Spinnaker::Scan3dCoordinateReferenceSelectorEnums

Description: Sets the index to read a coordinate system reference value defining the transform of a point from the current (Anchor or Transformed) system to the reference system. Visibility: Expert

SetCoordinateReferenceValue(self, value)¶: Parameters¶

value: float64_t

Description: Returns the reference value selected. Reads the value of a rotation or translation value for the current (Anchor or Transformed) coordinate system transformation to the Reference system. Visibility: Expert

SetCoordinateScale(self, value, coordinate=Scan3dCoordinateSelector_CoordinateC)¶: Parameters¶

value: float64_t coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums

SetCoordinateSelector(self, value)¶: Parameters¶

value: enum Spinnaker::Scan3dCoordinateSelectorEnums

Description: Selects the individual coordinates in the vectors for 3D information/transformation. Visibility: Expert

SetCoordinateSystem(self, value)¶: Parameters¶

value: enum Spinnaker::Scan3dCoordinateSystemEnums

Description: Specifies the Coordinate system to use for the device. Visibility: Expert

SetCoordinateSystemReference(self, value)¶: Parameters¶

value: enum Spinnaker::Scan3dCoordinateSystemReferenceEnums

Description: Defines coordinate system reference location. Visibility: Expert

SetCoordinateTransformSelector(self, value)¶: Parameters¶

value: enum Spinnaker::Scan3dCoordinateTransformSelectorEnums

Description: Sets the index to read/write a coordinate transform value. Visibility: Expert

SetDistanceUnit(self, value)¶: Parameters¶

value: enum Spinnaker::Scan3dDistanceUnitEnums

Description: Specifies the unit used when delivering (calibrated) distance data. Visibility: Expert

SetFocalLength(self, value)¶: Parameters¶

value: float64_t

Description: Displays the focal length of the camera in pixels. Visibility:

SetInvalidDataFlag(self, value, coordinate=Scan3dCoordinateSelector_CoordinateC)¶: Parameters¶

value: bool coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums

SetInvalidDataValue(self, value, coordinate=Scan3dCoordinateSelector_CoordinateC)¶: Parameters¶

value: float64_t coordinate: enum Spinnaker::Scan3dCoordinateSelectorEnums

SetOutputMode(self, value)¶: Parameters¶

value: enum Spinnaker::Scan3dOutputModeEnums

Description: Controls the Calibration and data organization of the device and the coordinates transmitted. Visibility: Expert

SetPrincipalPointU(self, value)¶: Parameters¶

value: float64_t

Description: Displays the value of the horizontal position of the principal point, relative to the region origin, i.e. OffsetX . Visibility:

SetPrincipalPointV(self, value)¶: Parameters¶

value: float64_t

Description: Displays the value of the vertical position of the principal point, relative to the region origin, i.e. OffsetY. Visibility:

SetScan3DParameters(self, pNodeMap)¶: Parameters¶

pNodeMap: Spinnaker::GenApi::INodeMap &

SetTransformValue(self, value)¶: Parameters¶

value: float64_t

Description: Specifies the transform value selected. For translations (Scan3dCoordinateTransformSelector = TranslationX/Y/Z) it is expressed in the distance unit of the system, for rotations (Scan3dCoordinateTransformSelector =RotationX/Y/Z) in degrees. Visibility: Expert

ToStereoCameraParameters(self) → StereoCameraParameters¶: Convert Scan3D data to StereoCameraParameters struct. For backward compatibility with legacy stereo processing code.