RasterPaletteExtractor
Creates a string representation of an existing palette on a raster and saves it to an attribute.
Typical Uses
- Extracting a palette to be saved to an external file
- Extracting a palette to apply to other rasters or for use elsewhere in a workspace
How does it work?
The RasterPaletteExtractor receives raster features and copies the palette information to a string attribute. Only one palette may be extracted at a time.
This transformer supports raster band and palette selection. Exactly one palette must be selected on each input raster feature. The RasterSelector can be used to modify selection.
This transformer may be used in combination with the AttributeFileWriter to write a palette to a file.
Format of Palette Attributes
The general format of a palette attribute is as follows:
|
Format |
RGB Example |
String Example |
|---|---|---|
|
<value interpretation> [<string length>] |
RGB24 |
STRING 10 |
The first line of the palette must contain the value interpretation. Valid values for the value interpretation are:
- RGB24
- RGBA32
- RGB48
- RGBA64
- GRAY8
- GRAY16
- STRING
RGBA and RGB palette values consist of comma-delimited strings of integers between 0 and the maximum value of the data type. For example, a valid RGBA32 value would be 64,128,255,255, and a valid RGB48 value would be 16384,32768,65535.
When an interpretation of STRING is specified, the first line may optionally specify the maximum string length of the palette values. This value must be a positive integer. If no string length is explicitly specified, a default of 32 will be assumed.
STRING palette values may consist of any arbitrary text, except for the newline character.
GRAY palette values consist of a single integer between 0 and the maximum value of the data type.
All lines after the first are key-value pairs. Palette keys must be organized in ascending order, but they are not required to be contiguous - that is, not all numbers in the series must be present. All absent palette keys look up to 0 or an equivalent value, such as 0,0,0 for RGB or an empty string for string palettes.
Example: Extracting a palette to a text file
In this example, we will extract a palette and write it to a text file. Note that the source raster has one palette, and so a RasterSelector is not needed.
Two steps are required:
- Extract the palette to an attribute.
- Write the contents of that attribute to a file.
The raster is first routed into a RasterPaletteExtractor. In the parameters dialog, Palette Attribute is given the name _palette.
As the raster feature exits this transformer, the palette has been added to it in string attribute form. The original palette remains intact.
The feature is now routed into an AttributeFileWriter. In the parameters dialog, Source Attribute is set to _palette, and a path and file name are designated for the text file to be written.
The resulting text file contains the palette.
Usage Notes
- To add an extracted palette to another raster, use the RasterPaletteAdder.
- To generate a palette from the existing cell values in a raster, use the RasterPaletteGenerator.
- To remove a palette from a raster, use the RasterPaletteRemover.
- To replace cell values with palette values, use the RasterPaletteResolver.
Choosing a Raster Transformer
FME has an extensive selection of transformers for working with raster data. They can be generally categorized as working with whole rasters, bands, cells or palettes, and those designed for workflow control or combing raster with vector data.
For information on raster geometry and properties, see Rasters (IFMERaster).
Raster Transformers
Working with Rasters
These transformers generally apply to whole rasters.
| RasterCellOriginSetter | Sets the raster's cell origin. |
| RasterConvolver |
Applies a convolution filter (sometimes called a kernel or lens) to raster features and outputs the results. |
| RasterExpressionEvaluator | Evaluates expressions on each cell in a raster or pair of rasters, including algebraic operations and conditional statements. |
| RasterExtentsCoercer | Replaces the geometry of input raster features with a polygon covering the extents of the raster. |
| RasterGCPExtractor | Extracts the coordinate system and the Ground Control Points (GCP) from the raster feature and exposes them as attributes. |
| RasterGCPSetter | Sets the Ground Control Points (GCP) on a raster with the specified Column (pixel), Row (line), X Coordinate, Y Coordinate and Z Coordinate. |
| RasterGeoreferencer | Georeferences a raster using the specified parameters. |
| RasterHillshader | Generates a shaded relief effect, useful for visualizing terrain. |
| RasterInterpretationCoercer |
Alters the underlying interpretation of the bands of the raster geometry on the input features, using the specified conversion options. For example, an input raster feature with three bands of interpretation (UInt16, Gray8, and Real64) could be converted to a raster feature with three bands of interpretation (Red8, Green8, and Blue8) or four bands of interpretation (Red16, Green16, Blue16, and Alpha16) in a single operation. |
| RasterMosaicker | Merges multiple raster features into a single raster feature. |
| RasterPropertyExtractor | Extracts the geometry properties of a raster feature and exposes them as attributes. |
| RasterPyramider | Resamples rasters to multiple resolutions, based on either number of levels or dimensions of the smallest output raster. |
| RasterResampler | Resamples rasters, based on specified output dimensions, cell size in ground units, or percentage of original, and interpolates new cell values. |
| RasterRotationApplier |
Applies the raster rotation angle on the input raster properties to the rest of the raster properties and data values. The expected input is a raster with a non-zero rotation angle and the expected output is a rotated raster with a rotation angle of 0.0. It is expected that the input raster properties will be modified to conform the output raster properties for a raster rotated by the given angle. Applying a rotation angle is primarily done for compatibility with other processing and writers that cannot handle a rotation angle. |
| RasterSubsetter | Clips raster features using pixel bounds instead of ground coordinates, and optionally adds cells around the perimeter. |
| RasterTiler | Splits each input raster into a series of tiles by specifying either a tile size in cells/pixels or the number of tiles. |
| RasterToPolygonCoercer | Creates polygons from input raster features. One polygon is output for each contiguous area of pixels with the same value in the input raster. |
| WebMapTiler | Creates a series of image tiles that can be utilized by web mapping applications such as Bing™ Maps, Google Maps™, or Web Map Tile Service. This is done by resampling rasters to various different resolutions and then splitting them into tiles. |
Working with Bands
These transformers generally apply to bands.
| RasterBandAdder | Adds a new band to a raster feature. |
| RasterBandCombiner | Merges coincidental raster features into a single output raster feature, preserving and appending all bands. |
| RasterBandInterpretationCoercer |
Alters the interpretation type of individual raster bands, converting cell values if necessary. |
| RasterBandKeeper |
Removes all unselected bands from a raster feature. |
| RasterBandMinMaxExtractor | Extracts the minimum and maximum band values, palette keys, and palette values from a raster feature, and adds them to a list attribute. |
| RasterBandNameSetter | Sets the band name of selected bands on a raster, making raster contents simpler to understand compared to band numbers. |
| RasterBandNodataRemover | Removes the existing nodata identifier from selected bands of a raster feature. Any values previously equal to the nodata value are considered valid data. |
| RasterBandNodataSetter | Sets a new nodata value on selected bands of a raster feature. |
| RasterBandOrderer | Specifies the required order of bands in a raster. Bands are reordered according to the input band indices. |
| RasterBandPropertyExtractor | Extracts the band and palette properties of a raster feature and exposes them as attributes. |
| RasterBandRemover | Removes any selected bands from a raster feature. |
| RasterBandSeparator | Separates bands or unique band and palette combinations, and outputs either individual raster features or a single new raster feature containing all combinations. |
| RasterStatisticsCalculator | Calculates statistics on raster bands and adds the results as attributes. |
Working with Cells
These transformers generally apply to individual cells.
| RasterAspectCalculator |
Calculates the aspect (direction of slope) for each cell of a raster. Aspect is measured in degrees from 0 to 360, clockwise from north. |
| RasterCellCoercer | Creates individual points or polygons for each cell in a raster, optionally extracting band values as z coordinates or attributes. |
| RasterCellValueCalculator | Evaluates basic arithmetic , minimum, maximum or average operations on the cell values of a pair of rasters. |
| RasterCellValueReplacer | Replaces a range of band values in a raster with a new single value. |
| RasterCellValueRounder | Rounds off raster cell values. |
| RasterSingularCellValueCalculator | Performs basic arithmetic operations on the cell values of a raster against a numeric value. |
| RasterSlopeCalculator | Calculates the slope (maximum rate of change in z) for each cell of a raster. |
Working with Palettes
These transformers generally apply to palettes.
| RasterPaletteAdder |
Creates a palette from an attribute, and adds this palette to all selected bands on a raster. |
| RasterPaletteExtractor | Creates a string representation of an existing palette on a raster and saves it to an attribute. |
| RasterPaletteGenerator | Generates a palette out of the selected band(s) of a raster. The output raster will have the selected band(s) replaced by a new band with a palette. |
| RasterPaletteInterpretationCoercer |
Alters the interpretation type of raster palettes. |
| RasterPaletteNodataSetter |
Identifies the palette key that matches a raster band’s nodata value, and sets a value on it. |
| RasterPaletteRemover | Removes selected palette(s) from raster features. |
| RasterPaletteResolver | Resolves the palette(s) on a raster by replacing cell values with their corresponding palette values. Palette values with multiple components, such as RGB, are broken down and the individual values assigned to multiple, newly-added bands. |
Workflow Control
These transformers generally control the flow of features in a workspace.
| RasterCheckpointer | Sets a checkpoint in the raster processing which forces previous processing to occur immediately. Once complete, it saves the current state to disk. |
| RasterConsumer | Requests the tile(s) from the raster geometry but no actual operations are performed on the tile(s). |
| RasterExtractor | Serializes the geometry of the feature into the Blob Attribute based on the selected writer format. |
| RasterNumericCreator | Creates a feature with a raster of the specified size with a numeric value and sends it into the workspace for processing. It is useful for creating a very large image with a user-specified width and height. |
| RasterReplacer | Replaces the geometry of the feature with the geometry held in the Blob Attribute. The blob is decoded according to the selected raster format. |
| RasterRGBCreator | Creates a feature with a raster of the specified size with an RGB value and sends it into the workspace for processing. |
| RasterSelector |
Selects specific bands and palettes of a raster for subsequent transformer operations. |
Vectors and Rasters
These transformers generally involve using rasters and vector data together.
| ImageRasterizer | Creates a raster representation of vector or point cloud input features, using the fme_color attribute over a solid background fill for vector features. Point clouds may be rendered using their color or intensity components. |
| NumericRasterizer | Draws input point, line and polygon features onto a numeric raster filled with the background value. The Z coordinates of the input vector features are used to generate pixel values. Features without Z coordinates will be discarded. |
| MapnikRasterizer | Generates a raster from input vector and raster features, with fine control over symbolization and labeling, using the Mapnik toolkit. |
| PointOnRasterValueExtractor | Extracts the band and palette values from a raster at the location of one or more input points and sets them as attributes on the feature. |
| VectorOnRasterOverlayer | Rasterizes vector or point cloud features onto an existing raster. For vector features the fme_color attribute sets pixel color, and point clouds may be rendered using their color or intensity components. |
Configuration
Input Ports
Input
This transformer accepts only raster features. The input raster must have one palette selected.
Output Ports
Output
Raster features with the selected paletted added to the specified attribute.
<Rejected>
Non-raster features will be routed to the <Rejected> port, as well as invalid rasters.
Rejected features will have an fme_rejection_code attribute with one of the following values:
INVALID_FEATURE_CANNOT_WRITE
Rejected Feature Handling: can be set to either terminate the translation or continue running when it encounters a rejected feature. This setting is available both as a default FME option and as a workspace parameter.
Parameters
Parameters
| Palette Attribute | The attribute to which the palette will be written. |
Editing Transformer Parameters
Using a set of menu options, transformer parameters can be assigned by referencing other elements in the workspace. More advanced functions, such as an advanced editor and an arithmetic editor, are also available in some transformers. To access a menu of these options, click 
beside the applicable parameter. For more information, see Transformer Parameter Menu Options.
Defining Values
There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters. There are a number of tools and shortcuts that can assist in constructing values, generally available from the drop-down context menu adjacent to the value field.
How to Set Parameter Values
Using the Text Editor
The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.
Using the Arithmetic Editor
The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.
Conditional Values
Set values depending on one or more test conditions that either pass or fail.
Parameter Condition Definition Dialog
Content
Expressions and strings can include a number of functions, characters, parameters, and more - whether entered directly in a parameter or constructed using one of the editors.
Content Types
| These functions manipulate and format strings. | |
| A set of control characters is available in the Text Editor. | |
| Math functions are available in both editors. | |
| These operators are available in the Arithmetic Editor. | |
| These return primarily feature-specific values. | |
| FME and workspace-specific parameters may be used. | |
| Working with User Parameters | Create your own editable parameters. |
Reference
|
Processing Behavior |
|
|
Feature Holding |
No |
| Dependencies | None |
| FME Licensing Level | FME Professional Edition and above |
| Aliases | |
| History | |
| Categories |
FME Community
The FME Community is the place for demos, how-tos, articles, FAQs, and more. Get answers to your questions, learn from other users, and suggest, vote, and comment on new features.
Search for all results about the RasterPaletteExtractor on the FME Community.
Examples may contain information licensed under the Open Government Licence – Vancouver