Module fmeobjects :: Class FMEBand

[frames] | no frames]

Class FMEBand

init(MultipleInvocations)

FMEBand class.

Create an instance of a FMEBand object.

init(populator, rasterProperties, bandProperties, nodataValue)

Creates a Band instance using given arguments.

Parameters

populator (FMEBandTilePopulator) - BandTilePopulator object.
rasterProperties (FMERasterProperties) - RasterProperties object.
bandProperties (FMEBandProperties) - BandProperties object.
nodataValue (FMETile) - (Optional) The value that represents unknown or invalid data.

Returns: FMEBand

An instance of a FMEBand object.

init(band)

Create a copy of the passed in band object.

Parameters

band FMEBand - The band object to create a copy of.

Returns: FMEBand

An instance of a FMEBand object.

Instance Methods

[hide private]

__getObject__(args)

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

a new object with type S, a subtype of T

__new__(T, S, ...)

None

appendPalette(palette)
Appends FMEPalette to the band.

None

enableBandCache(enableCache)
Enables/disables caching for this band.

bool

equals(band)
Tells whether two bands are identical.

None

flushCache()
Removes any cached data and releases cache resources.

int

getBandCacheID()
Returns ID of the last band cache.

Concrete type of FMETile

getMaxValue()
Returns maximum value of the band.

Concrete type of FMETile

getMinValue()
Returns minimum value of the band.

Concrete type of FMETile or None

getNodataValue()
Returns nodataValue of the band.

int

getNumPalettes()
Returns the number of palettes in a band.

FMEPalette

getPalette(paletteIndex)
Returns a palette from the band based on its numbered order in the band.

FMEBandProperties

getProperties()
Returns band properties of this band.

FMERasterProperties

getRasterProperties()
Returns raster properties of the raster where this band is appended.

Concrete class of FMETile type

getTile(row, col, tile)
Populates a tile of data in the interpretation of the band starting at the values of row and col and encapsulating the number of columns defined in the tile.

bool

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

bool

hasDataBeenModifiedSinceCache()
Returns whether the band's data has been modified from its baseline state.

bool

hasKnownMaxValue()
Tells whether the band knows its max value.

bool

hasKnownMinValue()
Tells whether the band knows its min value.

bool

isSelected()
Tells whether the band is selected for operations.

FMEPalette

removePalette(paletteIndex)
Removes and returns a palette from the band.

None

setCacheWindow(startRow, numRows, startCol, numCols, tileNumRows, tileNumCols)
Identifies the data that will be eligible for caching through getTile() call.

None

setDeleteSourceOnDestroy(deleteFlag)
Sets delete flag, identifying whether the band should delete its source data file when destroyed.

None

setMaxValue(tile)
Sets the max value of the band.

None

setMinValue(tile)
Sets the min value of the band.

None

setModified(modified)
Sets whether band has been modified from baseline state.

tuple of int

setOutputSize(rows, cols)
Changes the size of the source data.

None

setRasterProperties(rasterProperties)
Set the rasterProperties.

None

setSelected(selected)
Selects/ Deselects band for operations.

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__

new(T, S, ...)

Returns: a new object with type S, a subtype of T
Overrides: object.__new__

appendPalette(palette)

Appends FMEPalette to the band.

Parameters:

palette (FMEPalette) - Palette to append.

Returns: None

Raises:

FMEException - An exception is raised if an error occurred.

enableBandCache(enableCache)

Enables/disables caching for this band.

Parameters:

enableCache (bool) - True to enable, False to disable.

Returns: None

equals(band)

Tells whether two bands are identical.

Returns: bool: True, if two bands are the same.

getBandCacheID()

Returns ID of the last band cache.

Returns: int: ID of the last band cache.

getMaxValue()

Returns maximum value of the band.

Returns: Concrete type of FMETile

Maximum value of the band.

Raises:

FMEException - An exception is raised if an error occurred.

getMinValue()

Returns minimum value of the band.

Returns: Concrete type of FMETile

Minimum value of the band.

Raises:

FMEException - An exception is raised if an error occurred.

getNodataValue()

Returns nodataValue of the band.

This value represents unknown or invalid data. Often the value is at one of the extremes of the data type range.

If the band does not have a nodata value, None will be returned.

Returns: Concrete type of FMETile or None

NodataValue of the band.

Raises:

FMEException - An exception is raised if an error occurred.

getNumPalettes()

Returns the number of palettes in a band.

Returns: int: Number of palettes in a band.

getPalette(paletteIndex)

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

Parameters:

paletteIndex (int) - Index number of the palette.

Returns: FMEPalette

A palette from the band.

Raises:

FMEException - An exception is raised if an error occurred.

getProperties()

Returns band properties of this band.

Returns: FMEBandProperties

Band Properties of this band.

Raises:

FMEException - An exception is raised if an error occurred.

getRasterProperties()

Returns raster properties of the raster where this band is appended.

Returns: FMERasterProperties

Raster Properties of the raster.

Raises:

FMEException - An exception is raised if an error occurred.

getTile(row, col, tile)

Populates a tile of data in the interpretation of the band starting at the values of row and col and encapsulating the number of columns defined in the tile.

Parameters:

row (int) - Row number.
col (int) - Column number.
tile (FMETile) - Tile to populate.

Returns: Concrete class of FMETile type

Tile after populating a tile of data.

Raises:

FMEException - An exception is raised if an error occurred.

hasBeenModified()

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

Returns: bool: True, if it has been modified. False, if it has not.

hasDataBeenModifiedSinceCache()

Returns whether the band's data has been modified from its baseline state.

Returns: bool: True, if it has been modified. False, if it has not.

hasKnownMaxValue()

Tells whether the band knows its max value.

Returns: bool: True, if it know the max value.

hasKnownMinValue()

Tells whether the band knows its min value.

Returns: bool: True, if it know the min value.

isSelected()

Tells whether the band is selected for operations.

Returns: bool: True if this band is selected for operations.

removePalette(paletteIndex)

Removes and returns a palette from the band.

Parameters:

paletteIndex (int) - Index number of the palette.

Returns: FMEPalette

Removed palette.

Raises:

FMEException - An exception is raised if an error occurred.

setCacheWindow(startRow, numRows, startCol, numCols, tileNumRows, tileNumCols)

Identifies the data that will be eligible for caching through getTile() call.

Call should be made before requesting tiles to improve caching efficiency.

Parameters:

startRow (int) - Starting row number.
numRows (int) - Number of rows that will be included in cache window.
startCol (int) - Starting column number.
numCols (int) - Number of columns that will be included in cache window.
tileNumRows (int) - Number of tiles per row.
tileNumCols (int) - Number of tiles per column.

Returns: None

Raises:

FMEException - An exception is raised if an error occurred.

setDeleteSourceOnDestroy(deleteFlag)

Sets delete flag, identifying whether the band should delete its source data file when destroyed.

Parameters:

deleteFlag (bool) - True to delete, False not to delete.

Returns: None

Raises:

FMEException - An exception is raised if an error occurred.

setMaxValue(tile)

Sets the max value of the band.

Parameters:

tile (FMETile) - Max value to be set.

Returns: None

Raises:

FMEException - An exception is raised if an error occurred.

setMinValue(tile)

Sets the min value of the band.

Parameters:

tile (FMETile) - Min value to be set.

Returns: None

Raises:

FMEException - An exception is raised if an error occurred.

setModified(modified)

Sets whether band has been modified from baseline state.

Note that hasBeenModified is initially set to False.

Parameters:

modified (bool) - True when properties is altered.

Returns: None

setOutputSize(rows, cols)

Changes the size of the source data.

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.

setRasterProperties(rasterProperties)

Set the rasterProperties.

Parameters:

rasterProperties (FMERasterProperties) - Raster properties object to assign.

Returns: None

Raises:

FMEException - An exception is raised if an error occurred.

setSelected(selected)

Selects/ Deselects band for operations.

Parameters:

selected (bool) - True to select, False to deselect.

Returns: None

Class FMEBand

__init__(MultipleInvocations) (Constructor)

__new__(T, S, ...)

appendPalette(palette)

enableBandCache(enableCache)

equals(band)

getBandCacheID()

getMaxValue()

getMinValue()

getNodataValue()

getNumPalettes()

getPalette(paletteIndex)

getProperties()

getRasterProperties()

getTile(row, col, tile)

hasBeenModified()

hasDataBeenModifiedSinceCache()

hasKnownMaxValue()

hasKnownMinValue()

isSelected()

removePalette(paletteIndex)

setCacheWindow(startRow, numRows, startCol, numCols, tileNumRows, tileNumCols)

setDeleteSourceOnDestroy(deleteFlag)

setMaxValue(tile)

setMinValue(tile)

setModified(modified)

setOutputSize(rows, cols)

setRasterProperties(rasterProperties)

setSelected(selected)

init(MultipleInvocations)
(Constructor)

new(T, S, ...)