Module fmeobjects :: Class FMEBandProperties

[frames] | no frames]

Class FMEBandProperties

init(MultipleInvocations)

FMEBandProperties class.

Create an instance of a FMEBandProperties object.

init(nameString, interpretation, tileType, numTileRows, numTileColumns)

Creates a band property with the given properties.

Parameters

nameString (string) - Name of the band.
interpretation (int) - Interpretation of a band. Choose one of:

tileType (int) - Tile type that can most efficiently support data access. Possible values:

FME_TILE_TYPE_FIXED: Tile requests made to a band must be equal to the band's tile size.

FME_TILE_TYPE_FIXED_MULTIPLE: Tile requests made to a band must be a multiple of the band's tile size.

FME_TILE_TYPE_FLEXIBLE: The band tile size is a suggestion only, and the band can handle any arbitrary tile size.

numTileRows (int) - Number of rows per tile in the raster.
numTileColumns (int) - Number of columns per tile in the raster.

Returns: FMEBandProperties

An instance of a BandProperties object.

init(bandProperties)

Create a copy of the passed in bandProperties object.

Parameters

bandProperties FMEBandProperties - The bandProperties object to create a copy of.

Returns: FMEBandProperties

An instance of a FMEBandProperties 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, ...)

bool

equals(bandPropertyObj)
Evaluates whether two band properties are identical.

int

getBitDepth()
Returns bit depth of the band.

int

getInterpretation()
Returns the interpretation of the band.

string or None

getName()
Returns the name of the band.

int

getNumTileCols()
Returns the number of columns in the tile size of the band.

int

getNumTileRows()
Returns the number of rows in the tile size of the band.

int

getTileType()
Returns tile type representing the type of data access supported by this band.

bool

hasBeenModified()
Evaluates whether the band properties have been modified from their baseline state.

None

setInterpretation(interpretation)
Sets the interpretation of the band.

None

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

None

setName(name)
Sets name of the band.

None

setNumTileCols(numCols)
Sets the number of columns per tile in the raster

None

setNumTileRows(numRows)
Sets the number of rows per tile in the raster.

None

setTileType(tileType)
Sets the tile type that can most efficiently support data access.

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__

equals(bandPropertyObj)

Evaluates whether two band properties are identical.

Parameters:

bandPropertyObj (FMEBandProperties) - The band property to compare to.

Returns: bool

True if the two properties have the same value.

getBitDepth()

Returns bit depth of the band.

Returns: int: The bit depth of the band.

getName()

Returns the name of the band.

Returns: string or None: Name of the band or None if name does not exist.

getNumTileCols()

Returns the number of columns in the tile size of the band. That is, this represents the most efficient tile size for data access. Note that a band can return data for any tile size (i.e. FMEBand.getTile will accept any tile), but using a tile with this size may have better performance or lower memory usage.

Returns: int: The number of columns per tile.

getNumTileRows()

Returns the number of rows in the tile size of the band. That is, this represents the most efficient tile size for data access. Note that a band can return data for any tile size (i.e. FMEBand.getTile will accept any tile), but using a tile with this size may have better performance or lower memory usage.

Returns: int: The number of rows per tile.

getTileType()

Returns tile type representing the type of data access supported by this band. Possible values:

FME_TILE_TYPE_FIXED: Tile requests made to a band must be equal to the band's tile size.

FME_TILE_TYPE_FIXED_MULTIPLE: Tile requests made to a band must be a multiple of the band's tile size.

FME_TILE_TYPE_FLEXIBLE: The band tile size is a suggestion only, and the band can handle any arbitrary tile size.

When getTileType() returns FME_TILE_TYPE_FIXED, the band tile size (from getNumTileRows() and getNumTileCols()) is a requirement. That is, only tiles of the specified size can be properly filled. When getTileType() returns FME_TILE_TYPE_FLEXIBLE, the band tile size is only a suggestion, and it implies the most efficient tile size for data access.

Note that this value is only relevant for readers. That is, when creating a reader, this value should be specified depending on how FMEBandTilePopulator is implemented. On the other hand, a consumer of data (e.g. a writer) can always request data in whatever size is desired, regardless of this value. FME will reconcile the writer request size with the reader's supported tile size.

Returns: int: Type of the tile.

hasBeenModified()

Evaluates whether the band properties have been modified from their baseline state.

Returns: bool: True if the band properties have been modified

setInterpretation(interpretation)

Sets the interpretation of the band.

setModified(modified)

Sets whether band properties have been modified from baseline state.

Note that hasBeenModified is initially set to False.

Parameters:

modified (bool) - True when properties is altered.

Returns: None

setName(name)

Sets name of the band.

Parameters:

name (string) - The name of the band.

Returns: None

setNumTileCols(numCols)

Sets the number of columns per tile in the raster

Parameters:

numCols (int) - Number of columns per tile in the raster. Number must be positive number, not exceeding the total number of columns.

Returns: None

Raises:

FMEException - An exception is raised if an error occurred.

setNumTileRows(numRows)

Sets the number of rows per tile in the raster.

Parameters:

numRows (int) - Number of rows per tile in the raster. Number must be positive number, not exceeding the total number of rows.

Returns: None

Raises:

FMEException - An exception is raised if an error occurred.

setTileType(tileType)

Sets the tile type that can most efficiently support data access.

Parameters:

tileType (int) - Possible values:
FME_TILE_TYPE_FIXED: Tile requests made to a band must be equal to the band's tile size.

FME_TILE_TYPE_FIXED_MULTIPLE: Tile requests made to a band must be a multiple of the band's tile size.

FME_TILE_TYPE_FLEXIBLE: The band tile size is a suggestion only, and the band can handle any arbitrary tile size.

Returns: None

Class FMEBandProperties

__init__(MultipleInvocations) (Constructor)

__new__(T, S, ...)

equals(bandPropertyObj)

getBitDepth()

getInterpretation()

getName()

getNumTileCols()

getNumTileRows()

getTileType()

hasBeenModified()

setInterpretation(interpretation)

setModified(modified)

setName(name)

setNumTileCols(numCols)

setNumTileRows(numRows)

setTileType(tileType)

init(MultipleInvocations)
(Constructor)

new(T, S, ...)