Module fmeobjects :: Class FMERaster

[frames] | no frames]

Class FMERaster

init(MultipleInvocations)

FMERaster class.

Create an instance of a FMERaster object.

init(rasterProperties)

Creates a raster with the given raster properties.

Parameters

rasterProperties (FMERasterProperties) - Raster Properties.

Returns: FMERaster

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.

Returns: FMERaster

An instance of a FMERaster object.

Instance Methods

[hide private]

__init__(MultipleInvocations)
x.__init__(...) initializes x; see help(type(x)) for signature

None

appendBand(band)
Appends FMEBand to the raster.

bool

equals(raster)
Evaluates whether two rasters are identical.

FMEBand

getBand(bandIndex)
Returns a band from the raster based on its numbered order in the raster.

FMEPolygon

getBoundingBoxAsPolygon(rotatedCorners)
Returns bounding box of the raster as FMEPolygon.

int

getNumBands()
Returns the number of bands in a raster.

FMERasterProperties

getProperties()
Returns Raster Properties of this raster.

string

getSourceDataset()
Returns the source dataset from which the raster was read.

string

getSourceFormatName()
Returns the short name of the source format of the raster.

bool

hasBeenModified()
Returns whether the raster has been modified from its baseline state.

FMEBand

removeBand(bandIndex)
Removes and returns a band from the raster.

None

setModified(modified)
Sets whether the raster has been modified from some baseline state.

tuple of int

setOutputSize(rows, cols)
Change the source to the size specified.

Inherited from FMEGeometry: __getObject__, __new__, boundingBox, boundingCube, bounds, clearMeasures, copyAttributesFromFeature, copyNameFromGeometry, copyTraitsFromGeometry, copyTraitsToFeature, deleteName, force2D, force3D, getArea, getMeasureNames, getName, getTrait, getTraitNames, getTraitNullMissingAndType, getTraitType, hasMeasures, hasName, is3D, isCollection, measureExists, removeMeasure, removeTraits, renameMeasure, setName, setTrait, setTraitNullWithType

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(MultipleInvocations)
(Constructor)

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__

appendBand(band)

Appends FMEBand to the raster.

Parameters:

band (FMEBand) - Band to append.

Returns: None

Raises:

FMEException - An exception is raised if an error occurred.

equals(raster)

Evaluates whether two rasters are identical.

Parameters:

raster (FMERaster) - The raster object to compare to.

Returns: bool

True if the two rasters are the same.

getBand(bandIndex)

Returns a band from the raster based on its numbered order in the raster.

Parameters:

bandIndex (int) - Index number of the band.

Returns: FMEBand

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.

Returns: FMEPolygon

Bounding box of the raster.

Raises:

FMEException - An exception is raised if an error occurred.

getNumBands()

Returns the number of bands in a raster.

Returns: int: Number of bands in a raster.

getProperties()

Returns Raster Properties of this raster.

Returns: FMERasterProperties

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.

Returns: string: Source dataset from which the raster was read.

getSourceFormatName()

Returns the short name of the source format of the raster.

Returns: string: Short name of the source format of the raster.

hasBeenModified()

Returns whether the raster has been modified from its baseline state.

Returns: bool: True if raster has been modified, False if it hasn't.

removeBand(bandIndex)

Removes and returns a band from the raster.

Parameters:

bandIndex (int) - Index number of the band.

Returns: FMEBand

Removed band.

Raises:

FMEException - An exception is raised if an error occurred.

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 become True (this does not need to be explicitly set; it will occur automatically).

Parameters:

modified (bool) - Specifies whether the raster has been modified from thebaseline state.

Returns: None

setOutputSize(rows, cols)

Change the source to the size specified.

Parameters:

rows (int) - Number of rows.
cols (int) - Number of columns.

Returns: tuple of int

New number of rows and columns after resampling the raster.

Raises:

FMEException - An exception is raised if an error occurred.

Class FMERaster

__init__(MultipleInvocations) (Constructor)

appendBand(band)

equals(raster)

getBand(bandIndex)

getBoundingBoxAsPolygon(rotatedCorners)

getNumBands()

getProperties()

getSourceDataset()

getSourceFormatName()

hasBeenModified()

removeBand(bandIndex)

setModified(modified)

setOutputSize(rows, cols)

init(MultipleInvocations)
(Constructor)