eVision.Legacy.EWorldShape Class Reference

Manages a complete context for calibrating a field of view. More...

Inheritance diagram for eVision.Legacy.EWorldShape:

Collaboration diagram for eVision.Legacy.EWorldShape:

Public Member Functions
None	__init__ (self, eVision.Legacy.EWorldShape other)
	Constructs a eVision.Legacy.EWorldShape object.
None	__init__ (self)
	Constructs a eVision.Legacy.EWorldShape object.
None	SetCenterXY (self, float centerX, float centerY)
	Position of the origin point of the reference frame as projected onto the image, i.e.
None	SetSensor (self, int sensorWidth, int sensorHeight, float fieldWidth, float fieldHeight, float centerX, float centerY, float angle, float tiltXAngle, float tiltYAngle, float perspectiveStrength, float distortionStrength, float opticalCenterX, float opticalCenterY, int calibrationModes)
	Initializes the calibration object using all given parameters.
None	SetSensor (self, int sensorWidth, int sensorHeight, float fieldWidth, float fieldHeight, float centerX, float centerY, float angle, float tiltXAngle, float tiltYAngle, float perspectiveStrength, float distortionStrength, float opticalCenterX, float opticalCenterY)
	Initializes the calibration object using all given parameters.
None	SetSensor (self, int sensorWidth, int sensorHeight, float fieldWidth, float fieldHeight, float centerX, float centerY, float angle, float tiltXAngle, float tiltYAngle, float perspectiveStrength, float distortionStrength, float opticalCenterX)
	Initializes the calibration object using all given parameters.
None	SetSensor (self, int sensorWidth, int sensorHeight, float fieldWidth, float fieldHeight, float centerX, float centerY, float angle, float tiltXAngle, float tiltYAngle, float perspectiveStrength, float distortionStrength)
	Initializes the calibration object using all given parameters.
None	SetSensor (self, int sensorWidth, int sensorHeight, float fieldWidth, float fieldHeight, float centerX, float centerY, float angle, float tiltXAngle, float tiltYAngle, float perspectiveStrength)
	Initializes the calibration object using all given parameters.
None	SetSensor (self, int sensorWidth, int sensorHeight, float fieldWidth, float fieldHeight, float centerX, float centerY, float angle, float tiltXAngle, float tiltYAngle)
	Initializes the calibration object using all given parameters.
None	SetSensor (self, int sensorWidth, int sensorHeight, float fieldWidth, float fieldHeight, float centerX, float centerY, float angle, float tiltXAngle)
	Initializes the calibration object using all given parameters.
None	SetSensor (self, int sensorWidth, int sensorHeight, float fieldWidth, float fieldHeight, float centerX, float centerY, float angle)
	Initializes the calibration object using all given parameters.
None	SetSensor (self, int sensorWidth, int sensorHeight, float fieldWidth, float fieldHeight, float centerX, float centerY)
	Initializes the calibration object using all given parameters.
None	SetSensor (self, int sensorWidth, int sensorHeight, float fieldWidth, float fieldHeight, float centerX)
	Initializes the calibration object using all given parameters.
None	SetSensor (self, int sensorWidth, int sensorHeight, float fieldWidth, float fieldHeight)
	Initializes the calibration object using all given parameters.
None	SetSensor (self, int sensorWidth, int sensorHeight, float fieldWidth)
	Initializes the calibration object using all given parameters.
None	SetSensor (self, int sensorWidth, int sensorHeight)
	Initializes the calibration object using all given parameters.
None	SetSensorSize (self, int width, int height)
	Sets the logical image size, i.e.
None	SetFieldSize (self, float width, float height)
	Sets the field of view size in physical units.
None	SetFieldSize (self, float width)
	Sets the field of view size in physical units.
None	SetResolution (self, float resolutionX, float resolutionY)
	Sets the sensor resolution in pixels per unit in both directions.
None	SetResolution (self, float resolutionX)
	Sets the sensor resolution in pixels per unit in both directions.
None	SetPerspective (self, float tiltXAngle, float tiltYAngle, float perspectiveStrength)
	Sets the perspective effect coefficient, i.e.
None	EmptyLandmarks (self)
	Resets the landmark specification sequence.
None	AddPoint (self, eVision.EPoint sensorPoint)
	Adds a new point coordinates (in Sensor space) to the set of grid points used for calibration.
None	AddLandmark (self, eVision.EPoint sensorPoint, eVision.EPoint worldPoint)
	Adds a new pair of points coordinates (in Sensor and World spaces) to the set of landmarks used for calibration.
None	RemoveLandmark (self, int index)
	Removes a landmark.
None	Calibrate (self, int calibrationModes)
	Performs a calibration according to the specified combination of calibration modes.
None	Calibrate (self)
	Performs a calibration according to the specified combination of calibration modes.
int	AutoCalibrate (self, bool testEmpiricalModes)
	Returns the best calibration modes for the current calibration grid and calibrates the field of view accordingly.
int	AutoCalibrate (self)
	Returns the best calibration modes for the current calibration grid and calibrates the field of view accordingly.
int	AutoCalibrate (self, int calibrationModes)
	Returns the best calibration modes for the current calibration grid and calibrates the field of view accordingly.
int	AutoCalibrateLandmarks (self, bool testEmpiricalModes)
	Returns the best calibration modes for the current landmark set and calibrates the field of view accordingly.
int	AutoCalibrateLandmarks (self)
	Returns the best calibration modes for the current landmark set and calibrates the field of view accordingly.
int	AutoCalibrateLandmarks (self, int calibrationModes)
	Returns the best calibration modes for the current landmark set and calibrates the field of view accordingly.
int	AutoCalibrateDotGrid (self, eVision.EROIBW8|None sourceImage, float columnPitch, float rowPitch, bool testEmpiricalModes, bool testAdvancedMode)
	Performs an automatic calibration based on a dot grid image.
int	AutoCalibrateDotGrid (self, eVision.EROIBW8|None sourceImage, float columnPitch, float rowPitch, bool testEmpiricalModes)
	Performs an automatic calibration based on a dot grid image.
int	AutoCalibrateDotGrid (self, eVision.EROIBW8|None sourceImage, float columnPitch, float rowPitch)
	Performs an automatic calibration based on a dot grid image.
int	AutoCalibrateDotGrid (self, eVision.EROIBW8|None sourceImage, float columnPitch, float rowPitch, int enabledCalibrationModes)
	Performs an automatic calibration based on a dot grid image.
bool	CalibrationSucceeded (self)
	Getter method for the CalibrationSucceeded property.
int	RebuildGrid (self, float colPitch, float rowPitch, int centerIndex, bool direct)
	Reconstructs the grid of points from the given dot centers, to compute the World coordinates of the points.
int	RebuildGrid (self, float colPitch, float rowPitch, int centerIndex)
	Reconstructs the grid of points from the given dot centers, to compute the World coordinates of the points.
int	RebuildGrid (self, float colPitch, float rowPitch)
	Reconstructs the grid of points from the given dot centers, to compute the World coordinates of the points.
int	RebuildGrid (self, float colPitch, float rowPitch, eVision.EPoint worldCenter, int centerIndex, bool direct)
	Reconstructs the grid of points from the given dot centers, to compute the World coordinates of the points.
int	RebuildGrid (self, float colPitch, float rowPitch, eVision.EPoint worldCenter, int centerIndex)
	Reconstructs the grid of points from the given dot centers, to compute the World coordinates of the points.
int	RebuildGrid (self, float colPitch, float rowPitch, eVision.EPoint worldCenter)
	Reconstructs the grid of points from the given dot centers, to compute the World coordinates of the points.
None	Unwarp (self, eVision.EROIBW8|None sourceImage, eVision.EROIBW8|None destinationImage, bool interpolate, bool resizeDestination)
	Unwarps a distorted image using the current calibration model.
None	Unwarp (self, eVision.EROIBW8|None sourceImage, eVision.EROIBW8|None destinationImage, bool interpolate)
	Unwarps a distorted image using the current calibration model.
None	Unwarp (self, eVision.EROIBW8|None sourceImage, eVision.EROIBW8|None destinationImage)
	Unwarps a distorted image using the current calibration model.
None	Unwarp (self, eVision.EROIC24|None sourceImage, eVision.EROIC24|None destinationImage, bool interpolate, bool resizeDestination)
	Unwarps a distorted image using the current calibration model.
None	Unwarp (self, eVision.EROIC24|None sourceImage, eVision.EROIC24|None destinationImage, bool interpolate)
	Unwarps a distorted image using the current calibration model.
None	Unwarp (self, eVision.EROIC24|None sourceImage, eVision.EROIC24|None destinationImage)
	Unwarps a distorted image using the current calibration model.
None	Unwarp (self, eVision.EROIBW8|None sourceImage, eVision.EROIBW8|None destinationImage, eVision.ERegion region, bool interpolate, bool resizeDestination)
	Unwarps a distorted image using the current calibration model.
None	Unwarp (self, eVision.EROIBW8|None sourceImage, eVision.EROIBW8|None destinationImage, eVision.ERegion region, bool interpolate)
	Unwarps a distorted image using the current calibration model.
None	Unwarp (self, eVision.EROIBW8|None sourceImage, eVision.EROIBW8|None destinationImage, eVision.ERegion region)
	Unwarps a distorted image using the current calibration model.
None	Unwarp (self, eVision.EROIC24|None sourceImage, eVision.EROIC24|None destinationImage, eVision.ERegion region, bool interpolate, bool resizeDestination)
	Unwarps a distorted image using the current calibration model.
None	Unwarp (self, eVision.EROIC24|None sourceImage, eVision.EROIC24|None destinationImage, eVision.ERegion region, bool interpolate)
	Unwarps a distorted image using the current calibration model.
None	Unwarp (self, eVision.EROIC24|None sourceImage, eVision.EROIC24|None destinationImage, eVision.ERegion region)
	Unwarps a distorted image using the current calibration model.
None	Unwarp (self, eVision.EUnwarpingLut|None lookupTable, eVision.EROIBW8|None sourceImage, eVision.EROIBW8|None destinationImage, bool interpolate)
	Unwarps a distorted image using the current calibration model.
None	Unwarp (self, eVision.EUnwarpingLut|None lookupTable, eVision.EROIBW8|None sourceImage, eVision.EROIBW8|None destinationImage)
	Unwarps a distorted image using the current calibration model.
None	Unwarp (self, eVision.EUnwarpingLut|None lookupTable, eVision.EROIC24|None sourceImage, eVision.EROIC24|None destinationImage, bool interpolate)
	Unwarps a distorted image using the current calibration model.
None	Unwarp (self, eVision.EUnwarpingLut|None lookupTable, eVision.EROIC24|None sourceImage, eVision.EROIC24|None destinationImage)
	Unwarps a distorted image using the current calibration model.
None	Unwarp (self, eVision.EUnwarpingLut|None lookupTable, eVision.EROIBW8|None sourceImage, eVision.EROIBW8|None destinationImage, eVision.ERegion region, bool interpolate)
	Unwarps a distorted image using the current calibration model.
None	Unwarp (self, eVision.EUnwarpingLut|None lookupTable, eVision.EROIBW8|None sourceImage, eVision.EROIBW8|None destinationImage, eVision.ERegion region)
	Unwarps a distorted image using the current calibration model.
None	Unwarp (self, eVision.EUnwarpingLut|None lookupTable, eVision.EROIC24|None sourceImage, eVision.EROIC24|None destinationImage, eVision.ERegion region, bool interpolate)
	Unwarps a distorted image using the current calibration model.
None	Unwarp (self, eVision.EUnwarpingLut|None lookupTable, eVision.EROIC24|None sourceImage, eVision.EROIC24|None destinationImage, eVision.ERegion region)
	Unwarps a distorted image using the current calibration model.
None	SetupUnwarp (self, eVision.EUnwarpingLut|None lookupTable, eVision.EROIBW8|None sourceImage, bool interpolate, bool resizeDestination)
	Prepares a lookup table for fast image unwarping.
None	SetupUnwarp (self, eVision.EUnwarpingLut|None lookupTable, eVision.EROIBW8|None sourceImage, bool interpolate)
	Prepares a lookup table for fast image unwarping.
None	SetupUnwarp (self, eVision.EUnwarpingLut|None lookupTable, eVision.EROIBW8|None sourceImage)
	Prepares a lookup table for fast image unwarping.
None	SetupUnwarp (self, eVision.EUnwarpingLut|None lookupTable, eVision.EROIC24|None sourceImage, bool interpolate, bool resizeDestination)
	Prepares a lookup table for fast image unwarping.
None	SetupUnwarp (self, eVision.EUnwarpingLut|None lookupTable, eVision.EROIC24|None sourceImage, bool interpolate)
	Prepares a lookup table for fast image unwarping.
None	SetupUnwarp (self, eVision.EUnwarpingLut|None lookupTable, eVision.EROIC24|None sourceImage)
	Prepares a lookup table for fast image unwarping.
eVision.Legacy.EWorldShape	GetUnwarpedWorldShape (self, eVision.EBaseROI|None sourceImage, bool resizeDestination)
	Gets a eVision.Legacy.EWorldShape instance representing the transformation of image to world coordinates for the result of eVision.Legacy.EWorldShape.Unwarp.
eVision.Legacy.EWorldShape	GetUnwarpedWorldShape (self, eVision.EBaseROI|None sourceImage)
	Gets a eVision.Legacy.EWorldShape instance representing the transformation of image to world coordinates for the result of eVision.Legacy.EWorldShape.Unwarp.
eVision.Legacy.EWorldShape	GetUnwarpedWorldShape (self, int sourceWidth, int sourceHeight, bool resizeDestination)
	Gets a eVision.Legacy.EWorldShape instance representing the transformation of image to world coordinates for the result of eVision.Legacy.EWorldShape.Unwarp.
eVision.Legacy.EWorldShape	GetUnwarpedWorldShape (self, int sourceWidth, int sourceHeight)
	Gets a eVision.Legacy.EWorldShape instance representing the transformation of image to world coordinates for the result of eVision.Legacy.EWorldShape.Unwarp.
None	Invalidate (self)
eVision.EPoint	SensorToWorld (self, eVision.EPoint sensorPoint)
	Performs coordinate transform for arbitrary points from Sensor space to World space.
eVision.EPoint	WorldToSensor (self, eVision.EPoint worldPoint)
	Performs coordinate transform for arbitrary points from World space to Sensor space.
eVision.ELandmark	GetLandmarkElement (self, int i)
	Returns the landmark element corresponding to the given index.
None	SetOpticalCenter (self, float centerX, float centerY)
None	SetSize (self, float sizeX, float sizeY)
	Sets the frame size.
None	SetSize (self, float sizeX)
	Sets the frame size.
None	Closest (self)
	Find the daughter shape that is the closest to this shape.
bool	HitTest (self, bool bDaughters)
	Checks if there is a handle under the cursor.
bool	HitTest (self)
	Checks if there is a handle under the cursor.
None	Drag (self, int n32CursorX, int n32CursorY)
	Moves a handle to a new position and updates the position parameters of the shape.
None	Draw (self, eVision.EDrawAdapter|None graphicContext, eVision.EDrawingMode drawingModes, bool daughters)
	Draws the world coordinate axis.
None	Draw (self, eVision.EDrawAdapter|None graphicContext, eVision.EDrawingMode drawingModes)
	Draws the world coordinate axis.
None	Draw (self, eVision.EDrawAdapter|None graphicContext)
	Draws the world coordinate axis.
None	DrawCrossGrid (self, eVision.EDrawAdapter|None graphicContext, float minimumX, float maximumX, float minimumY, float maximumY, int numberOfIntervalsX, int numberOfIntervalsY)
	Draws a regular grid of crosses in world coordinates.
None	DrawCrossGrid (self, eVision.EDrawAdapter|None graphicContext, float minimumX, float maximumX, float minimumY, float maximumY, int numberOfIntervalsX)
	Draws a regular grid of crosses in world coordinates.
None	DrawCrossGrid (self, eVision.EDrawAdapter|None graphicContext, float minimumX, float maximumX, float minimumY, float maximumY)
	Draws a regular grid of crosses in world coordinates.
None	DrawCrossGrid (self, eVision.EDrawAdapter|None graphicContext, float minimumX, float maximumX, float minimumY)
	Draws a regular grid of crosses in world coordinates.
None	DrawCrossGrid (self, eVision.EDrawAdapter|None graphicContext, float minimumX, float maximumX)
	Draws a regular grid of crosses in world coordinates.
None	DrawCrossGrid (self, eVision.EDrawAdapter|None graphicContext, float minimumX)
	Draws a regular grid of crosses in world coordinates.
None	DrawCrossGrid (self, eVision.EDrawAdapter|None graphicContext)
	Draws a regular grid of crosses in world coordinates.
None	SetZoom (self, float zoomX, float zoomY)
	Sets the horizontal and vertical zooming factors for drawing operations.
None	SetZoom (self, float zoomX)
	Sets the horizontal and vertical zooming factors for drawing operations.
None	SetZoom (self)
	Sets the horizontal and vertical zooming factors for drawing operations.
None	SetPan (self, float panX, float panY)
	Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.
None	SetPan (self, float panX)
	Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.
None	SetPan (self)
	Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.
None	DrawGrid (self, eVision.EDrawAdapter|None graphicContext)
	Draws the reconstructed grid to be used for grid calibration.
None	DrawLandmarks (self, eVision.EDrawAdapter|None graphicContext)
	Draws the landmarks to be used for landmark calibration.
None	HitLandmarks (self)
	Checks if the cursor is placed over a landmark point.
None	DragLandmark (self, int n32CursorX, int n32CursorY)
	Moves the landmark to a new position.
None	EnableTypeFilter (self, int un32Types)
	Enables the filter of the specified shape type.
None	DisableTypeFilter (self)
	Enables all shape types.
eVision.EPoint	Center (self)
	Position of the origin point of the reference frame as projected onto the image, i.e.
	Center (self, eVision.EPoint value)
	Position of the origin point of the reference frame as projected onto the image, i.e.
float	CenterX (self)
	Horizontal position of the origin point of the reference frame as projected onto the image, i.e.
float	CenterY (self)
	Vertical position of the origin point of the reference frame as projected onto the image, i.e.
float	Angle (self)
	Tilt X angle, that is the amplitude of the rotation applied around the X-axis of the sensor to bring the optical (Z) axis perpendicular to the field of view.
	Angle (self, float value)
	Tilt X angle, that is the amplitude of the rotation applied around the X-axis of the sensor to bring the optical (Z) axis perpendicular to the field of view.
float	Scale (self)
	The scale of the reference frame.
	Scale (self, float value)
	The scale of the reference frame.
float	Ratio (self)
	XResolution/YResolution ratio.
	Ratio (self, float value)
	XResolution/YResolution ratio.
int	SensorWidth (self)
	Logical image width, that is the number of pixels horizontally.
int	SensorHeight (self)
	Logical image height, that is the number of pixels vertically.
float	FieldWidth (self)
	Field-of-view width, in physical units.
float	FieldHeight (self)
	Field-of-view height, in physical units.
float	XResolution (self)
	Horizontal sensor resolution, in pixels per unit.
float	YResolution (self)
	Vertical sensor resolution, in pixels per unit.
float	TiltXAngle (self)
	Tilt X angle, that is the amplitude of the rotation applied around the X-axis of the sensor to bring the optical (Z) axis perpendicular to the field of view.
float	TiltYAngle (self)
	Tilt Y angle, that is the amplitude of the rotation applied around the Y-axis of the sensor to bring the optical (Z) axis perpendicular to the field of view.
float	PerspectiveStrength (self)
	Perspective effect coefficient, that is the inverse of the observation distance.
float	DistortionStrength (self)
	Optical distortion strength, i.e.
	DistortionStrength (self, float value)
	Optical distortion strength, i.e.
int	CalibrationModes (self)
	Current calibration mode, made from a combination of values.
	CalibrationModes (self, int value)
	Current calibration mode, made from a combination of values.
float	GridPointsMeanVariation (self)
	Mean variation of grid points (mean distance between computed grid points and ideal grid points in world space), normalized using the pitch values, after a call to eVision.Legacy.EWorldShape.CalibrationSucceeded.
float	GridPointsMaxVariation (self)
	Maximum variation of grid points (maximum distance between computed grid points and ideal grid points in world space), normalized using the pitch values, after a call to eVision.Legacy.EWorldShape.CalibrationSucceeded.
float	GridPointsMeanVariationThreshold (self)
	Grid points mean variation threshold, that is the value above which the mean variation of grid points (mean distance between computed grid points and ideal grid points in world space) is considered too high, and thus marks the calibration as a failure when using eVision.Legacy.EWorldShape.CalibrationSucceeded.
	GridPointsMeanVariationThreshold (self, float value)
	Grid points mean variation threshold, that is the value above which the mean variation of grid points (mean distance between computed grid points and ideal grid points in world space) is considered too high, and thus marks the calibration as a failure when using eVision.Legacy.EWorldShape.CalibrationSucceeded.
float	GridPointsMaxVariationThreshold (self)
	Grid points maximum variation threshold, that is the value above which the maximum variation of grid points (maximum distance between computed grid points and ideal grid points in world space) is considered too high, and thus marks the calibration as a failure when using eVision.Legacy.EWorldShape.CalibrationSucceeded.
	GridPointsMaxVariationThreshold (self, float value)
	Grid points maximum variation threshold, that is the value above which the maximum variation of grid points (maximum distance between computed grid points and ideal grid points in world space) is considered too high, and thus marks the calibration as a failure when using eVision.Legacy.EWorldShape.CalibrationSucceeded.
int	NumLandmarkElements (self)
	Returns the number of landmark elements.
float	OpticalCenterX (self)
float	OpticalCenterY (self)
eVision.EShapeType	Type (self)
	Shape type.
float	ZoomX (self)
	Current horizontal zooming factor for drawing operations.
float	ZoomY (self)
	Current vertical zooming factor for drawing operations.
float	PanX (self)
	Current horizontal panning value for drawing operations, expressed in pixels.
float	PanY (self)
	Current vertical panning value for drawing operations, expressed in pixels.
int	HitLandmark (self)
	Returns the landmark selected by eVision.Legacy.EWorldShape.HitLandmarks or ~0 if no landmark is selected.
Public Member Functions inherited from eVision.Legacy.EShape
eVision.Legacy.EShape|None	GetShapeNamed (self, str name)
	Returns a pointer to a daughter gauge or shape specified by its name.
bool	GetFound (self)
	Flag indicating whether a measured shape has been found.
bool	GetAutoArrange (self)
None	SetAutoArrange (self, bool bAutoArrange, bool bDaughters)
None	SetAutoArrange (self, bool bAutoArrange)
None	SetFound (self, bool bFound, bool bDaughters)
None	SetFound (self, bool bFound)
bool	GetInspected (self)
None	SetInspected (self, bool bFound, bool bDaughters)
None	SetInspected (self, bool bFound)
bool	GetPassed (self)
None	SetPassed (self, bool bFound, bool bDaughters)
None	SetPassed (self, bool bFound)
bool	GetQuickDraw (self)
None	SetQuickDraw (self, bool bFound, bool bDaughters)
None	SetQuickDraw (self, bool bFound)
bool	GetOptionalDraw (self)
None	SetOptionalDraw (self, bool bFound, bool bDaughters)
None	SetOptionalDraw (self, bool bFound)
bool	GetUserFlag (self)
None	SetUserFlag (self, bool bUserFlag, bool bDaughters)
None	SetUserFlag (self, bool bUserFlag)
bool	GetAllocated (self)
	Gets the allocated flag.
None	EnableBehaviorFilter (self, eVision.EShapeBehavior behavior, bool value)
	Modifies the so-called behavior filter that is a conjunction of conditions specifying when a shape or a gauge should be displayed or taken into consideration when monitoring the mouse interactions.
None	EnableBehaviorFilter (self, eVision.EShapeBehavior behavior)
	Modifies the so-called behavior filter that is a conjunction of conditions specifying when a shape or a gauge should be displayed or taken into consideration when monitoring the mouse interactions.
None	DisableBehaviorFilter (self, eVision.EShapeBehavior behavior)
	Disables (i.e.
None	Attach (self, eVision.Legacy.EShape|None mother)
	Attaches the gauge to a mother gauge or shape.
None	Detach (self)
	Detaches the gauge from its mother gauge or shape.
None	DetachDaughters (self)
	Detaches the daughter gauges or shapes.
eVision.Legacy.EShape|None	GetDaughter (self, int index)
	Returns a pointer to the specified daughter gauge or shape.
bool	IsWorld (self)
None	InvalidateWorld (self)
	Invalidates the world shape for this shape and all its ancestors.
eVision.EPoint	LocalToSensor (self, eVision.EPoint LPoint)
	Transforms a point from local coordinates to sensor coordinates.
eVision.EPoint	SensorToLocal (self, eVision.EPoint SPoint)
	Transforms a point from sensor coordinates to local coordinates.
None	SetDraggingMode (self, eVision.EDraggingMode eDraggingMode, bool bDaughters)
	Sets the dragging mode which defines how the shape could be dragged.
None	SetDraggingMode (self, eVision.EDraggingMode eDraggingMode)
	Sets the dragging mode which defines how the shape could be dragged.
eVision.EDraggingMode	GetDraggingMode (self)
	Gets the dragging mode which defines how the shape could be dragged.
None	SetCursor (self, int x, int y)
	Sets the cursor current coordinates.
None	Process (self, eVision.EROIBW8|None pSrc, bool bDaughters)
None	Process (self, eVision.EROIBW8|None pSrc)
None	Process (self, eVision.EROIBW8|None pSrc, eVision.ERegion region, bool bDaughters)
None	Process (self, eVision.EROIBW8|None pSrc, eVision.ERegion region)
None	Save (self, str path, bool daughters)
	Loads a Shape.The given eVision.ESerializer must have been created for writing.
None	Save (self, str path)
	Loads a Shape.The given eVision.ESerializer must have been created for writing.
None	Save (self, eVision.ESerializer|None serializer, bool daughters)
	Loads a Shape.The given eVision.ESerializer must have been created for writing.
None	Save (self, eVision.ESerializer|None serializer)
	Loads a Shape.The given eVision.ESerializer must have been created for writing.
None	Load (self, str path, bool daughters)
	Loads a Shape.The given eVision.ESerializer must have been created for reading.
None	Load (self, str path)
	Loads a Shape.The given eVision.ESerializer must have been created for reading.
None	Load (self, eVision.ESerializer|None serializer, bool daughters)
	Loads a Shape.The given eVision.ESerializer must have been created for reading.
None	Load (self, eVision.ESerializer|None serializer)
	Loads a Shape.The given eVision.ESerializer must have been created for reading.
bool	HasProperty (self, str aProperty)
	Returns whether a eVision.Legacy.EShape has a property named aProperty.
str	GetProperty (self, str aProperty)
	Gets the value of property aProperty.
None	SetProperty (self, str aProperty, str aValue)
	Sets the value of property aProperty to aValue for this eVision.Legacy.EShape.
None	SetPropertyRecursive (self, str aProperty, str aValue)
	Sets the value of property aProperty to aValue for this eVision.Legacy.EShape and all of its daughters.
None	RemoveProperty (self, str aProperty)
	Removes the property name aProperty from the eVision.Legacy.EShape.
bool	HasValidPolarityProperty (self)
	Returns whether the eVision.Legacy.EShape has a valid polarity property.
str	Name (self)
	Name of the eVision.Legacy.EShape object.
	Name (self, str value)
	Name of the eVision.Legacy.EShape object.
bool	Visible (self)
	Flag indicating whether the shape is visible or not.
	Visible (self, bool value)
	Flag indicating whether the shape is visible or not.
bool	Selected (self)
	Flag indicating whether the shape is selected or not.
	Selected (self, bool value)
	Flag indicating whether the shape is selected or not.
bool	Selectable (self)
	Flag indicating whether the shape can be selected or not.
	Selectable (self, bool value)
	Flag indicating whether the shape can be selected or not.
bool	Dragable (self)
	Flag indicating whether the shape can be dragged or not.
	Dragable (self, bool value)
	Flag indicating whether the shape can be dragged or not.
bool	Resizable (self)
	Flag indicating whether the shape can be resized or not.
	Resizable (self, bool value)
	Flag indicating whether the shape can be resized or not.
bool	Rotatable (self)
	Flag indicating whether the shape can be rotated or not.
	Rotatable (self, bool value)
	Flag indicating whether the shape can be rotated or not.
bool	Labeled (self)
	Flag indicating whether the shape label should be displayed or not.
	Labeled (self, bool value)
	Flag indicating whether the shape label should be displayed or not.
bool	Active (self)
	Flag indicating whether the shape is active or not.
	Active (self, bool value)
	Flag indicating whether the shape is active or not.
bool	ActualShape (self)
	Flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).
	ActualShape (self, bool value)
	Flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).
int	NumDaughters (self)
	Number of daughters attached to the shape.
eVision.Legacy.EShape|None	Mother (self)
	Pointer to the mother shape.
eVision.Legacy.EWorldShape|None	WorldShape (self)
	World ancestor.
eVision.EDragHandle	HitHandle (self)
	Handle currently under the cursor.
eVision.Legacy.EShape|None	HitShape (self)
	Pointer to the shape currently under the cursor.
eVision.Legacy.EShape|None	ClosestShape (self)
	Closest shape among the daughters.

Protected Member Functions
	_Distortion__setter (self, float value)
	Sets the optical distortion parameters.
Protected Member Functions inherited from eVision.Legacy.EShape
	_VisibleRecursive__setter (self, bool value)
	Sets the flag indicating whether the shape and its daughter shapes are visible or not.
	_SelectedRecursive__setter (self, bool value)
	Sets the flag indicating whether the shape and all its daughters are selected or not.
	_SelectableRecursive__setter (self, bool value)
	Sets the flag indicating whether the shape and all its daughters can be selected or not.
	_DragableRecursive__setter (self, bool value)
	Sets the flag indicating whether the shape and all its daughters can be dragged or not.
	_ResizableRecursive__setter (self, bool value)
	Sets the flag indicating whether the shape and all its daughters can be resized or not.
	_RotatableRecursive__setter (self, bool value)
	Sets the flag indicating whether the shape and all its daughters can be rotated or not.
	_LabeledRecursive__setter (self, bool value)
	Sets the flag indicating whether the shape label should be displayed or not.
	_ActiveRecursive__setter (self, bool value)
	Sets the flag indicating whether the shape and all its daughters are active or not.
	_ActualShapeRecursive__setter (self, bool value)
	Sets the flag indicating whether an inquiry returns a result pertaining to the nominal gauge (false, default) or the fitted model (true).

Properties
	Distortion
Properties inherited from eVision.Legacy.EShape
	VisibleRecursive
	SelectedRecursive
	SelectableRecursive
	DragableRecursive
	ResizableRecursive
	RotatableRecursive
	LabeledRecursive
	ActiveRecursive
	ActualShapeRecursive

Detailed Description

Manages a complete context for calibrating a field of view.

Remarks:

License(s): BasicTypes

Constructor & Destructor Documentation

__init__() [1/2]

None eVision.Legacy.EWorldShape.__init__	(		self,
		eVision.Legacy.EWorldShape	other )

Constructs a eVision.Legacy.EWorldShape object.

Parameters

other

Another eVision.Legacy.EWorldShape object to be copied in the new eVision.Legacy.EWorldShape object.

__init__() [2/2]

None eVision.Legacy.EWorldShape.__init__

(

self

)

Constructs a eVision.Legacy.EWorldShape object.

Member Function Documentation

_Distortion__setter()

eVision.Legacy.EWorldShape._Distortion__setter ( self, float value )

protected

Sets the optical distortion parameters.

Remarks:

Deprecated in favor of eVision.Legacy.EWorldShape.DistortionStrength.

Deprecated

Deprecated in version 2.16. Scheduled to be removed in version 27.6.

AddLandmark()

None eVision.Legacy.EWorldShape.AddLandmark	(		self,
		eVision.EPoint	sensorPoint,
		eVision.EPoint	worldPoint )

Adds a new pair of points coordinates (in Sensor and World spaces) to the set of landmarks used for calibration.

Remarks:

Landmark calibration is the process of computing the calibration parameters by means of a set of known points for which the coordinates are available in both World and Sensor spaces. Usually, such points are chosen as salient features on the part or target in view. They must be such that appropriate image processing techniques allow measuring their positions from the image (directly or indirectly by geometric constructions), while at the same time their coordinates in a reference frame are known.

Parameters

sensorPoint	Sensor point coordinates.
worldPoint	Corresponding World point coordinates.

AddPoint()

None eVision.Legacy.EWorldShape.AddPoint	(		self,
		eVision.EPoint	sensorPoint )

Adds a new point coordinates (in Sensor space) to the set of grid points used for calibration.

Remarks:

Grid calibration is the process of computing the calibration parameters by means of a set of points known to lie on a rectangular grid. If the grid pitch is known and one of the points is chosen as the origin point, the points can be used as landmarks. By contrast with the landmark calibration functions, the World coordinates of the grid points need not be specified, nor do they have to be given in any specific order. The calibration algorithm is capable of sorting out the points to reconstruct the grid topology. Typically, this function is used in conjunction with blob analysis to extract the dot centers from a grid of dots. Anyway, any other scheme can be used. The grid of points need not be complete, i.e. some of the nodes may be missing, and the points need not completely fill a rectangular area. Landmark calibration is simply achieved by providing a series of point coordinates (in Sensor space only) and then calling the grid reconstruction function followed by the calibration function.

Parameters

sensorPoint

Sensor point coordinates.

Angle() [1/2]

float eVision.Legacy.EWorldShape.Angle

(

self

)

Tilt X angle, that is the amplitude of the rotation applied around the X-axis of the sensor to bring the optical (Z) axis perpendicular to the field of view.

Remarks:

Tilt X Angle and Tilt Y Angle

Angle() [2/2]

eVision.Legacy.EWorldShape.Angle	(		self,
		float	value )

Tilt X angle, that is the amplitude of the rotation applied around the X-axis of the sensor to bring the optical (Z) axis perpendicular to the field of view.

Remarks:

Tilt X Angle and Tilt Y Angle

AutoCalibrate() [1/3]

int eVision.Legacy.EWorldShape.AutoCalibrate

(

self

)

Returns the best calibration modes for the current calibration grid and calibrates the field of view accordingly.

Remarks:

To ensure a successful calibration, the perspective angle of the view should not exceed 45 degrees.

By default, only combination of the calibration modes eVision.ECalibrationMode.Scaled, eVision.ECalibrationMode.Skewed, eVision.ECalibrationMode.Radial, eVision.ECalibrationMode.Tilted, and eVision.ECalibrationMode.Anisotropic are considered. The eVision.ECalibrationMode.Advanced calibration mode must be explicitely selected to be considered.

AutoCalibrate() [2/3]

int eVision.Legacy.EWorldShape.AutoCalibrate	(		self,
		bool	testEmpiricalModes )

Returns the best calibration modes for the current calibration grid and calibrates the field of view accordingly.

Remarks:

To ensure a successful calibration, the perspective angle of the view should not exceed 45 degrees.

By default, only combination of the calibration modes eVision.ECalibrationMode.Scaled, eVision.ECalibrationMode.Skewed, eVision.ECalibrationMode.Radial, eVision.ECalibrationMode.Tilted, and eVision.ECalibrationMode.Anisotropic are considered. The eVision.ECalibrationMode.Advanced calibration mode must be explicitely selected to be considered.

Parameters

testEmpiricalModes

Boolean indicating whether empirical quadratic calibration mode (eVision.ECalibrationMode.Quadratic) should be considered when determining the best calibration modes.

AutoCalibrate() [3/3]

int eVision.Legacy.EWorldShape.AutoCalibrate	(		self,
		int	calibrationModes )

Returns the best calibration modes for the current calibration grid and calibrates the field of view accordingly.

Remarks:

To ensure a successful calibration, the perspective angle of the view should not exceed 45 degrees.

By default, only combination of the calibration modes eVision.ECalibrationMode.Scaled, eVision.ECalibrationMode.Skewed, eVision.ECalibrationMode.Radial, eVision.ECalibrationMode.Tilted, and eVision.ECalibrationMode.Anisotropic are considered. The eVision.ECalibrationMode.Advanced calibration mode must be explicitely selected to be considered.

Parameters

calibrationModes

Calibration modes that should be considered when determining the best calibration model

AutoCalibrateDotGrid() [1/4]

int eVision.Legacy.EWorldShape.AutoCalibrateDotGrid	(		self,
		eVision.EROIBW8 | None	sourceImage,
		float	columnPitch,
		float	rowPitch )

Performs an automatic calibration based on a dot grid image.

Remarks:

Returns the best calibration mode for the current dot grid. This method will first do an automatic blob analysis in order to extract all dots (all blobs whose area is smaller than 5 pixels or 1/50000th of the whole image area will be considered as noise and rejected). The dot gravity centers are used as the grid reference points. Then, this method will select and compute the best calibration mode by reducing the fitting error. To ensure a successful calibration, the perspective angle of the dot grid should not exceed 45 degrees.

By default, only combination of the calibration modes eVision.ECalibrationMode.Scaled, eVision.ECalibrationMode.Skewed, eVision.ECalibrationMode.Radial, eVision.ECalibrationMode.Tilted, and eVision.ECalibrationMode.Anisotropic are considered. The eVision.ECalibrationMode.Advanced calibration mode must be explicitly selected to be considered.

Parameters

sourceImage	Pointer to the source image/ROI.
columnPitch	Actual pitches of the grid, i.e. distances between vertical and horizontal rows of the grid.
rowPitch	Actual pitches of the grid, i.e. distances between vertical and horizontal rows of the grid.

AutoCalibrateDotGrid() [2/4]

int eVision.Legacy.EWorldShape.AutoCalibrateDotGrid	(		self,
		eVision.EROIBW8 | None	sourceImage,
		float	columnPitch,
		float	rowPitch,
		bool	testEmpiricalModes )

Performs an automatic calibration based on a dot grid image.

Remarks:

Returns the best calibration mode for the current dot grid. This method will first do an automatic blob analysis in order to extract all dots (all blobs whose area is smaller than 5 pixels or 1/50000th of the whole image area will be considered as noise and rejected). The dot gravity centers are used as the grid reference points. Then, this method will select and compute the best calibration mode by reducing the fitting error. To ensure a successful calibration, the perspective angle of the dot grid should not exceed 45 degrees.

By default, only combination of the calibration modes eVision.ECalibrationMode.Scaled, eVision.ECalibrationMode.Skewed, eVision.ECalibrationMode.Radial, eVision.ECalibrationMode.Tilted, and eVision.ECalibrationMode.Anisotropic are considered. The eVision.ECalibrationMode.Advanced calibration mode must be explicitly selected to be considered.

Parameters

sourceImage	Pointer to the source image/ROI.
columnPitch	Actual pitches of the grid, i.e. distances between vertical and horizontal rows of the grid.
rowPitch	Actual pitches of the grid, i.e. distances between vertical and horizontal rows of the grid.
testEmpiricalModes	Boolean indicating whether the empirical quadratic calibration mode (eVision.ECalibrationMode.Quadratic) should be considered when determining the best calibration modes. Default value is false.

AutoCalibrateDotGrid() [3/4]

int eVision.Legacy.EWorldShape.AutoCalibrateDotGrid	(		self,
		eVision.EROIBW8 | None	sourceImage,
		float	columnPitch,
		float	rowPitch,
		bool	testEmpiricalModes,
		bool	testAdvancedMode )

Performs an automatic calibration based on a dot grid image.

Remarks:

Returns the best calibration mode for the current dot grid. This method will first do an automatic blob analysis in order to extract all dots (all blobs whose area is smaller than 5 pixels or 1/50000th of the whole image area will be considered as noise and rejected). The dot gravity centers are used as the grid reference points. Then, this method will select and compute the best calibration mode by reducing the fitting error. To ensure a successful calibration, the perspective angle of the dot grid should not exceed 45 degrees.

By default, only combination of the calibration modes eVision.ECalibrationMode.Scaled, eVision.ECalibrationMode.Skewed, eVision.ECalibrationMode.Radial, eVision.ECalibrationMode.Tilted, and eVision.ECalibrationMode.Anisotropic are considered. The eVision.ECalibrationMode.Advanced calibration mode must be explicitly selected to be considered.

Parameters

sourceImage	Pointer to the source image/ROI.
columnPitch	Actual pitches of the grid, i.e. distances between vertical and horizontal rows of the grid.
rowPitch	Actual pitches of the grid, i.e. distances between vertical and horizontal rows of the grid.
testEmpiricalModes	Boolean indicating whether the empirical quadratic calibration mode (eVision.ECalibrationMode.Quadratic) should be considered when determining the best calibration modes. Default value is false.
testAdvancedMode	Boolean indicating whether the advanced calibration mode (eVision.ECalibrationMode.Advanced) should be considered when determining the best calibration modes. Default value is false.

AutoCalibrateDotGrid() [4/4]

int eVision.Legacy.EWorldShape.AutoCalibrateDotGrid	(		self,
		eVision.EROIBW8 | None	sourceImage,
		float	columnPitch,
		float	rowPitch,
		int	enabledCalibrationModes )

Performs an automatic calibration based on a dot grid image.

Remarks:

Returns the best calibration mode for the current dot grid. This method will first do an automatic blob analysis in order to extract all dots (all blobs whose area is smaller than 5 pixels or 1/50000th of the whole image area will be considered as noise and rejected). The dot gravity centers are used as the grid reference points. Then, this method will select and compute the best calibration mode by reducing the fitting error. To ensure a successful calibration, the perspective angle of the dot grid should not exceed 45 degrees.

By default, only combination of the calibration modes eVision.ECalibrationMode.Scaled, eVision.ECalibrationMode.Skewed, eVision.ECalibrationMode.Radial, eVision.ECalibrationMode.Tilted, and eVision.ECalibrationMode.Anisotropic are considered. The eVision.ECalibrationMode.Advanced calibration mode must be explicitly selected to be considered.

Parameters

sourceImage	Pointer to the source image/ROI.
columnPitch	Actual pitches of the grid, i.e. distances between vertical and horizontal rows of the grid.
rowPitch	Actual pitches of the grid, i.e. distances between vertical and horizontal rows of the grid.
enabledCalibrationModes	Calibration modes that should be considered when determining the best calibration model

AutoCalibrateLandmarks() [1/3]

int eVision.Legacy.EWorldShape.AutoCalibrateLandmarks

(

self

)

Returns the best calibration modes for the current landmark set and calibrates the field of view accordingly.

Remarks:

Landmark calibration is the process of computing the calibration parameters by means of a set of known points for which the coordinates are available in both World and Sensor spaces. Usually, such points are chosen as salient features on the part or target in view. They must be such that appropriate image processing techniques allow measuring their positions from the image (directly or indirectly by geometric constructions), while at the same time their coordinates in a reference frame are known. To ensure a successful calibration, the perspective angle of the view should not exceed 45 degrees. This method is meant to be used with landmark calibration only. To calibrate automatically your field of view using a dot grid, use the eVision.Legacy.EWorldShape.AutoCalibrate method instead.

By default, only combination of the calibration modes eVision.ECalibrationMode.Scaled, eVision.ECalibrationMode.Skewed, eVision.ECalibrationMode.Radial, eVision.ECalibrationMode.Tilted, and eVision.ECalibrationMode.Anisotropic are considered. The eVision.ECalibrationMode.Advanced calibration mode must be explicitely selected to be considered.

AutoCalibrateLandmarks() [2/3]

int eVision.Legacy.EWorldShape.AutoCalibrateLandmarks	(		self,
		bool	testEmpiricalModes )

Returns the best calibration modes for the current landmark set and calibrates the field of view accordingly.

Remarks:

Landmark calibration is the process of computing the calibration parameters by means of a set of known points for which the coordinates are available in both World and Sensor spaces. Usually, such points are chosen as salient features on the part or target in view. They must be such that appropriate image processing techniques allow measuring their positions from the image (directly or indirectly by geometric constructions), while at the same time their coordinates in a reference frame are known. To ensure a successful calibration, the perspective angle of the view should not exceed 45 degrees. This method is meant to be used with landmark calibration only. To calibrate automatically your field of view using a dot grid, use the eVision.Legacy.EWorldShape.AutoCalibrate method instead.

By default, only combination of the calibration modes eVision.ECalibrationMode.Scaled, eVision.ECalibrationMode.Skewed, eVision.ECalibrationMode.Radial, eVision.ECalibrationMode.Tilted, and eVision.ECalibrationMode.Anisotropic are considered. The eVision.ECalibrationMode.Advanced calibration mode must be explicitely selected to be considered.

Parameters

testEmpiricalModes

Boolean indicating whether the empirical quadratic calibration mode (eVision.ECalibrationMode.Quadratic) should be considered when determining the best calibration modes. Default value is false.

AutoCalibrateLandmarks() [3/3]

int eVision.Legacy.EWorldShape.AutoCalibrateLandmarks	(		self,
		int	calibrationModes )

Returns the best calibration modes for the current landmark set and calibrates the field of view accordingly.

Remarks:

Landmark calibration is the process of computing the calibration parameters by means of a set of known points for which the coordinates are available in both World and Sensor spaces. Usually, such points are chosen as salient features on the part or target in view. They must be such that appropriate image processing techniques allow measuring their positions from the image (directly or indirectly by geometric constructions), while at the same time their coordinates in a reference frame are known. To ensure a successful calibration, the perspective angle of the view should not exceed 45 degrees. This method is meant to be used with landmark calibration only. To calibrate automatically your field of view using a dot grid, use the eVision.Legacy.EWorldShape.AutoCalibrate method instead.

By default, only combination of the calibration modes eVision.ECalibrationMode.Scaled, eVision.ECalibrationMode.Skewed, eVision.ECalibrationMode.Radial, eVision.ECalibrationMode.Tilted, and eVision.ECalibrationMode.Anisotropic are considered. The eVision.ECalibrationMode.Advanced calibration mode must be explicitely selected to be considered.

Parameters

calibrationModes

Calibration modes that should be considered when determining the best calibration model

Calibrate() [1/2]

None eVision.Legacy.EWorldShape.Calibrate

(

self

)

Performs a calibration according to the specified combination of calibration modes.

Remarks:

Landmark calibration is the process of computing the calibration parameters by means of a set of known points for which the coordinates are available in both World and Sensor spaces. Usually, such points are chosen as salient features on the part or target in view. They must be such that appropriate image processing techniques allow measuring their positions from the image (directly or indirectly by geometric constructions), while at the same time their coordinates in a reference frame are known. In some cases, not all requested calibration modes are honored. After calibration, eVision.Legacy.EWorldShape.CalibrationModes returns the actual combination of modes in effect. To ensure a successful calibration, the perspective angle of the view should not exceed 45 degrees.

Calibrate() [2/2]

None eVision.Legacy.EWorldShape.Calibrate	(		self,
		int	calibrationModes )

Performs a calibration according to the specified combination of calibration modes.

Remarks:

Landmark calibration is the process of computing the calibration parameters by means of a set of known points for which the coordinates are available in both World and Sensor spaces. Usually, such points are chosen as salient features on the part or target in view. They must be such that appropriate image processing techniques allow measuring their positions from the image (directly or indirectly by geometric constructions), while at the same time their coordinates in a reference frame are known. In some cases, not all requested calibration modes are honored. After calibration, eVision.Legacy.EWorldShape.CalibrationModes returns the actual combination of modes in effect. To ensure a successful calibration, the perspective angle of the view should not exceed 45 degrees.

Parameters

calibrationModes

Calibration modes, as defined by a combination of values from eVision.ECalibrationMode.

CalibrationModes() [1/2]

int eVision.Legacy.EWorldShape.CalibrationModes

(

self

)

Current calibration mode, made from a combination of values.

Remarks:

The supported calibration modes can be set to eVision.ECalibrationMode.Raw, meaning that no calibration at all is performed (the World coordinates are pixel indices), or to the logical sum of other values from eVision.ECalibrationMode.

CalibrationModes() [2/2]

eVision.Legacy.EWorldShape.CalibrationModes	(		self,
		int	value )

Current calibration mode, made from a combination of values.

Remarks:

The supported calibration modes can be set to eVision.ECalibrationMode.Raw, meaning that no calibration at all is performed (the World coordinates are pixel indices), or to the logical sum of other values from eVision.ECalibrationMode.

CalibrationSucceeded()

bool eVision.Legacy.EWorldShape.CalibrationSucceeded

(

self

)

Getter method for the CalibrationSucceeded property.

This property is the flag indicating if the calibration has succeeded (true), that is whether the mean variation of grid points (distance between computed grid points and ideal grid points in world space) and the maximum variation of grid points are between given tolerances.

Remarks:

The mean and maximum grid point variations are normalized using the pitch values. By default, tolerances are set to 0.05 (5 %) for the mean, and 0.1 (10 %) for the maximum grid point variation. You can get and set these tolerances using the eVision.Legacy.EWorldShape.GridPointsMeanVariationThreshold and eVision.Legacy.EWorldShape.GridPointsMaxVariationThreshold properties.

Center() [1/2]

eVision.EPoint eVision.Legacy.EWorldShape.Center

(

self

)

Position of the origin point of the reference frame as projected onto the image, i.e.

the Sensor position of the point at World coordinates (0,0).

Center() [2/2]

eVision.Legacy.EWorldShape.Center	(		self,
		eVision.EPoint	value )

Position of the origin point of the reference frame as projected onto the image, i.e.

the Sensor position of the point at World coordinates (0,0).

CenterX()

float eVision.Legacy.EWorldShape.CenterX

(

self

)

Horizontal position of the origin point of the reference frame as projected onto the image, i.e.

the Sensor abscissa of the point at World coordinates (0,0).

CenterY()

float eVision.Legacy.EWorldShape.CenterY

(

self

)

Vertical position of the origin point of the reference frame as projected onto the image, i.e.

the Sensor ordinate of the point at World coordinates (0,0).

Closest()

None eVision.Legacy.EWorldShape.Closest

(

self

)

Find the daughter shape that is the closest to this shape.

To retrieve the closest shape, use eVision.Legacy.EShape.ClosestShape.

Reimplemented from eVision.Legacy.EShape.

DisableTypeFilter()

None eVision.Legacy.EWorldShape.DisableTypeFilter

(

self

)

Enables all shape types.

Reimplemented from eVision.Legacy.EShape.

DistortionStrength() [1/2]

float eVision.Legacy.EWorldShape.DistortionStrength

(

self

)

Optical distortion strength, i.e.

the ratio of the image diagonal length with and without optical distortion introduced by the lens.

DistortionStrength() [2/2]

eVision.Legacy.EWorldShape.DistortionStrength	(		self,
		float	value )

Optical distortion strength, i.e.

the ratio of the image diagonal length with and without optical distortion introduced by the lens.

Drag()

None eVision.Legacy.EWorldShape.Drag	(		self,
		int	n32CursorX,
		int	n32CursorY )

Moves a handle to a new position and updates the position parameters of the shape.

Parameters

n32CursorX	Current cursor coordinates.
n32CursorY	Current cursor coordinates.

Reimplemented from eVision.Legacy.EShape.

DragLandmark()

None eVision.Legacy.EWorldShape.DragLandmark	(		self,
		int	n32CursorX,
		int	n32CursorY )

Moves the landmark to a new position.

Parameters

n32CursorX	Current cursor coordinates.
n32CursorY	Current cursor coordinates.

Draw() [1/3]

None eVision.Legacy.EWorldShape.Draw	(		self,
		eVision.EDrawAdapter | None	graphicContext )

Draws the world coordinate axis.

Parameters

graphicContext

Handle of the device context on which to draw.

Reimplemented from eVision.Legacy.EShape.

Draw() [2/3]

None eVision.Legacy.EWorldShape.Draw	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		eVision.EDrawingMode	drawingModes )

Draws the world coordinate axis.

Parameters

graphicContext	Handle of the device context on which to draw.
drawingModes	Indicates how the world coordinate axis must be displayed, as defined by eVision.EDrawingMode.

Reimplemented from eVision.Legacy.EShape.

Draw() [3/3]

None eVision.Legacy.EWorldShape.Draw	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		eVision.EDrawingMode	drawingModes,
		bool	daughters )

Draws the world coordinate axis.

Parameters

graphicContext	Handle of the device context on which to draw.
drawingModes	Indicates how the world coordinate axis must be displayed, as defined by eVision.EDrawingMode.
daughters	Indicates whether the daughter shapes are to be displayed as well.

Reimplemented from eVision.Legacy.EShape.

DrawCrossGrid() [1/7]

None eVision.Legacy.EWorldShape.DrawCrossGrid	(		self,
		eVision.EDrawAdapter | None	graphicContext )

Draws a regular grid of crosses in world coordinates.

Parameters

graphicContext

Handle of the device context on which to draw.

DrawCrossGrid() [2/7]

None eVision.Legacy.EWorldShape.DrawCrossGrid	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		float	minimumX )

Draws a regular grid of crosses in world coordinates.

Parameters

graphicContext	Handle of the device context on which to draw.
minimumX	Abscissa of the leftmost crosses, in world coordinates.

DrawCrossGrid() [3/7]

None eVision.Legacy.EWorldShape.DrawCrossGrid	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		float	minimumX,
		float	maximumX )

Draws a regular grid of crosses in world coordinates.

Parameters

graphicContext	Handle of the device context on which to draw.
minimumX	Abscissa of the leftmost crosses, in world coordinates.
maximumX	Abscissa of the rightmost crosses, in world coordinates.

DrawCrossGrid() [4/7]

None eVision.Legacy.EWorldShape.DrawCrossGrid	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		float	minimumX,
		float	maximumX,
		float	minimumY )

Draws a regular grid of crosses in world coordinates.

Parameters

graphicContext	Handle of the device context on which to draw.
minimumX	Abscissa of the leftmost crosses, in world coordinates.
maximumX	Abscissa of the rightmost crosses, in world coordinates.
minimumY	Ordinate of the leftmost crosses, in world coordinates.

DrawCrossGrid() [5/7]

None eVision.Legacy.EWorldShape.DrawCrossGrid	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		float	minimumX,
		float	maximumX,
		float	minimumY,
		float	maximumY )

Draws a regular grid of crosses in world coordinates.

Parameters

graphicContext	Handle of the device context on which to draw.
minimumX	Abscissa of the leftmost crosses, in world coordinates.
maximumX	Abscissa of the rightmost crosses, in world coordinates.
minimumY	Ordinate of the leftmost crosses, in world coordinates.
maximumY	Ordinate of the rightmost crosses, in world coordinates.

DrawCrossGrid() [6/7]

None eVision.Legacy.EWorldShape.DrawCrossGrid	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		float	minimumX,
		float	maximumX,
		float	minimumY,
		float	maximumY,
		int	numberOfIntervalsX )

Draws a regular grid of crosses in world coordinates.

Parameters

graphicContext	Handle of the device context on which to draw.
minimumX	Abscissa of the leftmost crosses, in world coordinates.
maximumX	Abscissa of the rightmost crosses, in world coordinates.
minimumY	Ordinate of the leftmost crosses, in world coordinates.
maximumY	Ordinate of the rightmost crosses, in world coordinates.
numberOfIntervalsX	Number of intervals between crosses along the horizontal direction.

DrawCrossGrid() [7/7]

None eVision.Legacy.EWorldShape.DrawCrossGrid	(		self,
		eVision.EDrawAdapter | None	graphicContext,
		float	minimumX,
		float	maximumX,
		float	minimumY,
		float	maximumY,
		int	numberOfIntervalsX,
		int	numberOfIntervalsY )

Draws a regular grid of crosses in world coordinates.

Parameters

graphicContext	Handle of the device context on which to draw.
minimumX	Abscissa of the leftmost crosses, in world coordinates.
maximumX	Abscissa of the rightmost crosses, in world coordinates.
minimumY	Ordinate of the leftmost crosses, in world coordinates.
maximumY	Ordinate of the rightmost crosses, in world coordinates.
numberOfIntervalsX	Number of intervals between crosses along the horizontal direction.
numberOfIntervalsY	Number of intervals between crosses along the vertical direction.

DrawGrid()

None eVision.Legacy.EWorldShape.DrawGrid	(		self,
		eVision.EDrawAdapter | None	graphicContext )

Draws the reconstructed grid to be used for grid calibration.

Parameters

graphicContext

Handle of the device context on which to draw.

DrawLandmarks()

None eVision.Legacy.EWorldShape.DrawLandmarks	(		self,
		eVision.EDrawAdapter | None	graphicContext )

Draws the landmarks to be used for landmark calibration.

Parameters

graphicContext

Handle of the device context on which to draw.

EmptyLandmarks()

None eVision.Legacy.EWorldShape.EmptyLandmarks

(

self

)

Resets the landmark specification sequence.

Remarks:

Landmark calibration is the process of computing the calibration parameters by means of a set of known points for which the coordinates are available in both World and Sensor spaces. Usually, such points are chosen as salient features on the part or target in view. They must be such that appropriate image processing techniques allow measuring their positions from the image (directly or indirectly by geometric constructions), while at the same time their coordinates in a reference frame are known.

EnableTypeFilter()

None eVision.Legacy.EWorldShape.EnableTypeFilter	(		self,
		int	un32Types )

Enables the filter of the specified shape type.

Parameters

un32Types

The type of the shape to filter from eVision.EShapeType.

Reimplemented from eVision.Legacy.EShape.

FieldHeight()

float eVision.Legacy.EWorldShape.FieldHeight

(

self

)

Field-of-view height, in physical units.

Remarks:

Field size not matching the sensor size results in non-square pixels.

Pixels having non-square aspect ratio. Beware there is a restriction pertaining to the allowed image anisotropy. The resulting pixels aspect ratio (XResolution/YResolution) should be in the range [-4/3, -3/4] (or [3/4, 4/3]), otherwise the calibration process could fail.

FieldWidth()

float eVision.Legacy.EWorldShape.FieldWidth

(

self

)

Field-of-view width, in physical units.

Remarks:

Field size not matching the sensor size results in non-square pixels.

Pixels having non-square aspect ratio. Beware there is a restriction pertaining to the allowed image anisotropy. The resulting pixels aspect ratio (XResolution/YResolution) should be in the range [-4/3, -3/4] (or [3/4, 4/3]), otherwise the calibration process could fail.

GetLandmarkElement()

eVision.ELandmark eVision.Legacy.EWorldShape.GetLandmarkElement	(		self,
		int	i )

Returns the landmark element corresponding to the given index.

Parameters

i	Landmark index.

GetUnwarpedWorldShape() [1/4]

eVision.Legacy.EWorldShape eVision.Legacy.EWorldShape.GetUnwarpedWorldShape	(		self,
		eVision.EBaseROI | None	sourceImage )

Gets a eVision.Legacy.EWorldShape instance representing the transformation of image to world coordinates for the result of eVision.Legacy.EWorldShape.Unwarp.

Parameters

sourceImage

Image to unwarp.

GetUnwarpedWorldShape() [2/4]

eVision.Legacy.EWorldShape eVision.Legacy.EWorldShape.GetUnwarpedWorldShape	(		self,
		eVision.EBaseROI | None	sourceImage,
		bool	resizeDestination )

Gets a eVision.Legacy.EWorldShape instance representing the transformation of image to world coordinates for the result of eVision.Legacy.EWorldShape.Unwarp.

Parameters

sourceImage	Image to unwarp.
resizeDestination	Resize the destination image to match the unwarped image size. Default value is false.

GetUnwarpedWorldShape() [3/4]

eVision.Legacy.EWorldShape eVision.Legacy.EWorldShape.GetUnwarpedWorldShape	(		self,
		int	sourceWidth,
		int	sourceHeight )

Gets a eVision.Legacy.EWorldShape instance representing the transformation of image to world coordinates for the result of eVision.Legacy.EWorldShape.Unwarp.

Parameters

sourceWidth	Width of the image to unwarp.
sourceHeight	Height of the image to unwarp.

GetUnwarpedWorldShape() [4/4]

eVision.Legacy.EWorldShape eVision.Legacy.EWorldShape.GetUnwarpedWorldShape	(		self,
		int	sourceWidth,
		int	sourceHeight,
		bool	resizeDestination )

Gets a eVision.Legacy.EWorldShape instance representing the transformation of image to world coordinates for the result of eVision.Legacy.EWorldShape.Unwarp.

Parameters

sourceWidth	Width of the image to unwarp.
sourceHeight	Height of the image to unwarp.
resizeDestination	Resize the destination image to match the unwarped image size. Default value is false.

GridPointsMaxVariation()

float eVision.Legacy.EWorldShape.GridPointsMaxVariation

(

self

)

Maximum variation of grid points (maximum distance between computed grid points and ideal grid points in world space), normalized using the pitch values, after a call to eVision.Legacy.EWorldShape.CalibrationSucceeded.

Remarks:

The maximum grid point variation is normalized using the pitch values.

GridPointsMaxVariationThreshold() [1/2]

float eVision.Legacy.EWorldShape.GridPointsMaxVariationThreshold

(

self

)

Grid points maximum variation threshold, that is the value above which the maximum variation of grid points (maximum distance between computed grid points and ideal grid points in world space) is considered too high, and thus marks the calibration as a failure when using eVision.Legacy.EWorldShape.CalibrationSucceeded.

Remarks:

The maximum grid point variation is normalized using the pitch values.

GridPointsMaxVariationThreshold() [2/2]

eVision.Legacy.EWorldShape.GridPointsMaxVariationThreshold	(		self,
		float	value )

Grid points maximum variation threshold, that is the value above which the maximum variation of grid points (maximum distance between computed grid points and ideal grid points in world space) is considered too high, and thus marks the calibration as a failure when using eVision.Legacy.EWorldShape.CalibrationSucceeded.

Remarks:

The maximum grid point variation is normalized using the pitch values.

GridPointsMeanVariation()

float eVision.Legacy.EWorldShape.GridPointsMeanVariation

(

self

)

Mean variation of grid points (mean distance between computed grid points and ideal grid points in world space), normalized using the pitch values, after a call to eVision.Legacy.EWorldShape.CalibrationSucceeded.

Remarks:

The mean grid point variation is normalized using the pitch values.

GridPointsMeanVariationThreshold() [1/2]

float eVision.Legacy.EWorldShape.GridPointsMeanVariationThreshold

(

self

)

Grid points mean variation threshold, that is the value above which the mean variation of grid points (mean distance between computed grid points and ideal grid points in world space) is considered too high, and thus marks the calibration as a failure when using eVision.Legacy.EWorldShape.CalibrationSucceeded.

Remarks:

The mean grid point variation is normalized using the pitch values.

GridPointsMeanVariationThreshold() [2/2]

eVision.Legacy.EWorldShape.GridPointsMeanVariationThreshold	(		self,
		float	value )

Grid points mean variation threshold, that is the value above which the mean variation of grid points (mean distance between computed grid points and ideal grid points in world space) is considered too high, and thus marks the calibration as a failure when using eVision.Legacy.EWorldShape.CalibrationSucceeded.

Remarks:

The mean grid point variation is normalized using the pitch values.

HitLandmark()

int eVision.Legacy.EWorldShape.HitLandmark

(

self

)

Returns the landmark selected by eVision.Legacy.EWorldShape.HitLandmarks or ~0 if no landmark is selected.

HitLandmarks()

None eVision.Legacy.EWorldShape.HitLandmarks

(

self

)

Checks if the cursor is placed over a landmark point.

Remarks:

Landmark calibration is the process of computing the calibration parameters by means of a set of known points for which the coordinates are available in both World and Sensor spaces. Usually, such points are chosen as salient features on the part or target in view. They must be such that appropriate image processing techniques allow measuring their positions from the image (directly or indirectly by geometric constructions), while at the same time their coordinates in a reference frame are known.

HitTest() [1/2]

bool eVision.Legacy.EWorldShape.HitTest

(

self

)

Checks if there is a handle under the cursor.

Reimplemented from eVision.Legacy.EShape.

HitTest() [2/2]

bool eVision.Legacy.EWorldShape.HitTest	(		self,
		bool	bDaughters )

Checks if there is a handle under the cursor.

Parameters

bDaughters

Indicates if the check must be done in the whole hierarchy or just this object.

Reimplemented from eVision.Legacy.EShape.

Invalidate()

None eVision.Legacy.EWorldShape.Invalidate

(

self

)

NumLandmarkElements()

int eVision.Legacy.EWorldShape.NumLandmarkElements

(

self

)

Returns the number of landmark elements.

OpticalCenterX()

float eVision.Legacy.EWorldShape.OpticalCenterX

(

self

)

OpticalCenterY()

float eVision.Legacy.EWorldShape.OpticalCenterY

(

self

)

PanX()

float eVision.Legacy.EWorldShape.PanX

(

self

)

Current horizontal panning value for drawing operations, expressed in pixels.

By default, no panning occurs.

Reimplemented from eVision.Legacy.EShape.

PanY()

float eVision.Legacy.EWorldShape.PanY

(

self

)

Current vertical panning value for drawing operations, expressed in pixels.

By default, no panning occurs.

Reimplemented from eVision.Legacy.EShape.

PerspectiveStrength()

float eVision.Legacy.EWorldShape.PerspectiveStrength

(

self

)

Perspective effect coefficient, that is the inverse of the observation distance.

Remarks:

The larger this parameter, the more perceivable the perspective distortion will be. A NULL value corresponds to a telecentric lens.

Ratio() [1/2]

float eVision.Legacy.EWorldShape.Ratio

(

self

)

XResolution/YResolution ratio.

Remarks:

If Ratio equals -1 (or 1), pixels are square. Beware there is a restriction pertaining to the allowed image anisotropy. The resulting pixels aspect ratio (XResolution/YResolution) should be in the range [-4/3, -3/4] (or [3/4, 4/3]), otherwise the calibration process could fail.

Ratio() [2/2]

eVision.Legacy.EWorldShape.Ratio	(		self,
		float	value )

XResolution/YResolution ratio.

Remarks:

If Ratio equals -1 (or 1), pixels are square. Beware there is a restriction pertaining to the allowed image anisotropy. The resulting pixels aspect ratio (XResolution/YResolution) should be in the range [-4/3, -3/4] (or [3/4, 4/3]), otherwise the calibration process could fail.

RebuildGrid() [1/6]

int eVision.Legacy.EWorldShape.RebuildGrid	(		self,
		float	colPitch,
		float	rowPitch )

Reconstructs the grid of points from the given dot centers, to compute the World coordinates of the points.

Remarks:

This member function also returns the number of grid points that were connected. This prepares the calibration using landmarks (for use by member eVision.Legacy.EWorldShape.Calibrate). Landmark calibration is the process of computing the calibration parameters by means of a set of known points for which the coordinates are available in both World and Sensor spaces. Usually, such points are chosen as salient features on the part or target in view. They must be such that appropriate image processing techniques allow measuring their positions from the image (directly or indirectly by geometric constructions), while at the same time their coordinates in a reference frame are known. See also Dot-Grid-Based Calibration for the grid construction algorithm.

Parameters

colPitch	Actual pitches of the grid, that are distances between vertical and horizontal rows of the grid.
rowPitch	Actual pitches of the grid, that are distances between vertical and horizontal rows of the grid.

RebuildGrid() [2/6]

int eVision.Legacy.EWorldShape.RebuildGrid	(		self,
		float	colPitch,
		float	rowPitch,
		eVision.EPoint	worldCenter )

Reconstructs the grid of points from the given dot centers, to compute the World coordinates of the points.

Remarks:

This member function also returns the number of grid points that were connected. This prepares the calibration using landmarks (for use by member eVision.Legacy.EWorldShape.Calibrate). Landmark calibration is the process of computing the calibration parameters by means of a set of known points for which the coordinates are available in both World and Sensor spaces. Usually, such points are chosen as salient features on the part or target in view. They must be such that appropriate image processing techniques allow measuring their positions from the image (directly or indirectly by geometric constructions), while at the same time their coordinates in a reference frame are known. See also Dot-Grid-Based Calibration for the grid construction algorithm.

Parameters

colPitch	Actual pitches of the grid, that are distances between vertical and horizontal rows of the grid.
rowPitch	Actual pitches of the grid, that are distances between vertical and horizontal rows of the grid.
worldCenter	World coordinates of the starting grid point.

RebuildGrid() [3/6]

int eVision.Legacy.EWorldShape.RebuildGrid	(		self,
		float	colPitch,
		float	rowPitch,
		eVision.EPoint	worldCenter,
		int	centerIndex )

Reconstructs the grid of points from the given dot centers, to compute the World coordinates of the points.

Remarks:

This member function also returns the number of grid points that were connected. This prepares the calibration using landmarks (for use by member eVision.Legacy.EWorldShape.Calibrate). Landmark calibration is the process of computing the calibration parameters by means of a set of known points for which the coordinates are available in both World and Sensor spaces. Usually, such points are chosen as salient features on the part or target in view. They must be such that appropriate image processing techniques allow measuring their positions from the image (directly or indirectly by geometric constructions), while at the same time their coordinates in a reference frame are known. See also Dot-Grid-Based Calibration for the grid construction algorithm.

Parameters

colPitch	Actual pitches of the grid, that are distances between vertical and horizontal rows of the grid.
rowPitch	Actual pitches of the grid, that are distances between vertical and horizontal rows of the grid.
worldCenter	World coordinates of the starting grid point.
centerIndex	Index of the grid point chosen as coordinate origin point. By default, the most central grid point.

RebuildGrid() [4/6]

int eVision.Legacy.EWorldShape.RebuildGrid	(		self,
		float	colPitch,
		float	rowPitch,
		eVision.EPoint	worldCenter,
		int	centerIndex,
		bool	direct )

Reconstructs the grid of points from the given dot centers, to compute the World coordinates of the points.

Remarks:

This member function also returns the number of grid points that were connected. This prepares the calibration using landmarks (for use by member eVision.Legacy.EWorldShape.Calibrate). Landmark calibration is the process of computing the calibration parameters by means of a set of known points for which the coordinates are available in both World and Sensor spaces. Usually, such points are chosen as salient features on the part or target in view. They must be such that appropriate image processing techniques allow measuring their positions from the image (directly or indirectly by geometric constructions), while at the same time their coordinates in a reference frame are known. See also Dot-Grid-Based Calibration for the grid construction algorithm.

Parameters

colPitch	Actual pitches of the grid, that are distances between vertical and horizontal rows of the grid.
rowPitch	Actual pitches of the grid, that are distances between vertical and horizontal rows of the grid.
worldCenter	World coordinates of the starting grid point.
centerIndex	Index of the grid point chosen as coordinate origin point. By default, the most central grid point.
direct	true if the world reference frame points upwards.

RebuildGrid() [5/6]

int eVision.Legacy.EWorldShape.RebuildGrid	(		self,
		float	colPitch,
		float	rowPitch,
		int	centerIndex )

Reconstructs the grid of points from the given dot centers, to compute the World coordinates of the points.

Remarks:

This member function also returns the number of grid points that were connected. This prepares the calibration using landmarks (for use by member eVision.Legacy.EWorldShape.Calibrate). Landmark calibration is the process of computing the calibration parameters by means of a set of known points for which the coordinates are available in both World and Sensor spaces. Usually, such points are chosen as salient features on the part or target in view. They must be such that appropriate image processing techniques allow measuring their positions from the image (directly or indirectly by geometric constructions), while at the same time their coordinates in a reference frame are known. See also Dot-Grid-Based Calibration for the grid construction algorithm.

Parameters

colPitch	Actual pitches of the grid, that are distances between vertical and horizontal rows of the grid.
rowPitch	Actual pitches of the grid, that are distances between vertical and horizontal rows of the grid.
centerIndex	Index of the grid point chosen as coordinate origin point. By default, the most central grid point.

RebuildGrid() [6/6]

int eVision.Legacy.EWorldShape.RebuildGrid	(		self,
		float	colPitch,
		float	rowPitch,
		int	centerIndex,
		bool	direct )

Reconstructs the grid of points from the given dot centers, to compute the World coordinates of the points.

Remarks:

This member function also returns the number of grid points that were connected. This prepares the calibration using landmarks (for use by member eVision.Legacy.EWorldShape.Calibrate). Landmark calibration is the process of computing the calibration parameters by means of a set of known points for which the coordinates are available in both World and Sensor spaces. Usually, such points are chosen as salient features on the part or target in view. They must be such that appropriate image processing techniques allow measuring their positions from the image (directly or indirectly by geometric constructions), while at the same time their coordinates in a reference frame are known. See also Dot-Grid-Based Calibration for the grid construction algorithm.

Parameters

colPitch	Actual pitches of the grid, that are distances between vertical and horizontal rows of the grid.
rowPitch	Actual pitches of the grid, that are distances between vertical and horizontal rows of the grid.
centerIndex	Index of the grid point chosen as coordinate origin point. By default, the most central grid point.
direct	true if the world reference frame points upwards.

RemoveLandmark()

None eVision.Legacy.EWorldShape.RemoveLandmark	(		self,
		int	index )

Removes a landmark.

Parameters

index

Index of the landmark to be removed.

Scale() [1/2]

float eVision.Legacy.EWorldShape.Scale

(

self

)

The scale of the reference frame.

Scale() [2/2]

eVision.Legacy.EWorldShape.Scale	(		self,
		float	value )

The scale of the reference frame.

SensorHeight()

int eVision.Legacy.EWorldShape.SensorHeight

(

self

)

Logical image height, that is the number of pixels vertically.

SensorToWorld()

eVision.EPoint eVision.Legacy.EWorldShape.SensorToWorld	(		self,
		eVision.EPoint	sensorPoint )

Performs coordinate transform for arbitrary points from Sensor space to World space.

Remarks:

For cameras with large distortions, reverting the distortion model for eccentric pixels (i.e. pixels near the border of the image) may not converge properly and may yield inaccurate results.

Parameters

sensorPoint

Sensor point.

SensorWidth()

int eVision.Legacy.EWorldShape.SensorWidth

(

self

)

Logical image width, that is the number of pixels horizontally.

SetCenterXY()

None eVision.Legacy.EWorldShape.SetCenterXY	(		self,
		float	centerX,
		float	centerY )

Position of the origin point of the reference frame as projected onto the image, i.e.

the Sensor position of the point at World coordinates (0,0).

Parameters

centerX	Horizontal position (abscissa)
centerY	Vertical position (ordinate)

SetFieldSize() [1/2]

None eVision.Legacy.EWorldShape.SetFieldSize	(		self,
		float	width )

Sets the field of view size in physical units.

Remarks:

Field size not matching the sensor size results in non-square pixels. By default, the pixels are square.

Pixels having non-square aspect ratio. Beware there is a restriction pertaining to the allowed image anisotropy. The resulting pixels aspect ratio (XResolution/YResolution) should be in the range [-4/3, -3/4] (or [3/4, 4/3]), otherwise the calibration process could fail.

Parameters

width

Full image physical width, in length units.

SetFieldSize() [2/2]

None eVision.Legacy.EWorldShape.SetFieldSize	(		self,
		float	width,
		float	height )

Sets the field of view size in physical units.

Remarks:

Field size not matching the sensor size results in non-square pixels. By default, the pixels are square.

Pixels having non-square aspect ratio. Beware there is a restriction pertaining to the allowed image anisotropy. The resulting pixels aspect ratio (XResolution/YResolution) should be in the range [-4/3, -3/4] (or [3/4, 4/3]), otherwise the calibration process could fail.

Parameters

width	Full image physical width, in length units.
height	Full image physical height, in length units. If not specified, same as physical width.

SetOpticalCenter()

None eVision.Legacy.EWorldShape.SetOpticalCenter	(		self,
		float	centerX,
		float	centerY )

SetPan() [1/3]

None eVision.Legacy.EWorldShape.SetPan

(

self

)

Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.

Remarks:

All objects attached to an eVision.Legacy.EWorldShape.__init__ object inherit of the same panning factor.

Reimplemented from eVision.Legacy.EShape.

SetPan() [2/3]

None eVision.Legacy.EWorldShape.SetPan	(		self,
		float	panX )

Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.

Remarks:

All objects attached to an eVision.Legacy.EWorldShape.__init__ object inherit of the same panning factor.

Parameters

panX	Horizontal panning value expressed in pixels. By default, no panning occurs.

Reimplemented from eVision.Legacy.EShape.

SetPan() [3/3]

None eVision.Legacy.EWorldShape.SetPan	(		self,
		float	panX,
		float	panY )

Sets the horizontal and vertical panning values for drawing operations, expressed in pixels.

Remarks:

All objects attached to an eVision.Legacy.EWorldShape.__init__ object inherit of the same panning factor.

Parameters

panX	Horizontal panning value expressed in pixels. By default, no panning occurs.
panY	Vertical panning value expressed in pixels. By default, no panning occurs.

Reimplemented from eVision.Legacy.EShape.

SetPerspective()

None eVision.Legacy.EWorldShape.SetPerspective	(		self,
		float	tiltXAngle,
		float	tiltYAngle,
		float	perspectiveStrength )

Sets the perspective effect coefficient, i.e.

the inverse of the observation distance.

Remarks:

The larger this parameter, the more perceivable the perspective distortion will be. A NULL value corresponds to a telecentric lens.

Weak Perspective and Strong Perspective

Parameters

tiltXAngle	Tilt angles, i.e. the amplitudes of the rotations applied around the X and Y axis of the sensor to bring the optical (Z) axis perpendicular to the field of view.
tiltYAngle	Tilt angles, i.e. the amplitudes of the rotations applied around the X and Y axis of the sensor to bring the optical (Z) axis perpendicular to the field of view.
perspectiveStrength	Perspective effect coefficient.

SetResolution() [1/2]

None eVision.Legacy.EWorldShape.SetResolution	(		self,
		float	resolutionX )

Sets the sensor resolution in pixels per unit in both directions.

Remarks:

By default, the pixels are square.

Parameters

resolutionX

Horizontal resolution in pixels per units

SetResolution() [2/2]

None eVision.Legacy.EWorldShape.SetResolution	(		self,
		float	resolutionX,
		float	resolutionY )

Sets the sensor resolution in pixels per unit in both directions.

Remarks:

By default, the pixels are square.

Parameters

resolutionX	Horizontal resolution in pixels per units
resolutionY	Vertical resolution in pixels per units. If not specified, same as horizontal resolution.

SetSensor() [1/13]

None eVision.Legacy.EWorldShape.SetSensor	(		self,
		int	sensorWidth,
		int	sensorHeight )

Initializes the calibration object using all given parameters.

Remarks:

The function automatically selects the appropriate calibration model by checking the parameters. The use of a more complex calibration mode can be enforced by means of parameter eVision.Legacy.EWorldShape.CalibrationModes, not a simpler one.

Parameters

sensorWidth	Logical size of the field of view, i.e. image size, in pixels.
sensorHeight	Logical size of the field of view, i.e. image size, in pixels.

SetSensor() [2/13]

None eVision.Legacy.EWorldShape.SetSensor	(		self,
		int	sensorWidth,
		int	sensorHeight,
		float	fieldWidth )

Initializes the calibration object using all given parameters.

Remarks:

The function automatically selects the appropriate calibration model by checking the parameters. The use of a more complex calibration mode can be enforced by means of parameter eVision.Legacy.EWorldShape.CalibrationModes, not a simpler one.

Parameters

sensorWidth	Logical size of the field of view, i.e. image size, in pixels.
sensorHeight	Logical size of the field of view, i.e. image size, in pixels.
fieldWidth	Physical size of the field of view. By default (argument omitted), the pixels are square.

SetSensor() [3/13]

None eVision.Legacy.EWorldShape.SetSensor	(		self,
		int	sensorWidth,
		int	sensorHeight,
		float	fieldWidth,
		float	fieldHeight )

Initializes the calibration object using all given parameters.

Remarks:

The function automatically selects the appropriate calibration model by checking the parameters. The use of a more complex calibration mode can be enforced by means of parameter eVision.Legacy.EWorldShape.CalibrationModes, not a simpler one.

Parameters

sensorWidth	Logical size of the field of view, i.e. image size, in pixels.
sensorHeight	Logical size of the field of view, i.e. image size, in pixels.
fieldWidth	Physical size of the field of view. By default (argument omitted), the pixels are square.
fieldHeight	Physical size of the field of view. By default (argument omitted), the pixels are square.

SetSensor() [4/13]

None eVision.Legacy.EWorldShape.SetSensor	(		self,
		int	sensorWidth,
		int	sensorHeight,
		float	fieldWidth,
		float	fieldHeight,
		float	centerX )

Initializes the calibration object using all given parameters.

Remarks:

The function automatically selects the appropriate calibration model by checking the parameters. The use of a more complex calibration mode can be enforced by means of parameter eVision.Legacy.EWorldShape.CalibrationModes, not a simpler one.

Parameters

sensorWidth	Logical size of the field of view, i.e. image size, in pixels.
sensorHeight	Logical size of the field of view, i.e. image size, in pixels.
fieldWidth	Physical size of the field of view. By default (argument omitted), the pixels are square.
fieldHeight	Physical size of the field of view. By default (argument omitted), the pixels are square.
centerX	Position of the "intersection" between the optical axis and the field of view in the image. By default, if the calibration modes contain eVision.ECalibrationMode.Raw, it is set to 0. Otherwise, it is set to the image center.

SetSensor() [5/13]

None eVision.Legacy.EWorldShape.SetSensor	(		self,
		int	sensorWidth,
		int	sensorHeight,
		float	fieldWidth,
		float	fieldHeight,
		float	centerX,
		float	centerY )

Initializes the calibration object using all given parameters.

Remarks:

The function automatically selects the appropriate calibration model by checking the parameters. The use of a more complex calibration mode can be enforced by means of parameter eVision.Legacy.EWorldShape.CalibrationModes, not a simpler one.

Parameters

sensorWidth	Logical size of the field of view, i.e. image size, in pixels.
sensorHeight	Logical size of the field of view, i.e. image size, in pixels.
fieldWidth	Physical size of the field of view. By default (argument omitted), the pixels are square.
fieldHeight	Physical size of the field of view. By default (argument omitted), the pixels are square.
centerX	Position of the "intersection" between the optical axis and the field of view in the image. By default, if the calibration modes contain eVision.ECalibrationMode.Raw, it is set to 0. Otherwise, it is set to the image center.
centerY	Position of the "intersection" between the optical axis and the field of view in the image. By default, if the calibration modes contain eVision.ECalibrationMode.Raw, it is set to 0 (or to the bottommost pixel index if the calibration modes also contain eVision.ECalibrationMode.Inverse). Otherwise, it is set to the image center.

SetSensor() [6/13]

None eVision.Legacy.EWorldShape.SetSensor	(		self,
		int	sensorWidth,
		int	sensorHeight,
		float	fieldWidth,
		float	fieldHeight,
		float	centerX,
		float	centerY,
		float	angle )

Initializes the calibration object using all given parameters.

Remarks:

The function automatically selects the appropriate calibration model by checking the parameters. The use of a more complex calibration mode can be enforced by means of parameter eVision.Legacy.EWorldShape.CalibrationModes, not a simpler one.

Parameters

sensorWidth	Logical size of the field of view, i.e. image size, in pixels.
sensorHeight	Logical size of the field of view, i.e. image size, in pixels.
fieldWidth	Physical size of the field of view. By default (argument omitted), the pixels are square.
fieldHeight	Physical size of the field of view. By default (argument omitted), the pixels are square.
centerX	Position of the "intersection" between the optical axis and the field of view in the image. By default, if the calibration modes contain eVision.ECalibrationMode.Raw, it is set to 0. Otherwise, it is set to the image center.
centerY	Position of the "intersection" between the optical axis and the field of view in the image. By default, if the calibration modes contain eVision.ECalibrationMode.Raw, it is set to 0 (or to the bottommost pixel index if the calibration modes also contain eVision.ECalibrationMode.Inverse). Otherwise, it is set to the image center.
angle	Skew angle, i.e. angle formed by the axis of reference and the image edges. By default (argument omitted), no skewing effect is assumed.

SetSensor() [7/13]

None eVision.Legacy.EWorldShape.SetSensor	(		self,
		int	sensorWidth,
		int	sensorHeight,
		float	fieldWidth,
		float	fieldHeight,
		float	centerX,
		float	centerY,
		float	angle,
		float	tiltXAngle )

Initializes the calibration object using all given parameters.

Remarks:

The function automatically selects the appropriate calibration model by checking the parameters. The use of a more complex calibration mode can be enforced by means of parameter eVision.Legacy.EWorldShape.CalibrationModes, not a simpler one.

Parameters

sensorWidth	Logical size of the field of view, i.e. image size, in pixels.
sensorHeight	Logical size of the field of view, i.e. image size, in pixels.
fieldWidth	Physical size of the field of view. By default (argument omitted), the pixels are square.
fieldHeight	Physical size of the field of view. By default (argument omitted), the pixels are square.
centerX	Position of the "intersection" between the optical axis and the field of view in the image. By default, if the calibration modes contain eVision.ECalibrationMode.Raw, it is set to 0. Otherwise, it is set to the image center.
centerY	Position of the "intersection" between the optical axis and the field of view in the image. By default, if the calibration modes contain eVision.ECalibrationMode.Raw, it is set to 0 (or to the bottommost pixel index if the calibration modes also contain eVision.ECalibrationMode.Inverse). Otherwise, it is set to the image center.
angle	Skew angle, i.e. angle formed by the axis of reference and the image edges. By default (argument omitted), no skewing effect is assumed.
tiltXAngle	Rotation angles on the X axis to bring the optical axis perpendicular to the image plane. By default (argument omitted), no perspective effect is assumed.

SetSensor() [8/13]

None eVision.Legacy.EWorldShape.SetSensor	(		self,
		int	sensorWidth,
		int	sensorHeight,
		float	fieldWidth,
		float	fieldHeight,
		float	centerX,
		float	centerY,
		float	angle,
		float	tiltXAngle,
		float	tiltYAngle )

Initializes the calibration object using all given parameters.

Remarks:

The function automatically selects the appropriate calibration model by checking the parameters. The use of a more complex calibration mode can be enforced by means of parameter eVision.Legacy.EWorldShape.CalibrationModes, not a simpler one.

Parameters

sensorWidth	Logical size of the field of view, i.e. image size, in pixels.
sensorHeight	Logical size of the field of view, i.e. image size, in pixels.
fieldWidth	Physical size of the field of view. By default (argument omitted), the pixels are square.
fieldHeight	Physical size of the field of view. By default (argument omitted), the pixels are square.
centerX	Position of the "intersection" between the optical axis and the field of view in the image. By default, if the calibration modes contain eVision.ECalibrationMode.Raw, it is set to 0. Otherwise, it is set to the image center.
centerY	Position of the "intersection" between the optical axis and the field of view in the image. By default, if the calibration modes contain eVision.ECalibrationMode.Raw, it is set to 0 (or to the bottommost pixel index if the calibration modes also contain eVision.ECalibrationMode.Inverse). Otherwise, it is set to the image center.
angle	Skew angle, i.e. angle formed by the axis of reference and the image edges. By default (argument omitted), no skewing effect is assumed.
tiltXAngle	Rotation angles on the X axis to bring the optical axis perpendicular to the image plane. By default (argument omitted), no perspective effect is assumed.
tiltYAngle	Rotation angles on the Y axis to bring the optical axis perpendicular to the image plane. By default (argument omitted), no perspective effect is assumed.

SetSensor() [9/13]

None eVision.Legacy.EWorldShape.SetSensor	(		self,
		int	sensorWidth,
		int	sensorHeight,
		float	fieldWidth,
		float	fieldHeight,
		float	centerX,
		float	centerY,
		float	angle,
		float	tiltXAngle,
		float	tiltYAngle,
		float	perspectiveStrength )

Initializes the calibration object using all given parameters.

Remarks:

The function automatically selects the appropriate calibration model by checking the parameters. The use of a more complex calibration mode can be enforced by means of parameter eVision.Legacy.EWorldShape.CalibrationModes, not a simpler one.

Parameters

sensorWidth	Logical size of the field of view, i.e. image size, in pixels.
sensorHeight	Logical size of the field of view, i.e. image size, in pixels.
fieldWidth	Physical size of the field of view. By default (argument omitted), the pixels are square.
fieldHeight	Physical size of the field of view. By default (argument omitted), the pixels are square.
centerX	Position of the "intersection" between the optical axis and the field of view in the image. By default, if the calibration modes contain eVision.ECalibrationMode.Raw, it is set to 0. Otherwise, it is set to the image center.
centerY	Position of the "intersection" between the optical axis and the field of view in the image. By default, if the calibration modes contain eVision.ECalibrationMode.Raw, it is set to 0 (or to the bottommost pixel index if the calibration modes also contain eVision.ECalibrationMode.Inverse). Otherwise, it is set to the image center.
angle	Skew angle, i.e. angle formed by the axis of reference and the image edges. By default (argument omitted), no skewing effect is assumed.
tiltXAngle	Rotation angles on the X axis to bring the optical axis perpendicular to the image plane. By default (argument omitted), no perspective effect is assumed.
tiltYAngle	Rotation angles on the Y axis to bring the optical axis perpendicular to the image plane. By default (argument omitted), no perspective effect is assumed.
perspectiveStrength	Relative importance of the perspective effect. By default, no perspective effect is assumed, as if the lens was telecentric.

SetSensor() [10/13]

None eVision.Legacy.EWorldShape.SetSensor	(		self,
		int	sensorWidth,
		int	sensorHeight,
		float	fieldWidth,
		float	fieldHeight,
		float	centerX,
		float	centerY,
		float	angle,
		float	tiltXAngle,
		float	tiltYAngle,
		float	perspectiveStrength,
		float	distortionStrength )

Initializes the calibration object using all given parameters.

Remarks:

The function automatically selects the appropriate calibration model by checking the parameters. The use of a more complex calibration mode can be enforced by means of parameter eVision.Legacy.EWorldShape.CalibrationModes, not a simpler one.

Parameters

sensorWidth	Logical size of the field of view, i.e. image size, in pixels.
sensorHeight	Logical size of the field of view, i.e. image size, in pixels.
fieldWidth	Physical size of the field of view. By default (argument omitted), the pixels are square.
fieldHeight	Physical size of the field of view. By default (argument omitted), the pixels are square.
centerX	Position of the "intersection" between the optical axis and the field of view in the image. By default, if the calibration modes contain eVision.ECalibrationMode.Raw, it is set to 0. Otherwise, it is set to the image center.
centerY	Position of the "intersection" between the optical axis and the field of view in the image. By default, if the calibration modes contain eVision.ECalibrationMode.Raw, it is set to 0 (or to the bottommost pixel index if the calibration modes also contain eVision.ECalibrationMode.Inverse). Otherwise, it is set to the image center.
angle	Skew angle, i.e. angle formed by the axis of reference and the image edges. By default (argument omitted), no skewing effect is assumed.
tiltXAngle	Rotation angles on the X axis to bring the optical axis perpendicular to the image plane. By default (argument omitted), no perspective effect is assumed.
tiltYAngle	Rotation angles on the Y axis to bring the optical axis perpendicular to the image plane. By default (argument omitted), no perspective effect is assumed.
perspectiveStrength	Relative importance of the perspective effect. By default, no perspective effect is assumed, as if the lens was telecentric.
distortionStrength	Relative importance of the lens radial distortion. Positive for barrel, negative for cushion. By default (argument omitted), no optical distortion is assumed.

SetSensor() [11/13]

None eVision.Legacy.EWorldShape.SetSensor	(		self,
		int	sensorWidth,
		int	sensorHeight,
		float	fieldWidth,
		float	fieldHeight,
		float	centerX,
		float	centerY,
		float	angle,
		float	tiltXAngle,
		float	tiltYAngle,
		float	perspectiveStrength,
		float	distortionStrength,
		float	opticalCenterX )

Initializes the calibration object using all given parameters.

Remarks:

The function automatically selects the appropriate calibration model by checking the parameters. The use of a more complex calibration mode can be enforced by means of parameter eVision.Legacy.EWorldShape.CalibrationModes, not a simpler one.

Parameters

sensorWidth	Logical size of the field of view, i.e. image size, in pixels.
sensorHeight	Logical size of the field of view, i.e. image size, in pixels.
fieldWidth	Physical size of the field of view. By default (argument omitted), the pixels are square.
fieldHeight	Physical size of the field of view. By default (argument omitted), the pixels are square.
centerX	Position of the "intersection" between the optical axis and the field of view in the image. By default, if the calibration modes contain eVision.ECalibrationMode.Raw, it is set to 0. Otherwise, it is set to the image center.
centerY	Position of the "intersection" between the optical axis and the field of view in the image. By default, if the calibration modes contain eVision.ECalibrationMode.Raw, it is set to 0 (or to the bottommost pixel index if the calibration modes also contain eVision.ECalibrationMode.Inverse). Otherwise, it is set to the image center.
angle	Skew angle, i.e. angle formed by the axis of reference and the image edges. By default (argument omitted), no skewing effect is assumed.
tiltXAngle	Rotation angles on the X axis to bring the optical axis perpendicular to the image plane. By default (argument omitted), no perspective effect is assumed.
tiltYAngle	Rotation angles on the Y axis to bring the optical axis perpendicular to the image plane. By default (argument omitted), no perspective effect is assumed.
perspectiveStrength	Relative importance of the perspective effect. By default, no perspective effect is assumed, as if the lens was telecentric.
distortionStrength	Relative importance of the lens radial distortion. Positive for barrel, negative for cushion. By default (argument omitted), no optical distortion is assumed.
opticalCenterX	X Position of the "intersection" between the optical axis and the field of view in the image. By default (argument omitted) the image center.

SetSensor() [12/13]

None eVision.Legacy.EWorldShape.SetSensor	(		self,
		int	sensorWidth,
		int	sensorHeight,
		float	fieldWidth,
		float	fieldHeight,
		float	centerX,
		float	centerY,
		float	angle,
		float	tiltXAngle,
		float	tiltYAngle,
		float	perspectiveStrength,
		float	distortionStrength,
		float	opticalCenterX,
		float	opticalCenterY )

Initializes the calibration object using all given parameters.

Remarks:

The function automatically selects the appropriate calibration model by checking the parameters. The use of a more complex calibration mode can be enforced by means of parameter eVision.Legacy.EWorldShape.CalibrationModes, not a simpler one.

Parameters

sensorWidth	Logical size of the field of view, i.e. image size, in pixels.
sensorHeight	Logical size of the field of view, i.e. image size, in pixels.
fieldWidth	Physical size of the field of view. By default (argument omitted), the pixels are square.
fieldHeight	Physical size of the field of view. By default (argument omitted), the pixels are square.
centerX	Position of the "intersection" between the optical axis and the field of view in the image. By default, if the calibration modes contain eVision.ECalibrationMode.Raw, it is set to 0. Otherwise, it is set to the image center.
centerY	Position of the "intersection" between the optical axis and the field of view in the image. By default, if the calibration modes contain eVision.ECalibrationMode.Raw, it is set to 0 (or to the bottommost pixel index if the calibration modes also contain eVision.ECalibrationMode.Inverse). Otherwise, it is set to the image center.
angle	Skew angle, i.e. angle formed by the axis of reference and the image edges. By default (argument omitted), no skewing effect is assumed.
tiltXAngle	Rotation angles on the X axis to bring the optical axis perpendicular to the image plane. By default (argument omitted), no perspective effect is assumed.
tiltYAngle	Rotation angles on the Y axis to bring the optical axis perpendicular to the image plane. By default (argument omitted), no perspective effect is assumed.
perspectiveStrength	Relative importance of the perspective effect. By default, no perspective effect is assumed, as if the lens was telecentric.
distortionStrength	Relative importance of the lens radial distortion. Positive for barrel, negative for cushion. By default (argument omitted), no optical distortion is assumed.
opticalCenterX	X Position of the "intersection" between the optical axis and the field of view in the image. By default (argument omitted) the image center.
opticalCenterY	Y Position of the "intersection" between the optical axis and the field of view in the image. By default (argument omitted) the image center.

SetSensor() [13/13]

None eVision.Legacy.EWorldShape.SetSensor	(		self,
		int	sensorWidth,
		int	sensorHeight,
		float	fieldWidth,
		float	fieldHeight,
		float	centerX,
		float	centerY,
		float	angle,
		float	tiltXAngle,
		float	tiltYAngle,
		float	perspectiveStrength,
		float	distortionStrength,
		float	opticalCenterX,
		float	opticalCenterY,
		int	calibrationModes )

Initializes the calibration object using all given parameters.

Remarks:

The function automatically selects the appropriate calibration model by checking the parameters. The use of a more complex calibration mode can be enforced by means of parameter eVision.Legacy.EWorldShape.CalibrationModes, not a simpler one.

Parameters

sensorWidth	Logical size of the field of view, i.e. image size, in pixels.
sensorHeight	Logical size of the field of view, i.e. image size, in pixels.
fieldWidth	Physical size of the field of view. By default (argument omitted), the pixels are square.
fieldHeight	Physical size of the field of view. By default (argument omitted), the pixels are square.
centerX	Position of the "intersection" between the optical axis and the field of view in the image. By default, if the calibration modes contain eVision.ECalibrationMode.Raw, it is set to 0. Otherwise, it is set to the image center.
centerY	Position of the "intersection" between the optical axis and the field of view in the image. By default, if the calibration modes contain eVision.ECalibrationMode.Raw, it is set to 0 (or to the bottommost pixel index if the calibration modes also contain eVision.ECalibrationMode.Inverse). Otherwise, it is set to the image center.
angle	Skew angle, i.e. angle formed by the axis of reference and the image edges. By default (argument omitted), no skewing effect is assumed.
tiltXAngle	Rotation angles on the X axis to bring the optical axis perpendicular to the image plane. By default (argument omitted), no perspective effect is assumed.
tiltYAngle	Rotation angles on the Y axis to bring the optical axis perpendicular to the image plane. By default (argument omitted), no perspective effect is assumed.
perspectiveStrength	Relative importance of the perspective effect. By default, no perspective effect is assumed, as if the lens was telecentric.
distortionStrength	Relative importance of the lens radial distortion. Positive for barrel, negative for cushion. By default (argument omitted), no optical distortion is assumed.
opticalCenterX	X Position of the "intersection" between the optical axis and the field of view in the image. By default (argument omitted) the image center.
opticalCenterY	Y Position of the "intersection" between the optical axis and the field of view in the image. By default (argument omitted) the image center.
calibrationModes	Desired calibration mode effects to be combined, as defined by eVision.ECalibrationMode. By default (argument omitted), the simplest model compatible with the given parameters is chosen.

SetSensorSize()

None eVision.Legacy.EWorldShape.SetSensorSize	(		self,
		int	width,
		int	height )

Sets the logical image size, i.e.

the number of pixels horizontally and vertically.

Parameters

width	Full image logical sizes, in pixels.
height	Full image logical sizes, in pixels.

SetSize() [1/2]

None eVision.Legacy.EWorldShape.SetSize	(		self,
		float	sizeX )

Sets the frame size.

Remarks:

By default, both frame axis value are set to 100, which means 100 pixels when the field of view is not calibrated and 100 "units" in case of a calibrated field of view.

Parameters

sizeX

Frame X-axis length. The default value is 100.

SetSize() [2/2]

None eVision.Legacy.EWorldShape.SetSize	(		self,
		float	sizeX,
		float	sizeY )

Sets the frame size.

Remarks:

By default, both frame axis value are set to 100, which means 100 pixels when the field of view is not calibrated and 100 "units" in case of a calibrated field of view.

Parameters

sizeX	Frame X-axis length. The default value is 100.
sizeY	Frame Y-axis length. By default, both axes have the same length.

SetupUnwarp() [1/6]

None eVision.Legacy.EWorldShape.SetupUnwarp	(		self,
		eVision.EUnwarpingLut | None	lookupTable,
		eVision.EROIBW8 | None	sourceImage )

Prepares a lookup table for fast image unwarping.

Remarks:

The function should be called each time the system is re-calibrated (after the optical setup has been changed, for instance).

A sample source image has to be supplied to this method, and its row pitch is recorded in order to speedup the unwarping process. This implies that the following calls to eVision.Legacy.EWorldShape.Unwarp are not allowed to use images with row pitches different from the source image initially supplied to this method.

Parameters

lookupTable	Pointer to the lookup table.
sourceImage	Pointer to the source image/ROI.

SetupUnwarp() [2/6]

None eVision.Legacy.EWorldShape.SetupUnwarp	(		self,
		eVision.EUnwarpingLut | None	lookupTable,
		eVision.EROIBW8 | None	sourceImage,
		bool	interpolate )

Prepares a lookup table for fast image unwarping.

Remarks:

The function should be called each time the system is re-calibrated (after the optical setup has been changed, for instance).

A sample source image has to be supplied to this method, and its row pitch is recorded in order to speedup the unwarping process. This implies that the following calls to eVision.Legacy.EWorldShape.Unwarp are not allowed to use images with row pitches different from the source image initially supplied to this method.

Parameters

lookupTable	Pointer to the lookup table.
sourceImage	Pointer to the source image/ROI.
interpolate	Interpolation mode. Default value is true.

SetupUnwarp() [3/6]

None eVision.Legacy.EWorldShape.SetupUnwarp	(		self,
		eVision.EUnwarpingLut | None	lookupTable,
		eVision.EROIBW8 | None	sourceImage,
		bool	interpolate,
		bool	resizeDestination )

Prepares a lookup table for fast image unwarping.

Remarks:

The function should be called each time the system is re-calibrated (after the optical setup has been changed, for instance).

A sample source image has to be supplied to this method, and its row pitch is recorded in order to speedup the unwarping process. This implies that the following calls to eVision.Legacy.EWorldShape.Unwarp are not allowed to use images with row pitches different from the source image initially supplied to this method.

Parameters

lookupTable	Pointer to the lookup table.
sourceImage	Pointer to the source image/ROI.
interpolate	Interpolation mode. Default value is true.
resizeDestination	Resize the destination image to match the unwarped image size. Default value is false.

SetupUnwarp() [4/6]

None eVision.Legacy.EWorldShape.SetupUnwarp	(		self,
		eVision.EUnwarpingLut | None	lookupTable,
		eVision.EROIC24 | None	sourceImage )

Prepares a lookup table for fast image unwarping.

Remarks:

The function should be called each time the system is re-calibrated (after the optical setup has been changed, for instance).

A sample source image has to be supplied to this method, and its row pitch is recorded in order to speedup the unwarping process. This implies that the following calls to eVision.Legacy.EWorldShape.Unwarp are not allowed to use images with row pitches different from the source image initially supplied to this method.

Parameters

lookupTable	Pointer to the lookup table.
sourceImage	Pointer to the source image/ROI.

SetupUnwarp() [5/6]

None eVision.Legacy.EWorldShape.SetupUnwarp	(		self,
		eVision.EUnwarpingLut | None	lookupTable,
		eVision.EROIC24 | None	sourceImage,
		bool	interpolate )

Prepares a lookup table for fast image unwarping.

Remarks:

The function should be called each time the system is re-calibrated (after the optical setup has been changed, for instance).

A sample source image has to be supplied to this method, and its row pitch is recorded in order to speedup the unwarping process. This implies that the following calls to eVision.Legacy.EWorldShape.Unwarp are not allowed to use images with row pitches different from the source image initially supplied to this method.

Parameters

lookupTable	Pointer to the lookup table.
sourceImage	Pointer to the source image/ROI.
interpolate	Interpolation mode. Default value is true.

SetupUnwarp() [6/6]

None eVision.Legacy.EWorldShape.SetupUnwarp	(		self,
		eVision.EUnwarpingLut | None	lookupTable,
		eVision.EROIC24 | None	sourceImage,
		bool	interpolate,
		bool	resizeDestination )

Prepares a lookup table for fast image unwarping.

Remarks:

The function should be called each time the system is re-calibrated (after the optical setup has been changed, for instance).

A sample source image has to be supplied to this method, and its row pitch is recorded in order to speedup the unwarping process. This implies that the following calls to eVision.Legacy.EWorldShape.Unwarp are not allowed to use images with row pitches different from the source image initially supplied to this method.

Parameters

lookupTable	Pointer to the lookup table.
sourceImage	Pointer to the source image/ROI.
interpolate	Interpolation mode. Default value is true.
resizeDestination	Resize the destination image to match the unwarped image size. Default value is false.

SetZoom() [1/3]

None eVision.Legacy.EWorldShape.SetZoom

(

self

)

Sets the horizontal and vertical zooming factors for drawing operations.

Remarks:

All objects attached to an eVision.Legacy.EWorldShape.__init__ inherit of the same zooming factor.

Reimplemented from eVision.Legacy.EShape.

SetZoom() [2/3]

None eVision.Legacy.EWorldShape.SetZoom	(		self,
		float	zoomX )

Sets the horizontal and vertical zooming factors for drawing operations.

Remarks:

All objects attached to an eVision.Legacy.EWorldShape.__init__ inherit of the same zooming factor.

Parameters

zoomX

Horizontal zooming factor. By default, true scale is used.

Reimplemented from eVision.Legacy.EShape.

SetZoom() [3/3]

None eVision.Legacy.EWorldShape.SetZoom	(		self,
		float	zoomX,
		float	zoomY )

Sets the horizontal and vertical zooming factors for drawing operations.

Remarks:

All objects attached to an eVision.Legacy.EWorldShape.__init__ inherit of the same zooming factor.

Parameters

zoomX	Horizontal zooming factor. By default, true scale is used.
zoomY	Vertical zooming factor. If set to 0, the default value, the horizontal zooming factor is used instead, so as to provide isotropic zooming.

Reimplemented from eVision.Legacy.EShape.

TiltXAngle()

float eVision.Legacy.EWorldShape.TiltXAngle

(

self

)

Tilt X angle, that is the amplitude of the rotation applied around the X-axis of the sensor to bring the optical (Z) axis perpendicular to the field of view.

Remarks:

Tilt X Angle and Tilt Y Angle

TiltYAngle()

float eVision.Legacy.EWorldShape.TiltYAngle

(

self

)

Tilt Y angle, that is the amplitude of the rotation applied around the Y-axis of the sensor to bring the optical (Z) axis perpendicular to the field of view.

Remarks:

Tilt X Angle and Tilt Y Angle

Type()

eVision.EShapeType eVision.Legacy.EWorldShape.Type

(

self

)

Shape type.

Reimplemented from eVision.Legacy.EShape.

Unwarp() [1/20]

None eVision.Legacy.EWorldShape.Unwarp	(		self,
		eVision.EROIBW8 | None	sourceImage,
		eVision.EROIBW8 | None	destinationImage )

Unwarps a distorted image using the current calibration model.

Remarks:

Using a precomputed lookup table allows speeding up the unwarping process. The lookup table is initialized by means of the eVision.Legacy.EWorldShape.SetupUnwarp function.

Parameters

sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination unwarped image. If optional parameter resizeDestination is false (default value) then the source and destination images must have the same size.

Unwarp() [2/20]

None eVision.Legacy.EWorldShape.Unwarp	(		self,
		eVision.EROIBW8 | None	sourceImage,
		eVision.EROIBW8 | None	destinationImage,
		bool	interpolate )

Unwarps a distorted image using the current calibration model.

Remarks:

Using a precomputed lookup table allows speeding up the unwarping process. The lookup table is initialized by means of the eVision.Legacy.EWorldShape.SetupUnwarp function.

Parameters

sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination unwarped image. If optional parameter resizeDestination is false (default value) then the source and destination images must have the same size.
interpolate	Interpolation mode. Default value is true.

Unwarp() [3/20]

None eVision.Legacy.EWorldShape.Unwarp	(		self,
		eVision.EROIBW8 | None	sourceImage,
		eVision.EROIBW8 | None	destinationImage,
		bool	interpolate,
		bool	resizeDestination )

Unwarps a distorted image using the current calibration model.

Remarks:

Using a precomputed lookup table allows speeding up the unwarping process. The lookup table is initialized by means of the eVision.Legacy.EWorldShape.SetupUnwarp function.

Parameters

sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination unwarped image. If optional parameter resizeDestination is false (default value) then the source and destination images must have the same size.
interpolate	Interpolation mode. Default value is true.
resizeDestination	Resize the destination image to match the unwarped image size. Default value is false.

Unwarp() [4/20]

None eVision.Legacy.EWorldShape.Unwarp	(		self,
		eVision.EROIBW8 | None	sourceImage,
		eVision.EROIBW8 | None	destinationImage,
		eVision.ERegion	region )

Unwarps a distorted image using the current calibration model.

Remarks:

Using a precomputed lookup table allows speeding up the unwarping process. The lookup table is initialized by means of the eVision.Legacy.EWorldShape.SetupUnwarp function.

Parameters

sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination unwarped image. If optional parameter resizeDestination is false (default value) then the source and destination images must have the same size.
region	Output region.

Unwarp() [5/20]

None eVision.Legacy.EWorldShape.Unwarp	(		self,
		eVision.EROIBW8 | None	sourceImage,
		eVision.EROIBW8 | None	destinationImage,
		eVision.ERegion	region,
		bool	interpolate )

Unwarps a distorted image using the current calibration model.

Remarks:

Using a precomputed lookup table allows speeding up the unwarping process. The lookup table is initialized by means of the eVision.Legacy.EWorldShape.SetupUnwarp function.

Parameters

sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination unwarped image. If optional parameter resizeDestination is false (default value) then the source and destination images must have the same size.
region	Output region.
interpolate	Interpolation mode. Default value is true.

Unwarp() [6/20]

None eVision.Legacy.EWorldShape.Unwarp	(		self,
		eVision.EROIBW8 | None	sourceImage,
		eVision.EROIBW8 | None	destinationImage,
		eVision.ERegion	region,
		bool	interpolate,
		bool	resizeDestination )

Unwarps a distorted image using the current calibration model.

Remarks:

Using a precomputed lookup table allows speeding up the unwarping process. The lookup table is initialized by means of the eVision.Legacy.EWorldShape.SetupUnwarp function.

Parameters

sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination unwarped image. If optional parameter resizeDestination is false (default value) then the source and destination images must have the same size.
region	Output region.
interpolate	Interpolation mode. Default value is true.
resizeDestination	Resize the destination image to match the unwarped image size. Default value is false.

Unwarp() [7/20]

None eVision.Legacy.EWorldShape.Unwarp	(		self,
		eVision.EROIC24 | None	sourceImage,
		eVision.EROIC24 | None	destinationImage )

Unwarps a distorted image using the current calibration model.

Remarks:

Using a precomputed lookup table allows speeding up the unwarping process. The lookup table is initialized by means of the eVision.Legacy.EWorldShape.SetupUnwarp function.

Parameters

sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination unwarped image. If optional parameter resizeDestination is false (default value) then the source and destination images must have the same size.

Unwarp() [8/20]

None eVision.Legacy.EWorldShape.Unwarp	(		self,
		eVision.EROIC24 | None	sourceImage,
		eVision.EROIC24 | None	destinationImage,
		bool	interpolate )

Unwarps a distorted image using the current calibration model.

Remarks:

Using a precomputed lookup table allows speeding up the unwarping process. The lookup table is initialized by means of the eVision.Legacy.EWorldShape.SetupUnwarp function.

Parameters

sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination unwarped image. If optional parameter resizeDestination is false (default value) then the source and destination images must have the same size.
interpolate	Interpolation mode. Default value is true.

Unwarp() [9/20]

None eVision.Legacy.EWorldShape.Unwarp	(		self,
		eVision.EROIC24 | None	sourceImage,
		eVision.EROIC24 | None	destinationImage,
		bool	interpolate,
		bool	resizeDestination )

Unwarps a distorted image using the current calibration model.

Remarks:

Using a precomputed lookup table allows speeding up the unwarping process. The lookup table is initialized by means of the eVision.Legacy.EWorldShape.SetupUnwarp function.

Parameters

sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination unwarped image. If optional parameter resizeDestination is false (default value) then the source and destination images must have the same size.
interpolate	Interpolation mode. Default value is true.
resizeDestination	Resize the destination image to match the unwarped image size. Default value is false.

Unwarp() [10/20]

None eVision.Legacy.EWorldShape.Unwarp	(		self,
		eVision.EROIC24 | None	sourceImage,
		eVision.EROIC24 | None	destinationImage,
		eVision.ERegion	region )

Unwarps a distorted image using the current calibration model.

Remarks:

Using a precomputed lookup table allows speeding up the unwarping process. The lookup table is initialized by means of the eVision.Legacy.EWorldShape.SetupUnwarp function.

Parameters

sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination unwarped image. If optional parameter resizeDestination is false (default value) then the source and destination images must have the same size.
region	Output region.

Unwarp() [11/20]

None eVision.Legacy.EWorldShape.Unwarp	(		self,
		eVision.EROIC24 | None	sourceImage,
		eVision.EROIC24 | None	destinationImage,
		eVision.ERegion	region,
		bool	interpolate )

Unwarps a distorted image using the current calibration model.

Remarks:

Using a precomputed lookup table allows speeding up the unwarping process. The lookup table is initialized by means of the eVision.Legacy.EWorldShape.SetupUnwarp function.

Parameters

sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination unwarped image. If optional parameter resizeDestination is false (default value) then the source and destination images must have the same size.
region	Output region.
interpolate	Interpolation mode. Default value is true.

Unwarp() [12/20]

None eVision.Legacy.EWorldShape.Unwarp	(		self,
		eVision.EROIC24 | None	sourceImage,
		eVision.EROIC24 | None	destinationImage,
		eVision.ERegion	region,
		bool	interpolate,
		bool	resizeDestination )

Unwarps a distorted image using the current calibration model.

Remarks:

Using a precomputed lookup table allows speeding up the unwarping process. The lookup table is initialized by means of the eVision.Legacy.EWorldShape.SetupUnwarp function.

Parameters

sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination unwarped image. If optional parameter resizeDestination is false (default value) then the source and destination images must have the same size.
region	Output region.
interpolate	Interpolation mode. Default value is true.
resizeDestination	Resize the destination image to match the unwarped image size. Default value is false.

Unwarp() [13/20]

None eVision.Legacy.EWorldShape.Unwarp	(		self,
		eVision.EUnwarpingLut | None	lookupTable,
		eVision.EROIBW8 | None	sourceImage,
		eVision.EROIBW8 | None	destinationImage )

Unwarps a distorted image using the current calibration model.

Remarks:

Using a precomputed lookup table allows speeding up the unwarping process. The lookup table is initialized by means of the eVision.Legacy.EWorldShape.SetupUnwarp function.

Parameters

lookupTable	Pointer to the lookup table.
sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination unwarped image. If optional parameter resizeDestination is false (default value) then the source and destination images must have the same size.

Unwarp() [14/20]

None eVision.Legacy.EWorldShape.Unwarp	(		self,
		eVision.EUnwarpingLut | None	lookupTable,
		eVision.EROIBW8 | None	sourceImage,
		eVision.EROIBW8 | None	destinationImage,
		bool	interpolate )

Unwarps a distorted image using the current calibration model.

Remarks:

Using a precomputed lookup table allows speeding up the unwarping process. The lookup table is initialized by means of the eVision.Legacy.EWorldShape.SetupUnwarp function.

Parameters

lookupTable	Pointer to the lookup table.
sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination unwarped image. If optional parameter resizeDestination is false (default value) then the source and destination images must have the same size.
interpolate	Interpolation mode. Default value is true.

Unwarp() [15/20]

None eVision.Legacy.EWorldShape.Unwarp	(		self,
		eVision.EUnwarpingLut | None	lookupTable,
		eVision.EROIBW8 | None	sourceImage,
		eVision.EROIBW8 | None	destinationImage,
		eVision.ERegion	region )

Unwarps a distorted image using the current calibration model.

Remarks:

Using a precomputed lookup table allows speeding up the unwarping process. The lookup table is initialized by means of the eVision.Legacy.EWorldShape.SetupUnwarp function.

Parameters

lookupTable	Pointer to the lookup table.
sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination unwarped image. If optional parameter resizeDestination is false (default value) then the source and destination images must have the same size.
region	Output region.

Unwarp() [16/20]

None eVision.Legacy.EWorldShape.Unwarp	(		self,
		eVision.EUnwarpingLut | None	lookupTable,
		eVision.EROIBW8 | None	sourceImage,
		eVision.EROIBW8 | None	destinationImage,
		eVision.ERegion	region,
		bool	interpolate )

Unwarps a distorted image using the current calibration model.

Remarks:

Using a precomputed lookup table allows speeding up the unwarping process. The lookup table is initialized by means of the eVision.Legacy.EWorldShape.SetupUnwarp function.

Parameters

lookupTable	Pointer to the lookup table.
sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination unwarped image. If optional parameter resizeDestination is false (default value) then the source and destination images must have the same size.
region	Output region.
interpolate	Interpolation mode. Default value is true.

Unwarp() [17/20]

None eVision.Legacy.EWorldShape.Unwarp	(		self,
		eVision.EUnwarpingLut | None	lookupTable,
		eVision.EROIC24 | None	sourceImage,
		eVision.EROIC24 | None	destinationImage )

Unwarps a distorted image using the current calibration model.

Remarks:

Using a precomputed lookup table allows speeding up the unwarping process. The lookup table is initialized by means of the eVision.Legacy.EWorldShape.SetupUnwarp function.

Parameters

lookupTable	Pointer to the lookup table.
sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination unwarped image. If optional parameter resizeDestination is false (default value) then the source and destination images must have the same size.

Unwarp() [18/20]

None eVision.Legacy.EWorldShape.Unwarp	(		self,
		eVision.EUnwarpingLut | None	lookupTable,
		eVision.EROIC24 | None	sourceImage,
		eVision.EROIC24 | None	destinationImage,
		bool	interpolate )

Unwarps a distorted image using the current calibration model.

Remarks:

Using a precomputed lookup table allows speeding up the unwarping process. The lookup table is initialized by means of the eVision.Legacy.EWorldShape.SetupUnwarp function.

Parameters

lookupTable	Pointer to the lookup table.
sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination unwarped image. If optional parameter resizeDestination is false (default value) then the source and destination images must have the same size.
interpolate	Interpolation mode. Default value is true.

Unwarp() [19/20]

None eVision.Legacy.EWorldShape.Unwarp	(		self,
		eVision.EUnwarpingLut | None	lookupTable,
		eVision.EROIC24 | None	sourceImage,
		eVision.EROIC24 | None	destinationImage,
		eVision.ERegion	region )

Unwarps a distorted image using the current calibration model.

Remarks:

Using a precomputed lookup table allows speeding up the unwarping process. The lookup table is initialized by means of the eVision.Legacy.EWorldShape.SetupUnwarp function.

Parameters

lookupTable	Pointer to the lookup table.
sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination unwarped image. If optional parameter resizeDestination is false (default value) then the source and destination images must have the same size.
region	Output region.

Unwarp() [20/20]

None eVision.Legacy.EWorldShape.Unwarp	(		self,
		eVision.EUnwarpingLut | None	lookupTable,
		eVision.EROIC24 | None	sourceImage,
		eVision.EROIC24 | None	destinationImage,
		eVision.ERegion	region,
		bool	interpolate )

Unwarps a distorted image using the current calibration model.

Remarks:

Using a precomputed lookup table allows speeding up the unwarping process. The lookup table is initialized by means of the eVision.Legacy.EWorldShape.SetupUnwarp function.

Parameters

lookupTable	Pointer to the lookup table.
sourceImage	Pointer to the source image/ROI.
destinationImage	Pointer to the destination unwarped image. If optional parameter resizeDestination is false (default value) then the source and destination images must have the same size.
region	Output region.
interpolate	Interpolation mode. Default value is true.

WorldToSensor()

eVision.EPoint eVision.Legacy.EWorldShape.WorldToSensor	(		self,
		eVision.EPoint	worldPoint )

Performs coordinate transform for arbitrary points from World space to Sensor space.

Remarks:

This transformation is impossible when the world point is located on the principal plane of the camera (the plane parallel to the camera sensor containing the center of projection of the camera). In this case, the returned point will contain infinity values. This usually happens when the calibration plane was highly tilted with respect to the camera.

Parameters

worldPoint

World point.

XResolution()

float eVision.Legacy.EWorldShape.XResolution

(

self

)

Horizontal sensor resolution, in pixels per unit.

YResolution()

float eVision.Legacy.EWorldShape.YResolution

(

self

)

Vertical sensor resolution, in pixels per unit.

ZoomX()

float eVision.Legacy.EWorldShape.ZoomX

(

self

)

Current horizontal zooming factor for drawing operations.

Reimplemented from eVision.Legacy.EShape.

ZoomY()

float eVision.Legacy.EWorldShape.ZoomY

(

self

)

Current vertical zooming factor for drawing operations.

Reimplemented from eVision.Legacy.EShape.

Property Documentation

Distortion

eVision.Legacy.EWorldShape.Distortion

static

Initial value:

=  property(None, _Distortion__setter, None,
        
    )