fmeobjects.FMERaster

|
Appends |
This method returns the bounding box of the geometry. |
|
This method returns the bounding cube of the geometry. |
|
Returns the bounds of the geometry. |
|
Remove all measures from the geometry. |
|
Copies all the attributes from the given feature to traits on this geometry, if they match the (optional) regular expression. |
|
|
Copies the name of the 'sourceGeometry' onto this geometry. |
Copies all the traits from the given geometry that match the (optional) regular expression. |
|
|
Copies all the traits from this geometry to attributes on the given feature, if they match the (optional) regular expression. |
Deletes the geometry's name. |
|
|
Evaluates whether two rasters are identical. |
Reduces the geometry to 2D. |
|
|
This sets the geometry's dimension to 3D. |
Area calculation. |
|
|
Returns a band from the raster based on its numbered order in the raster. |
|
Returns bounding box of the raster as |
Retrieve the names of the measures on this geometry. |
|
This routine retrieves the 'name' of this geometry as a |
|
Returns the number of bands in a raster. |
|
Returns Raster Properties of this raster. |
|
Returns the source dataset from which the raster was read. |
|
Returns the short name of the source format of the raster. |
|
|
Retrieves the geometry trait value of the specified trait name. |
Retrieve the names of the traits on this geometry. |
|
|
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. |
|
Returns the type of given trait. |
Returns whether the raster has been modified from its baseline state. |
|
Check if this geometry or any sub part of this geometry has measures. |
|
Returns whether or not the geometry has a name. |
|
Returns whether or not the geometry is 3D. |
|
Check if the geometry is an aggregate or multi-part collection. |
|
|
Returns |
|
Removes and returns a band from the raster. |
|
Removes the measure with name 'measureName' if supplied, or the default measure, if there is one. |
|
This method has 4 modes: |
|
Renames the measure specified by 'oldMeasureName' to the new name, specified by 'newMeasureName'. |
|
Sets whether the raster has been modified from some baseline state. |
|
Sets the geometry's name with a |
|
Change the source to the size specified. |
|
Sets a geometry trait with the specified value. |
|
This method supplies a null trait value with a type to the geometry. |
- class FMERaster
FME Raster Class
Create an instance of a
FMERaster
object.init(rasterProperties)
Creates a raster with the given raster properties.
- Parameters
rasterProperties (FMERasterProperties) – Raster Properties.
- Return type
- Returns
An instance of a Raster object.
init(raster)
Create a copy of the passed in raster object.
- Parameters
raster (FMERaster) – The raster object to create a copy of.
- Return type
- Returns
An instance of a
FMERaster
object.
- __init__(*args, **kwargs)
- appendBand(band)
Appends
FMEBand
to the raster.- Parameters
band (FMEBand) – Band to append.
- Return type
None
- Raises
FMEException – An exception is raised if an error occurred.
- boundingBox()
This method returns the bounding box of the geometry.
- boundingCube()
This method returns the bounding cube of the geometry.
- bounds()
Returns the bounds of the geometry.
- 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 becomeNone
.- 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; otherwiseFalse
is returned.- Return type
- Returns
Returns a boolean indicating whether or not the name existed before deletion.
- equals(raster)
Evaluates whether two rasters are identical.
- 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
- getBand(bandIndex)
Returns a band from the raster based on its numbered order in the raster.
- Parameters
bandIndex (int) – Index number of the band.
- Return type
- Returns
A band from the raster.
- Raises
FMEException – An exception is raised if an error occurred.
- getBoundingBoxAsPolygon(rotatedCorners)
Returns bounding box of the raster as
FMEPolygon
.- Parameters
rotatedCorners (bool) – Specifies whether the rotated corners of the raster should be used in the bounding box.
- Return type
- Returns
Bounding box of the raster.
- Raises
FMEException – An exception is raised if an error occurred.
- getMeasureNames()
Retrieve the names of the measures on this geometry.
- Return type
- 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
, andFMECompositeSurface
, 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 returnNone
if it did not have a name associated with it.- Return type
str or None
- Returns
The geometry’s name.
- getNumBands()
Returns the number of bands in a raster.
- Return type
- Returns
Number of bands in a raster.
- getProperties()
Returns Raster Properties of this raster.
- Return type
- Returns
Raster Properties of this raster.
- Raises
FMEException – An exception is raised if an error occurred.
- getSourceDataset()
Returns the source dataset from which the raster was read.
- Return type
- Returns
Source dataset from which the raster was read.
- getSourceFormatName()
Returns the short name of the source format of the raster.
- Return type
- Returns
Short name of the source format of the raster.
- 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.
- getTraitNames()
Retrieve the names of the traits on this geometry.
- 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 isFalse
. The second boolean isTrue
if ‘traitName’ maps to a no value on the geometry. Otherwise it isFalse
. 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
.
- 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
.
- hasBeenModified()
Returns whether the raster has been modified from its baseline state.
- hasMeasures()
Check if this geometry or any sub part of this geometry has measures.
- hasName()
Returns whether or not the geometry has a name.
- is3D()
Returns whether or not the geometry is 3D.
- Return type
- Returns
Returns
True
if the geometry is 3D andFalse
otherwise. ForFMENull
, this method will always returnTrue
. ForFMEAggregate
,FMEMultiPoint
,FMEMultiArea
,FMEMultiText
andFMEMultiCurve
, this method will returnTrue
if any one of the sub-parts is 3D. If the collection is empty or all of its members are 2D, this method will returnFalse
.
- isCollection()
Check if the geometry is an aggregate or multi-part collection.
- measureExists(measureName)
Returns
True
if the specified measure exists andFalse
otherwise. If the ‘measureName’ parameter is not specified then the default measure is checked.
- removeBand(bandIndex)
Removes and returns a band from the raster.
- Parameters
bandIndex (int) – Index number of the band.
- Return type
- Returns
Removed band.
- Raises
FMEException – An exception is raised if an error occurred.
- removeMeasure(measureName)
Removes the measure with name ‘measureName’ if supplied, or 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:
Remove all traits at the top level: regex == NULL
Remove some traits at the top level: regex == <string>
Remove all traits at all levels: regex ==
kFME_RecurseAll
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’.
- setModified(modified)
Sets whether the raster has been modified from some baseline state. This will initially be set to
False
for rasters generated by readers. Then, any calls that alter the raster will cause the modified state to becomeTrue
(this does not need to be explicitly set; it will occur automatically).- Parameters
modified (bool) – Specifies whether the raster has been modified from the baseline state.
- Return type
None
- setName(name)
Sets the geometry’s name with a
str
. By supplying a blank name as input, this method will act asdeleteName()
.- Parameters
name (str) – The geometry’s new name.
- Return type
None
- setOutputSize(rows, cols)
Change the source to the size specified.
- Parameters
- Return type
- Returns
New number of rows and columns after resampling the raster.
- 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.
- 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
.