fmeobjects.FMEStringTile

FMEStringTile.getByteArray()	Returns a list of bytearrays where each bytearray represents the data values of each row of the tile.
FMEStringTile.getData()	Returns data values of the tile.
FMEStringTile.getDataAsStringArray(startRow, ...)	Get a list that contains values of the tiles.
FMEStringTile.getDataType()	Get the data type of a raster tile.
FMEStringTile.getDataTypeBitDepth()	Get the number of bits in the data type of a raster tile.
FMEStringTile.getInterpretation()	Get the interpretation of a raster tile.
FMEStringTile.getInterpretationBitDepth()	Get the number of bits in the interpretation of a raster tile.
FMEStringTile.getInterpretationNumComponents()	Get the number of components in the interpretation of a raster tile.
FMEStringTile.getNumCols()	Get the number of columns in a raster tile.
FMEStringTile.getNumDataTypesPerCell()	Get the number of instances of the data type in a cell of a raster tile.
FMEStringTile.getNumRows()	Get the number of Rows in a raster tile.
FMEStringTile.getTileByteLength()	Get the number of bytes in the raster tile.
FMEStringTile.getTileNumComponents()	Get the number of component data types in the raster tile.
FMEStringTile.setData(dataArray)	This method sets the contents of the tile data values using the provided data list.

class FMEStringTile

FME String Tile class

Create an instance of a FMEStringTile object.

init(numRow, numCol, stringLength)

Creates a FMEStringTile with the given parameters.

Parameters:

• numRow (int) – The number of rows.

• numCol (int) – The number of columns.

• stringLength (int) – The length of the str.

Return type:

FMEStringTile

Returns:

An instance of a FMEStringTile Tile object.

init(tile)

Create a copy of the passed in tile object.

Parameters:

tile (FMEStringTile) – The tile object to create a copy of.

Return type:

FMEStringTile

Returns:

An instance of a FMEStringTile Tile object.

__init__(*args, **kwargs)

getByteArray()

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

Return type:

list[bytearray]

Returns:

The data values of the tile.

getData()

Returns data values of the tile.

Return type:

list[list[int]]

Returns:

Data values of the tile. The number of lists inside the list represents the number of rows in a tile. For example, a tile that has 2 rows and 5 columns with str length 2 will return a list containing 2 lists where each list has 10 integers.

getDataAsStringArray(startRow, startCol, numRows, numCols)

Get a list that contains values of the tiles. One str is added to the list for each cell in the specified area. If the specified area falls outside the bounds of the tile, the str array will not be modified. ‘startRow’, ‘startCols’, numRows’, and ‘numCols’ should be integers 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.

Return type:

list[str]

Returns:

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

Return type:

int

Returns:

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.

Return type:

int

Returns:

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_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_NULL

• FME_INTERPRETATION_RGB24

• FME_INTERPRETATION_RGBA32

• FME_INTERPRETATION_RGB48

• FME_INTERPRETATION_RGBA64

• FME_INTERPRETATION_STRING

Return type:

int

Returns:

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.

Return type:

int

Returns:

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.

Return type:

int

Returns:

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.

Return type:

int

Returns:

The number of columns.

getNumDataTypesPerCell()

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

Return type:

int

Returns:

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.

Return type:

int

Returns:

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)).

Return type:

int

Returns:

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.

Return type:

int

Returns:

The Number of component data types in the raster tile.

setData(dataArray)

This method sets the contents of the tile data values using the provided data list.

Parameters:

dataArray (list[list[int]]) – This data will set the contents of the tile data. The number of lists inside the list represents the number of rows in a tile. For example, to set a tile that has 2 rows and 5 columns with str length 2, a list must have 2 lists where each list contains 10 integer values.

Return type:

None