fmeobjects.FMEPath

FMEPath.appendPart(curve)	Append an entire curve.
FMEPath.appendPartWithSnapping(curve)	Append an entire segment.
FMEPath.boundingBox()	This method returns the bounding box of the geometry.
FMEPath.boundingCube()	This method returns the bounding cube of the geometry.
FMEPath.bounds()	Returns the bounds of the geometry.
FMEPath.clearMeasures()	Remove all measures from the geometry.
FMEPath.copyAttributesFromFeature(...)	Copies all the attributes from the given feature to traits on this geometry, if they match the (optional) regular expression.
FMEPath.copyNameFromGeometry(sourceGeometry)	Copies the name of the 'sourceGeometry' onto this geometry.
FMEPath.copyTraitsFromGeometry(...)	Copies all the traits from the given geometry that match the (optional) regular expression.
FMEPath.copyTraitsToFeature(destFeature, ...)	Copies all the traits from this geometry to attributes on the given feature, if they match the (optional) regular expression.
FMEPath.deleteName()	Deletes the geometry's name.
FMEPath.extendToPoint(point)	Extends the path to a point.
FMEPath.extendToPointXY(xcoord, ycoord)	Extend the path to a point.
FMEPath.extendToPointXYZ(xcoord, ycoord, zcoord)	Extend the path to a point.
FMEPath.extendToPointsXY(coords)	Extend the path to a list of points.
FMEPath.extendToPointsXYZ(coords)	Extend the path to a list of points.
FMEPath.force2D()	Reduces the geometry to 2D.
FMEPath.force3D(newZ)	This sets the geometry's dimension to 3D.
FMEPath.getArea()	Area calculation.
FMEPath.getAsLine()	Returns the curve as a line.
FMEPath.getAsLineFixedArcSamples(numSamples)	Returns a copy of this curve as a line.
FMEPath.getEndPoint()	Returns the end point of this curve.
FMEPath.getLength(threeD)	Returns the length of the curve.
FMEPath.getMeasureNames()	Retrieve the names of the measures on this geometry.
FMEPath.getName()	This routine retrieves the 'name' of this geometry as a str.
FMEPath.getPartAt(index)	This returns the part of the FMEPath at the given index.
FMEPath.getStartPoint()	Returns the start point of this curve.
FMEPath.getTrait(traitName)	Retrieves the geometry trait value of the specified trait name.
FMEPath.getTraitNames()	Retrieve the names of the traits on this geometry.
FMEPath.getTraitNullMissingAndType(traitName)	This method returns a tuple of a boolean, indicating if the trait is null, a boolean, indicating if the trait is missing, and an integer representing the type of the trait.
FMEPath.getTraitType(traitName)	Returns the type of given trait.
FMEPath.hasMeasures()	Check if this geometry or any sub part of this geometry has measures.
FMEPath.hasName()	Returns whether or not the geometry has a name.
FMEPath.is3D()	Returns whether or not the geometry is 3D.
FMEPath.isClosed(threeD)	Returns True if the start and end points have identical coordinate values.
FMEPath.isCollection()	Check if the geometry is an aggregate or multi-part collection.
FMEPath.isLinear()	Returns True if and only if this curve contains only lines.
FMEPath.measureExists(measureName)	Returns True if the specified measure exists and False otherwise.
FMEPath.numParts()	This returns the number of FMESegment that make up this path.
FMEPath.offset(offsetPoint)	Offsets the geometry by the coords specified by 'offsetPoint'.
FMEPath.removeDuplicates(checkZ)	Removes any adjacent duplicate points.
FMEPath.removeEndPart()	This removes the end FMESegment of the path.
FMEPath.removeMeasure(measureName)	Remove the specified measure if it exists.
FMEPath.removeTraits(regexp)	This method has 4 modes:
FMEPath.renameMeasure(oldMeasureName, ...)	Renames the measure specified by 'oldMeasureName' to the new name, specified by 'newMeasureName'.
FMEPath.reverse()	This reverses the order of the curve's points.
FMEPath.rotate2D(center, angle)	Rotate the curve counterclockwise around the 'center' point by the specified 'angle' (in degrees).
FMEPath.scale(xScale, yScale, zScale)	Scale the feature by the given amounts.
FMEPath.setEndPoint(point)	Changes the existing end point of this curve.
FMEPath.setName(name)	Sets the geometry's name with a str.
FMEPath.setStartPoint(point)	Changes the existing start point of this curve.
FMEPath.setTrait(traitName, traitValue)	Sets a geometry trait with the specified value.
FMEPath.setTraitNullWithType(traitName, ...)	This method supplies a null trait value with a type to the geometry.
FMEPath.snip(measureType, measure3D, ...)	Take a description of start and end positions (either as a measured 2D/3D distance, percentage, or normalized distance from the beginning, or a vertex index), and chop off only the portion between these positions.
FMEPath.snipByPoints(startPoint, endPoint)	Snip off the portion between two points.

class FMEPath

FME Path Class

Create an instance of a Path geometry object.

init()

Default FMEPath constructor.

Return type:

FMEPath

Returns:

An instance of a Path geometry object.

init(path)

Create a copy of the passed in Path geometry object.

Parameters:

path (FMEPath) – The Path geometry object to create a copy of.

Return type:

FMEPath

Returns:

An instance of a Path Geometry object.

__init__(*args, **kwargs)

appendPart(curve)

Append an entire curve. If the path and the curve are not connected, a new line will be inserted between them. If any 3D segments exist, all 2D segments will be converted to 3D with a default Z value of 0.0.

Parameters:

curve (FMECurve) – The curve to append.

Return type:

None

Raises:

FMEException – An exception is raised if an error occurred.

appendPartWithSnapping(curve)

Append an entire segment. If the path and the curve are not connected, the first point on the curve will be moved to instead be the last point on the path. If any 3D segments exist, all 2D segments will be converted to 3D with a default Z value of 0.0.

Parameters:

curve (FMECurve) – The curve to append with snapping.

Return type:

None

Raises:

FMEException – An exception is raised if an error occurred.

boundingBox()

This method returns the bounding box of the geometry.

Return type:

tuple[tuple[float]]

Returns:

The bounding box of the Geometry, in the form ((minx, miny), (maxx, maxy)).

boundingCube()

This method returns the bounding cube of the geometry.

Return type:

tuple[tuple[float]]

Returns:

The bounding box of the Geometry, in the form ((minx, miny, minz), (maxx, maxy, maxz)).

bounds()

Returns the bounds of the geometry.

Return type:

tuple[FMEPoint]

Returns:

The min point and max point of the bounds. None is returned if the geometry contains no points.

clearMeasures()

Remove all measures from the geometry.

Return type:

None

copyAttributesFromFeature(sourceFeature, overwriteExisting, regexp, prefix)

Copies all the attributes from the given feature to traits on this geometry, if they match the (optional) regular expression.

Parameters:

• sourceFeature (FMEFeature) – The feature to copy attributes from.

• overwriteExisting (bool) – Existing traits will be overwritten only if overwriteExisting is True.

• regexp (str) – (Optional) The regular expression to match the attributes against. If regexp is not specified, then all attributes will be copied.

• prefix (str) – (Optional) The prefix is put on all the trait names as they are copied. If it is not specified, a prefix will not be added to the trait names.

Return type:

None

copyNameFromGeometry(sourceGeometry)

Copies the name of the ‘sourceGeometry’ onto this geometry. If ‘sourceGeometry’s name is blank or None, this geometry’s name will become None.

Parameters:

sourceGeometry (FMEGeometry) – The geometry to copy the name from.

Return type:

None

copyTraitsFromGeometry(sourceGeometry, overwriteExisting, regexp, prefix)

Copies all the traits from the given geometry that match the (optional) regular expression.

Parameters:

• sourceGeometry (FMEGeometry) – The geometry to copy traits from.

• overwriteExisting (bool) – Existing traits will be overwritten only if overwriteExisting is True.

• regexp (str) – (Optional) The regular expression to match the traits against. If regexp is not specified, or is an empty string, then all traits will be copied.

• prefix (str) – (Optional) The prefix is put on all the trait names as they are copied. If it is not specified, a prefix will not be added to the trait names.

Return type:

None

copyTraitsToFeature(destFeature, overwriteExisting, regexp, prefix)

Copies all the traits from this geometry to attributes on the given feature, if they match the (optional) regular expression.

Parameters:

• destFeature (FMEFeature) – The feature to copy traits to.

• overwriteExisting (bool) – Existing attributes will be overwritten only if overwriteExisting is True.

• regexp (str) – (Optional) The regular expression to match the traits against. If regexp is not specified, or is an empty string, then all traits will be copied.

• prefix (str) – (Optional) The prefix is put on all the attribute names as they are copied. If it is not specified, a prefix will not be added to the attribute names.

Return type:

None

deleteName()

Deletes the geometry’s name. If a name existed prior to this call then True is returned; otherwise False is returned.

Return type:

bool

Returns:

Returns a boolean indicating whether or not the name existed before deletion.

extendToPoint(point)

Extends the path to a point. If the point is 2D and the path is 3D, the point will be set to 3D with a Z value of 0.0. If the path is 2D and the point is 3D, the segments in the path will be set to 3D with 0.0 for Z values. If None is passed in, nothing will be appended.

Parameters:

point (FMEPoint) – The point to be extended to.

Return type:

None

Raises:

FMEException – An exception is raised if an error occurred.

extendToPointXY(xcoord, ycoord)

Extend the path to a point. If this method is called on a 3D line, a Z value of 0.0 will be used for each appended point.

Parameters:

• xcoord (float) – The x coordinate of the point to be extended to.

• ycoord (float) – The y coordinate of the point to be extended to.

Return type:

None

extendToPointXYZ(xcoord, ycoord, zcoord)

Extend the path to a point. If this method is called on a 2D line, the line will be forced to 3D with a default Z value of 0.0.

Parameters:

• xcoord (float) – The x coordinate of the point to be extended to.

• ycoord (float) – The y coordinate of the point to be extended to.

• zcoord (float) – The z coordinate of the point to be extended to.

Return type:

None

extendToPointsXY(coords)

Extend the path to a list of points. If this method is called on a 3D path, a Z value of 0.0 will be used for each appended point.

Parameters:

coords (list[tuple[float]]) – The list of 2D points to be extended to.

Return type:

None

extendToPointsXYZ(coords)

Extend the path to a list of points. If this method is called on a 2D path, the path will be forced to 3D with a default Z value of 0.0.

Parameters:

coords (list[tuple[float]]) – The list of 3D points to be extended to.

Return type:

None

force2D()

Reduces the geometry to 2D.

Return type:

None

force3D(newZ)

This sets the geometry’s dimension to 3D. All Z values are set to the value passed in, even if the geometry is already 3D.

Parameters:

newZ (float) – The new Z value.

Return type:

None

getArea()

Area calculation.

Return type:

float

Returns:

The calculated area.

getAsLine()

Returns the curve as a line.

Return type:

FMELine

Returns:

The curve as a FMELine object.

getAsLineFixedArcSamples(numSamples)

Returns a copy of this curve as a line. All arcs are approximated with the number of points given by ‘numSamples’. If ‘numSamples’ is 0, the number points will first be determined by the value of kFMEStrokeMaxDeviationValue directive in mapping file, which denotes the maximum deviation of the arc from the line. In the absence of this directive or the value of this directive is smaller than or equal to 0, the number points will be determined by the arc’s sweep angle and the value of the mapping file directive kFMEDegreesPerEdge, which defaults to 5.

Parameters:

numSamples (int) – The number of points to approximate the arc with.

Return type:

FMELine

Returns:

The curve as a FMELine object.

getEndPoint()

Returns the end point of this curve. An error is returned and None is returned if this curve has no point to return.

Return type:

FMEPoint or None

Returns:

The end point of the curve, or None if there is no point to return.

Raises:

FMEException – An exception is raised if an error occurred.

getLength(threeD)

Returns the length of the curve. If ‘threeD’ is True, this returns the 3D length of the curve, otherwise this returns the 2D length.

Parameters:

threeD (bool) – Whether to calculate the 2D or 3D length.

Return type:

float

Returns:

The length of the curve.

getMeasureNames()

Retrieve the names of the measures on this geometry.

Return type:

tuple[str]

Returns:

Return a tuple storing the names of the measures on this geometry. This will return an empty tuple if there are no measures. For FMEAggregate, FMEMultiSurface, and FMECompositeSurface, this will return the union of all measure names of all of its parts.

getName()

This routine retrieves the ‘name’ of this geometry as a str. This will return None if it did not have a name associated with it.

Return type:

str or None

Returns:

The geometry’s name.

getPartAt(index)

This returns the part of the FMEPath at the given index. This returns None if the index is out of range.

Parameters:

index (int) – The index to retrieve the part from.

Return type:

FMEArc or FMELine

Returns:

The FMESegment at the given index. Returns the terminal geometry of the FMESegment, either a FMEArc or FMELine.

getStartPoint()

Returns the start point of this curve. An error is returned and None is returned if this curve has no point to return.

Return type:

FMEPoint or None

Returns:

The start point of the curve, or None if there is no point to return.

Raises:

FMEException – An exception is raised if an error occurred.

getTrait(traitName)

Retrieves the geometry trait value of the specified trait name. Null trait values will be returned as an empty string. Binary blob traits are returned as a bytearray.

None is returned when the trait is not found on the geometry.

Parameters:

traitName (str) – The name of the geometry trait.

Return type:

bool, int, float, str, bytearray, bytes or None

Returns:

The trait value.

Raises:

FMEException – An exception is raised if there was a problem in retrieving the trait value.

getTraitNames()

Retrieve the names of the traits on this geometry.

Return type:

tuple[str]

Returns:

Return a tuple storing the names of the traits on this geometry. This will return an empty tuple if there are no traits. For all collections and containers, this will only return the names of traits on the outermost object only.

getTraitNullMissingAndType(traitName)

This method returns a tuple of a boolean, indicating if the trait is null, a boolean, indicating if the trait is missing, and an integer representing the type of the trait. The first boolean is True if ‘traitName’ maps to a null trait value on the geometry. Otherwise it is False. The second boolean is True if ‘traitName’ maps to a no value on the geometry. Otherwise it is False. If the trait is absent, FME_ATTR_UNDEFINED is returned for the type.

The possible trait types are FME_ATTR_UNDEFINED, FME_ATTR_BOOLEAN, FME_ATTR_INT8, FME_ATTR_UINT8, FME_ATTR_INT16, FME_ATTR_UINT16, FME_ATTR_INT32, FME_ATTR_UINT32, FME_ATTR_REAL32, FME_ATTR_REAL64, FME_ATTR_REAL80, FME_ATTR_STRING, FME_ATTR_ENCODED_STRING, FME_ATTR_INT64, FME_ATTR_UINT64.

Parameters:

traitName (str) – The trait’s name.

Return type:

tuple[bool, bool, int]

Returns:

A tuple of 2 boolean values the first indicating whether or not the value of the trait is null, the second indicating whether or not the trait is missing, and an integer representing the trait type.

getTraitType(traitName)

Returns the type of given trait. If the trait cannot be found, FME_ATTR_UNDEFINED will be returned.

Returns one of FME_ATTR_UNDEFINED, FME_ATTR_BOOLEAN, FME_ATTR_INT8, FME_ATTR_UINT8, FME_ATTR_INT16, FME_ATTR_UINT16, FME_ATTR_INT32, FME_ATTR_UINT32, FME_ATTR_REAL32, FME_ATTR_REAL64, FME_ATTR_REAL80, FME_ATTR_STRING, FME_ATTR_ENCODED_STRING, FME_ATTR_INT64, FME_ATTR_UINT64.

Parameters:

traitName (str) – The trait’s name.

Return type:

int

Returns:

The trait type.

hasMeasures()

Check if this geometry or any sub part of this geometry has measures.

Return type:

bool

Returns:

True if this geometry or any sub part of this geometry has measures, False otherwise.

hasName()

Returns whether or not the geometry has a name.

Return type:

bool

Returns:

Returns True if the geometry has a name and False otherwise.

is3D()

Returns whether or not the geometry is 3D.

Return type:

bool

Returns:

Returns True if the geometry is 3D and False otherwise. For FMENull, this method will always return True. For FMEAggregate, FMEMultiPoint, FMEMultiArea, FMEMultiText and FMEMultiCurve, this method will return True if any one of the sub-parts is 3D. If the collection is empty or all of its members are 2D, this method will return False.

isClosed(threeD)

Returns True if the start and end points have identical coordinate values. If ‘threeD’ is True, the z coordinate of the start and end points will be compared. This does not take measures into consideration.

Parameters:

threeD (bool) – Whether to compare the z coordinate value.

Return type:

bool

Returns:

True if the start and end point have identical coordinate values, False otherwise.

isCollection()

Check if the geometry is an aggregate or multi-part collection.

Return type:

bool

Returns:

True if the geometry is an aggregate or multi-part collection.

isLinear()

Returns True if and only if this curve contains only lines.

Return type:

bool

Returns:

True if the curve contains only lines, False otherwise.

measureExists(measureName)

Returns True if the specified measure exists and False otherwise. If the ‘measureName’ parameter is not specified then the default measure is checked.

Parameters:

measureName (str) – (Optional) The measure’s name.

Return type:

bool

Returns:

Boolean indicating whether or not the measure exists.

numParts()

This returns the number of FMESegment that make up this path.

Return type:

int

Returns:

The number of FMESegment that are used to make the FMEPath

offset(offsetPoint)

Offsets the geometry by the coords specified by ‘offsetPoint’.

Parameters:

offsetPoint (FMEPoint) – The FMEPoint to offset the curve by.

Return type:

None

Raises:

FMEException – An exception is raised if an error occurred.

removeDuplicates(checkZ)

Removes any adjacent duplicate points. If ‘checkZ’ is True, x, y, and z coordinates are checked, otherwise only x and y are.

Parameters:

checkZ (bool) – Whether to check the z coordinate.

Return type:

None

removeEndPart()

This removes the end FMESegment of the path. If there are no segments in the FMEPath, None is returned.

Return type:

FMEArc or FMELine

Returns:

The FMESegment at the end of the path. Returns the terminal geometry of the FMESegment, either a FMEArc or FMELine.

removeMeasure(measureName)

Remove the specified measure if it exists. If the measure name, is not provided remove the default measure, if there is one.

Parameters:

measureName (str) – (Optional) The name of the measure to remove.

Return type:

None

removeTraits(regexp)

This method has 4 modes:

1. Remove all traits at the top level: regex == NULL

2. Remove some traits at the top level: regex == <string>

3. Remove all traits at all levels: regex == kFME_RecurseAll

4. Remove some traits at all levels: regex == kFME_RecurseSome <string>

For example, specifying regex == NULL for a multi-surface will remove all traits at the root level of the multi-surface, whereas specifying regex == kFME_RecurseSome <string> will remove all traits from all levels of the multi surface that match <string>. If <string> is an illegal regular expression, no traits will be removed.

Return type:

None

renameMeasure(oldMeasureName, newMeasureName)

Renames the measure specified by ‘oldMeasureName’ to the new name, specified by ‘newMeasureName’.

Parameters:

• oldMeasureName (str) – The original name of the measure.

• newMeasureName (str) – The new name of the measure.

Return type:

None

reverse()

This reverses the order of the curve’s points.

Return type:

None

rotate2D(center, angle)

Rotate the curve counterclockwise around the ‘center’ point by the specified ‘angle’ (in degrees).

Parameters:

• center (FMEPoint) – The center point of the curve.

• angle (float) – The angle by which the curve is rotated.

Return type:

None

Raises:

FMEException – An exception is raised if an error occurred.

scale(xScale, yScale, zScale)

Scale the feature by the given amounts.

Parameters:

• xScale (float) – The value to scale x by.

• yScale (float) – The value to scale y by.

• zScale (float) – (Optional) The value to scale z by. (Default value is 1.0)

Return type:

None

Raises:

FMEException – An exception is raised if an error occurred.

setEndPoint(point)

Changes the existing end point of this curve. If there are no points on the curve, this method does nothing.

Parameters:

point (FMEPoint) – The point to set at the end of the curve.

Return type:

None

Raises:

FMEException – An exception is raised if an error occurred.

setName(name)

Sets the geometry’s name with a str. By supplying a blank name as input, this method will act as deleteName().

Parameters:

name (str) – The geometry’s new name.

Return type:

None

setStartPoint(point)

Changes the existing start point of this curve. If there are no points on the curve, this method does nothing.

Parameters:

point (FMEPoint) – The point to set at the start of the curve.

Return type:

None

Raises:

FMEException – An exception is raised if an error occurred.

setTrait(traitName, traitValue)

Sets a geometry trait with the specified value. If the geometry trait already exists, its value and type will be changed. The following type numeric mappings are used:

PyInt ==> FME_Int32

PyFloat ==> FME_Real64

PyLong ==> FME_Int64

Binary values are to be specified as bytearray values or bytes values.

Parameters:

• traitName (str) – The name of the geometry trait.

• traitValue (bool, int, float, str, bytearray, or bytes) – The value of the geometry trait.

Return type:

None

setTraitNullWithType(traitName, traitType)

This method supplies a null trait value with a type to the geometry. If a trait with the same name already exists, it is overwritten.

Trait type must be one of FME_ATTR_UNDEFINED, FME_ATTR_BOOLEAN, FME_ATTR_INT8, FME_ATTR_UINT8, FME_ATTR_INT16, FME_ATTR_UINT16, FME_ATTR_INT32, FME_ATTR_UINT32, FME_ATTR_REAL32, FME_ATTR_REAL64, FME_ATTR_REAL80, FME_ATTR_STRING, FME_ATTR_ENCODED_STRING, FME_ATTR_INT64, FME_ATTR_UINT64.

Parameters:

• traitName (str) – The trait’s name.

• traitType (int) – An integer representing the trait type.

Return type:

None

snip(measureType, measure3D, startLocation, endLocation)

Take a description of start and end positions (either as a measured 2D/3D distance, percentage, or normalized distance from the beginning, or a vertex index), and chop off only the portion between these positions. If the start and end positions are the same, keep two same points.

Parameters:

• measureType (int) – The measure type to use. Must be on of: SNIP_DISTANCE, SNIP_PERCENTAGE, SNIP_VERTEX or SNIP_POINT.

• measure3D (bool) – Whether to measure the 2D or 3D distance.

• startLocation (float) – The start location.

• endLocation (float) – The end location.

Return type:

None

Raises:

FMEException – An exception is raised if an error occurred.

snipByPoints(startPoint, endPoint)

Snip off the portion between two points. If these points are not on this line, replaced with nearest points which are exactly on the line. If the start and end point are the same, keep two same points.

Parameters:

• startPoint (FMEPoint) – The start point.

• endPoint (FMEPoint) – The end point.

Return type:

None

Raises:

FMEException – An exception is raised if an error occurred.