Class Spinnaker::Scan3DParameters¶

ClassList > Spinnaker > Scan3DParameters

#include <Scan3DParameters.h>

Inherits the following classes: Spinnaker::IScan3DParameters

Public Functions¶

Type	Name
void	FromStereoCameraParameters (const StereoCameraParameters & params)
std::map< Scan3dCoordinateSelectorEnums, CoordinateDependentParams >	GetAllCoordinateParams () const
float64_t	GetAxisMax (Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC) const
float64_t	GetAxisMin (Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC) const
virtual float64_t	GetBaseline () const
float64_t	GetCoordinateOffset (Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC) const
CoordinateDependentParams	GetCoordinateParams (Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC) const
virtual Scan3dCoordinateReferenceSelectorEnums	GetCoordinateReferenceSelector () const
virtual float64_t	GetCoordinateReferenceValue () const
float64_t	GetCoordinateScale (Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC) const
virtual Scan3dCoordinateSelectorEnums	GetCoordinateSelector () const
virtual Scan3dCoordinateSystemEnums	GetCoordinateSystem () const
virtual Scan3dCoordinateSystemReferenceEnums	GetCoordinateSystemReference () const
virtual Scan3dCoordinateTransformSelectorEnums	GetCoordinateTransformSelector () const
virtual Scan3dDistanceUnitEnums	GetDistanceUnit () const
virtual float64_t	GetFocalLength () const
bool	GetInvalidDataFlag (Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC) const
float64_t	GetInvalidDataValue (Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC) const
virtual Scan3dOutputModeEnums	GetOutputMode () const
virtual float64_t	GetPrincipalPointU () const
virtual float64_t	GetPrincipalPointV () const
virtual float64_t	GetTransformValue () const
	Scan3DParameters ()
	Scan3DParameters (GenApi::INodeMap & nodeMap)
	Scan3DParameters (const Scan3DParameters & src)
void	SetAllCoordinateParams (const std::map< Scan3dCoordinateSelectorEnums, CoordinateDependentParams > & params)
void	SetAxisMax (float64_t value, Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC)
void	SetAxisMin (float64_t value, Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC)
virtual void	SetBaseline (float64_t value)
void	SetCoordinateOffset (float64_t value, Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC)
void	SetCoordinateParams (const CoordinateDependentParams & params, Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC)
virtual void	SetCoordinateReferenceSelector (Scan3dCoordinateReferenceSelectorEnums value)
virtual void	SetCoordinateReferenceValue (float64_t value)
void	SetCoordinateScale (float64_t value, Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC)
virtual void	SetCoordinateSelector (Scan3dCoordinateSelectorEnums value)
virtual void	SetCoordinateSystem (Scan3dCoordinateSystemEnums value)
virtual void	SetCoordinateSystemReference (Scan3dCoordinateSystemReferenceEnums value)
virtual void	SetCoordinateTransformSelector (Scan3dCoordinateTransformSelectorEnums value)
virtual void	SetDistanceUnit (Scan3dDistanceUnitEnums value)
virtual void	SetFocalLength (float64_t value)
void	SetInvalidDataFlag (bool value, Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC)
void	SetInvalidDataValue (float64_t value, Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC)
virtual void	SetOutputMode (Scan3dOutputModeEnums value)
virtual void	SetPrincipalPointU (float64_t value)
virtual void	SetPrincipalPointV (float64_t value)
virtual void	SetScan3DParameters (GenApi::INodeMap & pNodeMap)
virtual void	SetTransformValue (float64_t value)
StereoCameraParameters	ToStereoCameraParameters () const
Scan3DParameters &	operator= (const Scan3DParameters & scan)
virtual	~Scan3DParameters (void)

Public Functions inherited from Spinnaker::IScan3DParameters¶

See Spinnaker::IScan3DParameters

Type	Name
virtual float64_t	GetBaseline () const = 0
virtual Scan3dCoordinateReferenceSelectorEnums	GetCoordinateReferenceSelector () const = 0
virtual float64_t	GetCoordinateReferenceValue () const = 0
virtual Scan3dCoordinateSelectorEnums	GetCoordinateSelector () const = 0
virtual Scan3dCoordinateSystemEnums	GetCoordinateSystem () const = 0
virtual Scan3dCoordinateSystemReferenceEnums	GetCoordinateSystemReference () const = 0
virtual Scan3dCoordinateTransformSelectorEnums	GetCoordinateTransformSelector () const = 0
virtual Scan3dDistanceUnitEnums	GetDistanceUnit () const = 0
virtual float64_t	GetFocalLength () const = 0
virtual Scan3dOutputModeEnums	GetOutputMode () const = 0
virtual float64_t	GetPrincipalPointU () const = 0
virtual float64_t	GetPrincipalPointV () const = 0
virtual float64_t	GetTransformValue () const = 0
virtual void	SetBaseline (float64_t value) = 0
virtual void	SetCoordinateReferenceSelector (Scan3dCoordinateReferenceSelectorEnums value) = 0
virtual void	SetCoordinateReferenceValue (float64_t value) = 0
virtual void	SetCoordinateSelector (Scan3dCoordinateSelectorEnums value) = 0
virtual void	SetCoordinateSystem (Scan3dCoordinateSystemEnums value) = 0
virtual void	SetCoordinateSystemReference (Scan3dCoordinateSystemReferenceEnums value) = 0
virtual void	SetCoordinateTransformSelector (Scan3dCoordinateTransformSelectorEnums value) = 0
virtual void	SetDistanceUnit (Scan3dDistanceUnitEnums value) = 0
virtual void	SetFocalLength (float64_t value) = 0
virtual void	SetOutputMode (Scan3dOutputModeEnums value) = 0
virtual void	SetPrincipalPointU (float64_t value) = 0
virtual void	SetPrincipalPointV (float64_t value) = 0
virtual void	SetScan3DParameters (GenApi::INodeMap & pNodeMap) = 0
virtual void	SetTransformValue (float64_t value) = 0
virtual	~IScan3DParameters ()

Protected Attributes inherited from Spinnaker::IScan3DParameters¶

See Spinnaker::IScan3DParameters

Type	Name
Scan3DParametersData *	m_pScan3DParametersData

Protected Functions inherited from Spinnaker::IScan3DParameters¶

See Spinnaker::IScan3DParameters

Type	Name
	IScan3DParameters ()

Public Functions Documentation¶

function FromStereoCameraParameters¶

void Spinnaker::Scan3DParameters::FromStereoCameraParameters (
    const StereoCameraParameters & params
)

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

function GetAllCoordinateParams¶

std::map< Scan3dCoordinateSelectorEnums , CoordinateDependentParams > Spinnaker::Scan3DParameters::GetAllCoordinateParams () const

Get coordinate-dependent parameters for all coordinate axes.

Returns:

Map of coordinate selector to parameters

function GetAxisMax¶

float64_t Spinnaker::Scan3DParameters::GetAxisMax (
    Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC
) const

Description: Maximum valid transmitted coordinate value of the selected Axis.

Parameters:

coordinate The coordinate axis (defaults to CoordinateC)

Returns:

The parameter value for the specified coordinate

function GetAxisMin¶

float64_t Spinnaker::Scan3DParameters::GetAxisMin (
    Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC
) const

Description: Minimum valid transmitted coordinate value of the selected Axis.

Parameters:

coordinate The coordinate axis (defaults to CoordinateC)

Returns:

The parameter value for the specified coordinate

function GetBaseline¶

virtual float64_t Spinnaker::Scan3DParameters::GetBaseline () const

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

Implements Spinnaker::IScan3DParameters::GetBaseline

function GetCoordinateOffset¶

float64_t Spinnaker::Scan3DParameters::GetCoordinateOffset (
    Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC
) const

Description: Offset when transforming a pixel from relative coordinates to world coordinates. In terms of disparity computation, it is equivalent to minimum disparity.

Parameters:

coordinate The coordinate axis (defaults to CoordinateC)

Returns:

The parameter value for the specified coordinate

function GetCoordinateParams¶

CoordinateDependentParams Spinnaker::Scan3DParameters::GetCoordinateParams (
    Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC
) const

Get all coordinate-dependent parameters for a specific coordinate axis.

Parameters:

coordinate The coordinate axis (defaults to CoordinateC)

Returns:

Structure containing all coordinate-dependent parameters

function GetCoordinateReferenceSelector¶

virtual Scan3dCoordinateReferenceSelectorEnums Spinnaker::Scan3DParameters::GetCoordinateReferenceSelector () const

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

Implements Spinnaker::IScan3DParameters::GetCoordinateReferenceSelector

function GetCoordinateReferenceValue¶

virtual float64_t Spinnaker::Scan3DParameters::GetCoordinateReferenceValue () const

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

Implements Spinnaker::IScan3DParameters::GetCoordinateReferenceValue

function GetCoordinateScale¶

float64_t Spinnaker::Scan3DParameters::GetCoordinateScale (
    Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC
) const

Description: Displays the Scale factor when transforming a pixel from relative coordinates to world coordinates.

Parameters:

coordinate The coordinate axis (defaults to CoordinateC)

Returns:

The parameter value for the specified coordinate

function GetCoordinateSelector¶

virtual Scan3dCoordinateSelectorEnums Spinnaker::Scan3DParameters::GetCoordinateSelector () const

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

Implements Spinnaker::IScan3DParameters::GetCoordinateSelector

function GetCoordinateSystem¶

virtual Scan3dCoordinateSystemEnums Spinnaker::Scan3DParameters::GetCoordinateSystem () const

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

Implements Spinnaker::IScan3DParameters::GetCoordinateSystem

function GetCoordinateSystemReference¶

virtual Scan3dCoordinateSystemReferenceEnums Spinnaker::Scan3DParameters::GetCoordinateSystemReference () const

Description: Defines coordinate system reference location. Visibility: Expert

Implements Spinnaker::IScan3DParameters::GetCoordinateSystemReference

function GetCoordinateTransformSelector¶

virtual Scan3dCoordinateTransformSelectorEnums Spinnaker::Scan3DParameters::GetCoordinateTransformSelector () const

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

Implements Spinnaker::IScan3DParameters::GetCoordinateTransformSelector

function GetDistanceUnit¶

virtual Scan3dDistanceUnitEnums Spinnaker::Scan3DParameters::GetDistanceUnit () const

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

Implements Spinnaker::IScan3DParameters::GetDistanceUnit

function GetFocalLength¶

virtual float64_t Spinnaker::Scan3DParameters::GetFocalLength () const

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

Implements Spinnaker::IScan3DParameters::GetFocalLength

function GetInvalidDataFlag¶

bool Spinnaker::Scan3DParameters::GetInvalidDataFlag (
    Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC
) const

Description: Enables the definition of a non-valid flag value in the data stream.

Parameters:

coordinate The coordinate axis (defaults to CoordinateC)

Returns:

The parameter value for the specified coordinate

function GetInvalidDataValue¶

float64_t Spinnaker::Scan3DParameters::GetInvalidDataValue (
    Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC
) const

Description: Value which identifies a non-valid pixel if Scan3dInvalidDataFlag is enabled.

Parameters:

coordinate The coordinate axis (defaults to CoordinateC)

Returns:

The parameter value for the specified coordinate

function GetOutputMode¶

virtual Scan3dOutputModeEnums Spinnaker::Scan3DParameters::GetOutputMode () const

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

Implements Spinnaker::IScan3DParameters::GetOutputMode

function GetPrincipalPointU¶

virtual float64_t Spinnaker::Scan3DParameters::GetPrincipalPointU () const

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

Implements Spinnaker::IScan3DParameters::GetPrincipalPointU

function GetPrincipalPointV¶

virtual float64_t Spinnaker::Scan3DParameters::GetPrincipalPointV () const

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

Implements Spinnaker::IScan3DParameters::GetPrincipalPointV

function GetTransformValue¶

virtual float64_t Spinnaker::Scan3DParameters::GetTransformValue () const

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

Implements Spinnaker::IScan3DParameters::GetTransformValue

function Scan3DParameters [1/3]¶

Spinnaker::Scan3DParameters::Scan3DParameters ()

function Scan3DParameters [2/3]¶

Spinnaker::Scan3DParameters::Scan3DParameters (
    GenApi::INodeMap & nodeMap
)

function Scan3DParameters [3/3]¶

Spinnaker::Scan3DParameters::Scan3DParameters (
    const Scan3DParameters & src
)

function SetAllCoordinateParams¶

void Spinnaker::Scan3DParameters::SetAllCoordinateParams (
    const std::map< Scan3dCoordinateSelectorEnums , CoordinateDependentParams > & params
)

Set coordinate-dependent parameters for all coordinate axes at once.

Parameters:

params Map of coordinate selector to parameters

function SetAxisMax¶

void Spinnaker::Scan3DParameters::SetAxisMax (
    float64_t value,
    Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC
)

Description: Maximum valid transmitted coordinate value of the selected Axis.

Parameters:

value The value to set
coordinate The coordinate axis (defaults to CoordinateC)

function SetAxisMin¶

void Spinnaker::Scan3DParameters::SetAxisMin (
    float64_t value,
    Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC
)

Description: Minimum valid transmitted coordinate value of the selected Axis.

Parameters:

value The value to set
coordinate The coordinate axis (defaults to CoordinateC)

function SetBaseline¶

virtual void Spinnaker::Scan3DParameters::SetBaseline (
    float64_t value
)

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

Implements Spinnaker::IScan3DParameters::SetBaseline

function SetCoordinateOffset¶

void Spinnaker::Scan3DParameters::SetCoordinateOffset (
    float64_t value,
    Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC
)

Description: Offset when transforming a pixel from relative coordinates to world coordinates. In terms of disparity computation, it is equivalent to minimum disparity.

Parameters:

value The value to set
coordinate The coordinate axis (defaults to CoordinateC)

function SetCoordinateParams¶

void Spinnaker::Scan3DParameters::SetCoordinateParams (
    const CoordinateDependentParams & params,
    Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC
)

Set all coordinate-dependent parameters for a specific coordinate axis.

Parameters:

params Structure containing all coordinate-dependent parameters
coordinate The coordinate axis (defaults to CoordinateC)

function SetCoordinateReferenceSelector¶

virtual void Spinnaker::Scan3DParameters::SetCoordinateReferenceSelector (
    Scan3dCoordinateReferenceSelectorEnums value
)

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

Implements Spinnaker::IScan3DParameters::SetCoordinateReferenceSelector

function SetCoordinateReferenceValue¶

virtual void Spinnaker::Scan3DParameters::SetCoordinateReferenceValue (
    float64_t value
)

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

Implements Spinnaker::IScan3DParameters::SetCoordinateReferenceValue

function SetCoordinateScale¶

void Spinnaker::Scan3DParameters::SetCoordinateScale (
    float64_t value,
    Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC
)

Description: Displays the Scale factor when transforming a pixel from relative coordinates to world coordinates.

Parameters:

value The value to set
coordinate The coordinate axis (defaults to CoordinateC)

function SetCoordinateSelector¶

virtual void Spinnaker::Scan3DParameters::SetCoordinateSelector (
    Scan3dCoordinateSelectorEnums value
)

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

Implements Spinnaker::IScan3DParameters::SetCoordinateSelector

function SetCoordinateSystem¶

virtual void Spinnaker::Scan3DParameters::SetCoordinateSystem (
    Scan3dCoordinateSystemEnums value
)

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

Implements Spinnaker::IScan3DParameters::SetCoordinateSystem

function SetCoordinateSystemReference¶

virtual void Spinnaker::Scan3DParameters::SetCoordinateSystemReference (
    Scan3dCoordinateSystemReferenceEnums value
)

Description: Defines coordinate system reference location. Visibility: Expert

Implements Spinnaker::IScan3DParameters::SetCoordinateSystemReference

function SetCoordinateTransformSelector¶

virtual void Spinnaker::Scan3DParameters::SetCoordinateTransformSelector (
    Scan3dCoordinateTransformSelectorEnums value
)

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

Implements Spinnaker::IScan3DParameters::SetCoordinateTransformSelector

function SetDistanceUnit¶

virtual void Spinnaker::Scan3DParameters::SetDistanceUnit (
    Scan3dDistanceUnitEnums value
)

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

Implements Spinnaker::IScan3DParameters::SetDistanceUnit

function SetFocalLength¶

virtual void Spinnaker::Scan3DParameters::SetFocalLength (
    float64_t value
)

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

Implements Spinnaker::IScan3DParameters::SetFocalLength

function SetInvalidDataFlag¶

void Spinnaker::Scan3DParameters::SetInvalidDataFlag (
    bool value,
    Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC
)

Description: Enables the definition of a non-valid flag value in the data stream.

Parameters:

value The value to set
coordinate The coordinate axis (defaults to CoordinateC)

function SetInvalidDataValue¶

void Spinnaker::Scan3DParameters::SetInvalidDataValue (
    float64_t value,
    Scan3dCoordinateSelectorEnums coordinate=Scan3dCoordinateSelector_CoordinateC
)

Description: Value which identifies a non-valid pixel if Scan3dInvalidDataFlag is enabled.

Parameters:

value The value to set
coordinate The coordinate axis (defaults to CoordinateC)

function SetOutputMode¶

virtual void Spinnaker::Scan3DParameters::SetOutputMode (
    Scan3dOutputModeEnums value
)

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

Implements Spinnaker::IScan3DParameters::SetOutputMode

function SetPrincipalPointU¶

virtual void Spinnaker::Scan3DParameters::SetPrincipalPointU (
    float64_t value
)

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

Implements Spinnaker::IScan3DParameters::SetPrincipalPointU

function SetPrincipalPointV¶

virtual void Spinnaker::Scan3DParameters::SetPrincipalPointV (
    float64_t value
)

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

Implements Spinnaker::IScan3DParameters::SetPrincipalPointV

function SetScan3DParameters¶

virtual void Spinnaker::Scan3DParameters::SetScan3DParameters (
    GenApi::INodeMap & pNodeMap
)

Implements Spinnaker::IScan3DParameters::SetScan3DParameters

function SetTransformValue¶

virtual void Spinnaker::Scan3DParameters::SetTransformValue (
    float64_t value
)

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

Implements Spinnaker::IScan3DParameters::SetTransformValue

function ToStereoCameraParameters¶

StereoCameraParameters Spinnaker::Scan3DParameters::ToStereoCameraParameters () const

Convert Scan3D data to StereoCameraParameters struct. For backward compatibility with legacy stereo processing code.

function operator=¶

Scan3DParameters & Spinnaker::Scan3DParameters::operator= (
    const Scan3DParameters & scan
)

function ~Scan3DParameters¶

virtual Spinnaker::Scan3DParameters::~Scan3DParameters (
    void
)

Friends Documentation¶

friend Scan3DParametersImpl¶

class Spinnaker::Scan3DParameters::Scan3DParametersImpl (
    Scan3DParametersImpl
)

The documentation for this class was generated from the following file C:/workspace/include/Scan3DParameters.h