Represents a model of an (arc of) ellipse. More...

Inheritance diagram for eVision.EEllipse:

Collaboration diagram for eVision.EEllipse:

Public Member Functions
None	__init__ (self)
	Constructs a eVision.EEllipse object.
None	__init__ (self, eVision.EPoint center, float radiusX, float radiusY, float radiusXOrientation, bool direct)
	Constructs a eVision.EEllipse object.
None	__init__ (self, eVision.EPoint center, float radiusX, float radiusY, float radiusXOrientation)
	Constructs a eVision.EEllipse object.
None	__init__ (self, eVision.EPoint center, float radiusX, float radiusY, float radiusXOrientation, float originAngle, float amplitude, bool direct)
	Constructs a eVision.EEllipse object.
None	__init__ (self, eVision.EPoint center, float radiusX, float radiusY, float radiusXOrientation, float originAngle, float amplitude)
	Constructs a eVision.EEllipse object.
None	__init__ (self, eVision.EEllipse other)
	Constructs a eVision.EEllipse object.
None	CopyTo (self, eVision.EEllipse other)
	Copies all the data of the current eVision.EEllipse object into another eVision.EEllipse object and returns it.
bool	IsFull (self)
	Flag indicating whether the eVision.EEllipse object is a full ellipse or not.
bool	IsDirect (self)
	Flag indicating whether positive angles correspond to a clockwise or an anticlockwise rotation.
Public Member Functions inherited from eVision.EShape
None	Load (self, str path)
	Load the eVision.EShape configuration.
None	Load (self, eVision.ESerializer\|None serializer)
	Load the eVision.EShape configuration.
None	Save (self, str path)
	Save the eVision.EShape configuration.
None	Save (self, eVision.ESerializer\|None serializer)
	Save the eVision.EShape configuration.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, float zoomX, float zoomY, float panX, float panY, bool drawDiagonals)
	Draws the eVision.EShape shape.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, float zoomX, float zoomY, float panX, float panY)
	Draws the eVision.EShape shape.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, float zoomX, float zoomY, float panX)
	Draws the eVision.EShape shape.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, float zoomX, float zoomY)
	Draws the eVision.EShape shape.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, float zoomX)
	Draws the eVision.EShape shape.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter)
	Draws the eVision.EShape shape.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY, bool drawDiagonals)
	Draws the eVision.EShape shape.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY)
	Draws the eVision.EShape shape.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY, float panX)
	Draws the eVision.EShape shape.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, eVision.EFrame frame, float zoomX, float zoomY)
	Draws the eVision.EShape shape.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, eVision.EFrame frame, float zoomX)
	Draws the eVision.EShape shape.
None	Draw (self, eVision.EDrawAdapter\|None drawAdapter, eVision.EFrame frame)
	Draws the eVision.EShape shape.
eVision.EEditionMode	HitTest (self, int x, int y, float zoomX, float zoomY, float panX, float panY)
	Detects if the cursor is placed over one of the dragging handles.
eVision.EEditionMode	HitTest (self, int x, int y, float zoomX, float zoomY, float panX)
	Detects if the cursor is placed over one of the dragging handles.
eVision.EEditionMode	HitTest (self, int x, int y, float zoomX, float zoomY)
	Detects if the cursor is placed over one of the dragging handles.
eVision.EEditionMode	HitTest (self, int x, int y, float zoomX)
	Detects if the cursor is placed over one of the dragging handles.
eVision.EEditionMode	HitTest (self, int x, int y, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY)
	Detects if the cursor is placed over one of the dragging handles.
eVision.EEditionMode	HitTest (self, int x, int y, eVision.EFrame frame, float zoomX, float zoomY, float panX)
	Detects if the cursor is placed over one of the dragging handles.
eVision.EEditionMode	HitTest (self, int x, int y, eVision.EFrame frame, float zoomX, float zoomY)
	Detects if the cursor is placed over one of the dragging handles.
eVision.EEditionMode	HitTest (self, int x, int y, eVision.EFrame frame, float zoomX)
	Detects if the cursor is placed over one of the dragging handles.
None	Drag (self, int x, int y, float zoomX, float zoomY, float panX, float panY)
	Moves the specified handle to a new position and updates all placement parameters of the region.
None	Drag (self, int x, int y, float zoomX, float zoomY, float panX)
	Moves the specified handle to a new position and updates all placement parameters of the region.
None	Drag (self, int x, int y, float zoomX, float zoomY)
	Moves the specified handle to a new position and updates all placement parameters of the region.
None	Drag (self, int x, int y, float zoomX)
	Moves the specified handle to a new position and updates all placement parameters of the region.
None	Drag (self, int x, int y)
	Moves the specified handle to a new position and updates all placement parameters of the region.
None	Drag (self, int x, int y, eVision.EFrame frame, float zoomX, float zoomY, float panX, float panY)
	Moves the specified handle to a new position and updates all placement parameters of the region.
None	Drag (self, int x, int y, eVision.EFrame frame, float zoomX, float zoomY, float panX)
	Moves the specified handle to a new position and updates all placement parameters of the region.
None	Drag (self, int x, int y, eVision.EFrame frame, float zoomX, float zoomY)
	Moves the specified handle to a new position and updates all placement parameters of the region.
None	Drag (self, int x, int y, eVision.EFrame frame, float zoomX)
	Moves the specified handle to a new position and updates all placement parameters of the region.
None	Drag (self, int x, int y, eVision.EFrame frame)
	Moves the specified handle to a new position and updates all placement parameters of the region.
eVision.EFrame	ToFrame (self, bool useAngle, eVision.EFrameScaling frameScaling)
	Converts the shape to a frame.
eVision.EFrame	ToFrame (self, bool useAngle, eVision.EFrameScaling frameScaling, eVision.EFrame shapeFrame)
	Converts the shape to a frame.
list[eVision._eVision.EFrame]	CreateFramesOnShape (self, int numFrames, float startOffset, float stopOffset, eVision.EFramesOrientation orientation)
	Distributes eVision.EFrames evenly along this shape's path or perimeter.
list[eVision._eVision.EFrame]	CreateFramesOnShape (self, int numFrames, float startOffset, float stopOffset)
	Distributes eVision.EFrames evenly along this shape's path or perimeter.
list[eVision._eVision.EFrame]	CreateFramesOnShape (self, int numFrames, float startOffset)
	Distributes eVision.EFrames evenly along this shape's path or perimeter.
list[eVision._eVision.EFrame]	CreateFramesOnShape (self, int numFrames)
	Distributes eVision.EFrames evenly along this shape's path or perimeter.

Static Public Member Functions
float	GetDistanceBetweenPointAndEllipse (eVision.EPoint pt, eVision.EEllipse ellipse, bool limited)
	Computes the distance between a point and an ellipse.
float	GetDistanceBetweenPointAndEllipse (eVision.EPoint pt, eVision.EEllipse ellipse)
	Computes the distance between a point and an ellipse.
eVision.EEllipse	Fit (list[eVision._eVision.EPoint] points, bool fitArc, int numFilteringPasses, float filteringThreshold)
	Fits an ellipse to a set of points.
eVision.EEllipse	Fit (list[eVision._eVision.EPoint] points, bool fitArc, int numFilteringPasses)
	Fits an ellipse to a set of points.
eVision.EEllipse	Fit (list[eVision._eVision.EPoint] points, bool fitArc)
	Fits an ellipse to a set of points.
eVision.EEllipse	Fit (list[eVision._eVision.EPoint] points)
	Fits an ellipse to a set of points.

Properties
	Center = property(_Center__getter, _Center__setter)
	Center of the eVision.EEllipse.
	CenterX = property(_CenterX__getter, _CenterX__setter)
	Abscissa of the center of the eVision.EEllipse.
	CenterY = property(_CenterY__getter, _CenterY__setter)
	Ordinate of the the center of the eVision.EEllipse.
	Angle = property(_Angle__getter, _Angle__setter)
	Orientation of the eVision.EEllipse.
	HorizontalRadius = property(_HorizontalRadius__getter, _HorizontalRadius__setter)
	Horizontal Radius of a eVision.EEllipse object.
	VerticalRadius = property(_VerticalRadius__getter, _VerticalRadius__setter)
	Vertical Radius of a eVision.EEllipse object.
	HorizontalRadiusOrientation = property(_HorizontalRadiusOrientation__getter, _HorizontalRadiusOrientation__setter)
	Orientation of the horizontal Radius of a eVision.EEllipse object.
	OriginAngle = property(_OriginAngle__getter, _OriginAngle__setter)
	Angular position from where the eVision.EEllipse object extents.
	EndAngle = property(_EndAngle__getter, None)
	Angular position of the end of a eVision.EEllipse object.
	Amplitude = property(_Amplitude__getter, _Amplitude__setter)
	Angular amplitude of the eVision.EEllipse object.
	AvailableEditionModes = property(_AvailableEditionModes__getter, None)
	Available edition modes for the shape.
	Description = property(_Description__getter, None)
	Textual description of the shape and its parameters.
Properties inherited from eVision.EShape
	EditionMode = property(_EditionMode__getter, _EditionMode__setter)
	Current edition mode for the shape.
	AvailableEditionModes = property(_AvailableEditionModes__getter, None)
	Available edition modes for the shape.
	Description = property(_Description__getter, None)
	Textual description of the shape and its parameters.

Detailed Description

Represents a model of an (arc of) ellipse.

Remarks:

License(s): BasicTypes

Constructor & Destructor Documentation

◆ init() [1/6]

None eVision.EEllipse.__init__ ( self )

Constructs a eVision.EEllipse object.

◆ init() [2/6]

None eVision.EEllipse.__init__	(		self,
		eVision.EPoint	center,
		float	radiusX,
		float	radiusY,
		float	radiusXOrientation,
		bool	direct )

Constructs a eVision.EEllipse object.

Parameters

center	Center coordinates of the ellipse at its nominal position. The default value is (0,0).
radiusX	horizontal radius of the ellipse. The default value is 100.
radiusY	vertical radius of the ellipse. The default value is 50.
radiusXOrientation	Orientation of the horizontal radius of the ellipse. The default value is 0.
direct	true (default) means that angles increase anticlockwisely in a direct coordinate system.

◆ init() [3/6]

None eVision.EEllipse.__init__	(		self,
		eVision.EPoint	center,
		float	radiusX,
		float	radiusY,
		float	radiusXOrientation )

Constructs a eVision.EEllipse object.

Parameters

center	Center coordinates of the ellipse at its nominal position. The default value is (0,0).
radiusX	horizontal radius of the ellipse. The default value is 100.
radiusY	vertical radius of the ellipse. The default value is 50.
radiusXOrientation	Orientation of the horizontal radius of the ellipse. The default value is 0.

◆ init() [4/6]

None eVision.EEllipse.__init__	(		self,
		eVision.EPoint	center,
		float	radiusX,
		float	radiusY,
		float	radiusXOrientation,
		float	originAngle,
		float	amplitude,
		bool	direct )

Constructs a eVision.EEllipse object.

Parameters

center	Center coordinates of the ellipse at its nominal position. The default value is (0,0).
radiusX	horizontal radius of the ellipse. The default value is 100.
radiusY	vertical radius of the ellipse. The default value is 50.
radiusXOrientation	Orientation of the horizontal radius of the ellipse. The default value is 0.
originAngle	Nominal angular origin of the (arc of) ellipse. The default value is 0°.
amplitude	Nominal angular amplitude of the (arc of) ellipse. The default value is 360°.
direct	true (default) means that angles increase anticlockwisely in a direct coordinate system.

◆ init() [5/6]

None eVision.EEllipse.__init__	(		self,
		eVision.EPoint	center,
		float	radiusX,
		float	radiusY,
		float	radiusXOrientation,
		float	originAngle,
		float	amplitude )

Constructs a eVision.EEllipse object.

Parameters

center	Center coordinates of the ellipse at its nominal position. The default value is (0,0).
radiusX	horizontal radius of the ellipse. The default value is 100.
radiusY	vertical radius of the ellipse. The default value is 50.
radiusXOrientation	Orientation of the horizontal radius of the ellipse. The default value is 0.
originAngle	Nominal angular origin of the (arc of) ellipse. The default value is 0°.
amplitude	Nominal angular amplitude of the (arc of) ellipse. The default value is 360°.

◆ init() [6/6]

None eVision.EEllipse.__init__	(		self,
		eVision.EEllipse	other )

Constructs a eVision.EEllipse object.

Parameters

other Another eVision.EEllipse object to be copied in the new eVision.EEllipse object.

Member Function Documentation

◆ CopyTo()

None eVision.EEllipse.CopyTo	(		self,
		eVision.EEllipse	other )

Copies all the data of the current eVision.EEllipse object into another eVision.EEllipse object and returns it.

Remarks:

In the overload taking a pointer, in case of a NULL pointer, a new eVision.EEllipse object will be created and returned.

Parameters

other eVision.EEllipse object in which the current eVision.EEllipse object data have to be copied.

◆ Fit() [1/4]

eVision.EEllipse eVision.EEllipse.Fit ( list[eVision._eVision.EPoint] points )

static

Fits an ellipse to a set of points.

Remarks:

During a filtering pass, the points that are too distant from the model are discarded. During a model fitting operation, the "filtering" process can be invoked to remove outliers, i.e. points that were located significantly far away from the fitted model (so that their position is dubious).

This method returns a "direct" eVision.EEllipse, see eVision.EEllipse.IsDirect.

Parameters

points Vector of points to fit.

◆ Fit() [2/4]

eVision.EEllipse eVision.EEllipse.Fit	(	list[eVision._eVision.EPoint]	points,
		bool	fitArc )

static

Fits an ellipse to a set of points.

Remarks:

During a filtering pass, the points that are too distant from the model are discarded. During a model fitting operation, the "filtering" process can be invoked to remove outliers, i.e. points that were located significantly far away from the fitted model (so that their position is dubious).

This method returns a "direct" eVision.EEllipse, see eVision.EEllipse.IsDirect.

Parameters

points	Vector of points to fit.
fitArc	If true, an ellipse arc big enough to be close to all points will be returned instead of a full ellipse. Defaults to false.

◆ Fit() [3/4]

eVision.EEllipse eVision.EEllipse.Fit	(	list[eVision._eVision.EPoint]	points,
		bool	fitArc,
		int	numFilteringPasses )

static

Fits an ellipse to a set of points.

Remarks:

During a filtering pass, the points that are too distant from the model are discarded. During a model fitting operation, the "filtering" process can be invoked to remove outliers, i.e. points that were located significantly far away from the fitted model (so that their position is dubious).

This method returns a "direct" eVision.EEllipse, see eVision.EEllipse.IsDirect.

Parameters

points	Vector of points to fit.
fitArc	If true, an ellipse arc big enough to be close to all points will be returned instead of a full ellipse. Defaults to false.
numFilteringPasses	Number of filtering passes for an ellipse fitting operation. Defaults to 0 (no filtering performed).

◆ Fit() [4/4]

eVision.EEllipse eVision.EEllipse.Fit	(	list[eVision._eVision.EPoint]	points,
		bool	fitArc,
		int	numFilteringPasses,
		float	filteringThreshold )

static

Fits an ellipse to a set of points.

Remarks:

During a filtering pass, the points that are too distant from the model are discarded. During a model fitting operation, the "filtering" process can be invoked to remove outliers, i.e. points that were located significantly far away from the fitted model (so that their position is dubious).

This method returns a "direct" eVision.EEllipse, see eVision.EEllipse.IsDirect.

Parameters

points	Vector of points to fit.
fitArc	If true, an ellipse arc big enough to be close to all points will be returned instead of a full ellipse. Defaults to false.
numFilteringPasses	Number of filtering passes for an ellipse fitting operation. Defaults to 0 (no filtering performed).
filteringThreshold	Relative filtering threshold, that is the fraction of the average distance between the points and the fitted model above which a point is filtered out. Defaults to 3.

◆ GetDistanceBetweenPointAndEllipse() [1/2]

float eVision.EEllipse.GetDistanceBetweenPointAndEllipse	(	eVision.EPoint	pt,
		eVision.EEllipse	ellipse )

static

Computes the distance between a point and an ellipse.

Note that we compute the distance between the point and its projection on the ellipse. This is not always the shortest distance.

Remarks:

When the ellipse is restricted to an arc and the orthogonal projection of the point onto the ellipse falls outside this arc, the distance to the closest endpoint of the arc is returned instead.

Parameters

pt	The point.
ellipse	The ellipse.

◆ GetDistanceBetweenPointAndEllipse() [2/2]

float eVision.EEllipse.GetDistanceBetweenPointAndEllipse	(	eVision.EPoint	pt,
		eVision.EEllipse	ellipse,
		bool	limited )

static

Computes the distance between a point and an ellipse.

Note that we compute the distance between the point and its projection on the ellipse. This is not always the shortest distance.

Remarks:

When the ellipse is restricted to an arc and the orthogonal projection of the point onto the ellipse falls outside this arc, the distance to the closest endpoint of the arc is returned instead.

Parameters

pt	The point.
ellipse	The ellipse.
limited	Indicates if the ellipse parameter should be considered as a full ellipse or as an arc.

◆ IsDirect()

bool eVision.EEllipse.IsDirect ( self )

Flag indicating whether positive angles correspond to a clockwise or an anticlockwise rotation.

Remarks:

true (default) means that angles increase anticlockwisely in a direct coordinate system, and clockwisely in an inverse coordinate system.

When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards.
When the field of view is not calibrated, the coordinate system is said to be inverse, the abscissa extends rightwards and the ordinate extends downwards.

◆ IsFull()

bool eVision.EEllipse.IsFull ( self )

Flag indicating whether the eVision.EEllipse object is a full ellipse or not.

Remarks:

By default (true), the eVision.EEllipse object is a full ellipse.

Property Documentation

◆ Amplitude

eVision.EEllipse.Amplitude = property(_Amplitude__getter, _Amplitude__setter)

static

Angular amplitude of the eVision.EEllipse object.

Remarks:

The default value is 360°. The sign of the rotation angle depends whether the field of view is calibrated or not.

When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards. In this case, an anticlockwise rotation leads to a positive angle value.
When the field of view is not calibrated, the coordinate system is said to be inverse, the abscissa extends rightwards and the ordinate extends downwards. In this case, a clockwise rotation leads to a positive angle value.

◆ Angle

eVision.EEllipse.Angle = property(_Angle__getter, _Angle__setter)

static

Orientation of the eVision.EEllipse.

◆ AvailableEditionModes

eVision.EEllipse.AvailableEditionModes = property(_AvailableEditionModes__getter, None)

static

Available edition modes for the shape.

◆ Center

eVision.EEllipse.Center = property(_Center__getter, _Center__setter)

static

Center of the eVision.EEllipse.

◆ CenterX

eVision.EEllipse.CenterX = property(_CenterX__getter, _CenterX__setter)

static

Abscissa of the center of the eVision.EEllipse.

◆ CenterY

eVision.EEllipse.CenterY = property(_CenterY__getter, _CenterY__setter)

static

Ordinate of the the center of the eVision.EEllipse.

◆ Description

eVision.EEllipse.Description = property(_Description__getter, None)

static

Textual description of the shape and its parameters.

◆ EndAngle

eVision.EEllipse.EndAngle = property(_EndAngle__getter, None)

static

Angular position of the end of a eVision.EEllipse object.

Remarks:

The sign of the rotation angle depends whether the field of view is calibrated or not.

When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards. In this case, an anticlockwise rotation leads to a positive angle value.
When the field of view is not calibrated, the coordinate system is said to be inverse, the abscissa extends rightwards and the ordinate extends downwards. In this case, a clockwise rotation leads to a positive angle value.

◆ HorizontalRadius

eVision.EEllipse.HorizontalRadius = property(_HorizontalRadius__getter, _HorizontalRadius__setter)

static

Horizontal Radius of a eVision.EEllipse object.

◆ HorizontalRadiusOrientation

eVision.EEllipse.HorizontalRadiusOrientation = property(_HorizontalRadiusOrientation__getter, _HorizontalRadiusOrientation__setter)

static

Orientation of the horizontal Radius of a eVision.EEllipse object.

◆ OriginAngle

eVision.EEllipse.OriginAngle = property(_OriginAngle__getter, _OriginAngle__setter)

static

Angular position from where the eVision.EEllipse object extents.

Remarks:

The sign of the rotation angle depends whether the field of view is calibrated or not.

When the field of view is calibrated, the coordinate system is said to be direct, the abscissa extends rightwards and the ordinate extends upwards. In this case, an anticlockwise rotation leads to a positive angle value.
When the field of view is not calibrated, the coordinate system is said to be inverse, the abscissa extends rightwards and the ordinate extends downwards. In this case, a clockwise rotation leads to a positive angle value.

◆ VerticalRadius

eVision.EEllipse.VerticalRadius = property(_VerticalRadius__getter, _VerticalRadius__setter)

static

Vertical Radius of a eVision.EEllipse object.

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/6]

◆ __init__() [2/6]

◆ __init__() [3/6]

◆ __init__() [4/6]

◆ __init__() [5/6]

◆ __init__() [6/6]

Member Function Documentation

◆ CopyTo()

◆ Fit() [1/4]

◆ Fit() [2/4]

◆ Fit() [3/4]

◆ Fit() [4/4]

◆ GetDistanceBetweenPointAndEllipse() [1/2]

◆ GetDistanceBetweenPointAndEllipse() [2/2]

◆ IsDirect()

◆ IsFull()

Property Documentation

◆ Amplitude

◆ Angle

◆ AvailableEditionModes

◆ Center

◆ CenterX

◆ CenterY

◆ Description

◆ EndAngle

◆ HorizontalRadius

◆ HorizontalRadiusOrientation

◆ OriginAngle

◆ VerticalRadius

◆ init() [1/6]

◆ init() [2/6]

◆ init() [3/6]

◆ init() [4/6]

◆ init() [5/6]

◆ init() [6/6]