Module fmeobjects :: Class FMETile
[hide private]
[frames] | no frames]

Class FMETile


init()

FMETile is an abstract class. It cannot be created directly.

Instance Methods [hide private]
 
__getObject__(args)
 
__init__()
x.__init__(...) initializes x; see help(type(x)) for signature
a new object with type S, a subtype of T
__new__(T, S, ...)
list of bytearrays
getByteArray()
Returns a list of bytearrays where each bytearray represents the data values of each row of the tile.
list of string
getDataAsStringArray(startRow, startCol, numRows, numCols)
Get a list that contains values of the tiles.
int
getDataType()
Get the data type of a raster tile.
int
getDataTypeBitDepth()
Get the number of bits in the data type of a raster tile.
int
getInterpretation()
Get the interpretation of a raster tile.
int
getInterpretationBitDepth()
Get the number of bits in the interpretation of a raster tile.
int
getInterpretationNumComponents()
Get the number of components in the interpretation of a raster tile.
int
getNumCols()
Get the number of columns in a raster tile.
int
getNumDataTypesPerCell()
Get the number of instances of the data type in a cell of a raster tile.
int
getNumRows()
Get the number of Rows in a raster tile.
int
getTileByteLength()
Get the number of bytes in the raster tile.
int
getTileNumComponents()
Get the number of component data types in the raster tile.

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__()
(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__

getByteArray()

 

Returns a list of bytearrays where each bytearray represents the data values of each row of the tile.

Returns: list of bytearrays
The data values of the tile.

getDataAsStringArray(startRow, startCol, numRows, numCols)

 

Get a list that contains values of the tiles. One string is added to the list for each cell in the specified area.

If the specified area falls outside the bounds of the tile, the string array will not be modified. startRow, startCols, numRows, and numCols should be a integer greater than or equal to 0.

Parameters:
  • startRow (int) - Starting row.
  • startCol (int) - Starting column.
  • numRows (int) - Number of rows to get.
  • numCols (int) - Number of columns to get.
Returns: list of string
Values in the tile.

getDataType()

 

Get the data type of a raster tile.

Returns one of: FME_DATA_TYPE_NULL FME_DATA_TYPE_REAL64 FME_DATA_TYPE_REAL32 FME_DATA_TYPE_UINT64 FME_DATA_TYPE_INT64 FME_DATA_TYPE_UINT32 FME_DATA_TYPE_INT32 FME_DATA_TYPE_UINT16 FME_DATA_TYPE_INT16 FME_DATA_TYPE_UINT8 FME_DATA_TYPE_INT8

Returns: int
Data type of a raster tile.

For example: An FMEInt32Tile would return FME_DATA_TYPE_INT32. An FMERGBA64Tile would return FME_DATA_TYPE_UINT16. An FMEStringTile would return FME_DATA_TYPE_UINT8.

getDataTypeBitDepth()

 

Get the number of bits in the data type of a raster tile.

Returns: int
The number of bits in the data type of a raster tile.

For example: An FMEInt32Tile would return 32. An FMERGBA64Tile would return 16. An FMEStringTile would return 8.

getInterpretation()

 

Get the interpretation of a raster tile. Returns one of: FME_INTERPRETATION_NULL FME_INTERPRETATION_REAL64 FME_INTERPRETATION_REAL32 FME_INTERPRETATION_UINT64 FME_INTERPRETATION_INT64 FME_INTERPRETATION_UINT32 FME_INTERPRETATION_INT32 FME_INTERPRETATION_UINT16 FME_INTERPRETATION_INT16 FME_INTERPRETATION_UINT8 FME_INTERPRETATION_INT8 FME_INTERPRETATION_RGB24 FME_INTERPRETATION_RGBA32 FME_INTERPRETATION_RGB48 FME_INTERPRETATION_RGBA64 FME_INTERPRETATION_GRAY8 FME_INTERPRETATION_GRAY16 FME_INTERPRETATION_RED8 FME_INTERPRETATION_RED16 FME_INTERPRETATION_GREEN8 FME_INTERPRETATION_GREEN16 FME_INTERPRETATION_BLUE8 FME_INTERPRETATION_BLUE16 FME_INTERPRETATION_ALPHA8 FME_INTERPRETATION_ALPHA16 FME_INTERPRETATION_STRING

Returns: int
Interpretation of a raster tile.

For example: An FMERGBA64Tile would return FME_INTERPRETATION_RGBA64. An FMERGBA64Tile would return FME_INTERPRETATION_RGBA64. An FMEStringTile would return FME_INTERPRETATION_STRING.

getInterpretationBitDepth()

 

Get the number of bits in the interpretation of a raster tile.

Returns: int
The number of bits in the interpretation of a raster tile.

For example: An FMEInt32Tile would return 32. An FMERGBA64Tile would return 64. An FMEStringTile would return 8 * stringLength.

getInterpretationNumComponents()

 

Get the number of components in the interpretation of a raster tile.

Returns: int
The number of components in the interpretation of a raster tile.

For example: An FMEInt32Tile would return 1. An FMERGBA64Tile would return 4. An FMEStringTile would return 1.

getNumCols()

 

Get the number of columns in a raster tile.

Returns: int
The number of columns.

getNumDataTypesPerCell()

 

Get the number of instances of the data type in a cell of a raster tile.

Returns: int
The number of instances of the data type.

For example: An FMEInt32Tile would return 1. An FMERGBA64Tile would return 4. An FMEStringTile would return stringLength.

getNumRows()

 

Get the number of Rows in a raster tile.

Returns: int
The number of rows in a raster tile.

getTileByteLength()

 

Get the number of bytes in the raster tile.

This is equal to numRows * numCols * (interpretationBitDepth / 8)).

Returns: int
The number of bytes in the raster tile.

getTileNumComponents()

 

Get the number of component data types in the raster tile.

This is equal to numRows * numCols * interpretationNumComponents.

Returns: int
The Number of component data types in the raster tile.