RasterBandNameSetter

Sets the band name of selected bands on a raster, making raster contents simpler to understand compared to band numbers.

Jump to Configuration

Typical Uses

• Adding names to raster bands for processing requirements or clarity.

How does it work?

The RasterBandNameSetter receives raster features and applies either a single name or list of names to the currently selected band or bands.

To select specific bands, use the RasterSelector prior to the RasterBandNameSetter.

Lists of names must be provided as an FME list attribute.

This transformer supports raster band selection. Palettes are unaffected.

Using a List Attribute for List of Names

When the input type is a list (Input Type = List of Names), a list attribute that contains band names must be specified.

The values in the list will be applied to the selected bands, in the order they were selected. The list must contain at least as many elements as there are selected bands. List values are used sequentially.

List Examples

Given an input raster feature with three bands and no band names, this table shows the expected output for different combinations of selected bands against the same list attribute of band names.

*Band numbers start at zero (0), as do list elements. The band name list attribute may have any name.

Example: Adding a single band name

In this example, we will add a band name to a DEM raster. Note that the original raster feature has a single band, with no band name.

The raster is routed into a RasterBandNameSetter. The default state of the raster is “all bands selected,” so this raster’s single band is currently selected and will be acted on by the transformer.

In the parameters dialog, Input Type is set to Single Name, and the Band Name specified is ELEVATION.

The output raster feature now has a band name, ELEVATION.

Usage Notes

• To create a list of names, an AttributeSplitter can be used to convert a delimited string into a list attribute.
• Existing band names may be extracted into a list attribute with the RasterBandPropertyExtractor.

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 cell origin point within cells in a raster.
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 either the extents of a raster or the extent of data within a raster.
RasterGCPExtractor	Extracts Ground Control Point (GCP) coordinate system and point values from a raster feature and exposes them as attributes.
RasterGCPSetter	Sets Ground Control Points (GCPs) on a raster, pairing cell positions with known coordinates.
RasterGeoreferencer	Georeferences a raster by either known corner coordinates or origin, cell size, and rotation.
RasterHillshader	Generates a grayscale shaded relief representation of terrain, based on elevation values.
RasterInterpretationCoercer	Alters the interpretation type of rasters, including all bands, and converts cell values if necessary.
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	Rotates a raster feature according to its rotation angle property, interpolating new cell values, updating all other affected raster properties, and producing an output raster feature with a rotation angle of zero.
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	Forces accumulated raster operations to be processed, saving the state to disk and releasing resources to tune performance or assist with memory limitations.
RasterConsumer	Reads raster features for testing purposes, including any accumulated raster operations. No additional operations are performed, and nothing is done with the features.
RasterExtractor	Serializes the geometry of a raster feature into a Blob attribute, encoding the contents according to a choice of common binary raster formats.
RasterNumericCreator	Creates a numeric raster of specified size and resolution, with default cell values.
RasterReplacer	Decodes a binary attribute containing encoded rasters stored as Blobs, replacing the feature’s geometry with the decoded raster.
RasterRGBCreator	Creates a color raster feature of specified size, resolution, and interpretation type, with default cell values.
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	Creates a numeric raster representation of vector or point cloud input features, where cell values are taken from the z coordinates of the input features and overlaid on a uniform background.
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.
RasterDEMGenerator	Produces a raster digital elevation model (DEM) by uniformly sampling a Delaunay triangulation generated from input points and breaklines.
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.

Output Ports

Output

Raster features with band names added as specified.

<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_GEOMETRY_TYPE

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

Band Name

Input Type	Single Name: Set the band name of all selected bands to a specified single band name. List of Names: Set the band names of the selected bands to the names provided in a list attribute.
Band Name	If Input Type is Single Name, enter a band name.
List Attribute	If Input Type is List of Names, select a list attribute to be used.

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.

Text Editor

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.

Arithmetic Editor

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

String Functions	These functions manipulate and format strings.
Special Characters	A set of control characters is available in the Text Editor.
Math Functions	Math functions are available in both editors.
Math Operators	These operators are available in the Arithmetic Editor.
FME Feature Functions	These return primarily feature-specific values.
FME Parameters	FME and workspace-specific parameters may be used.
Working with User Parameters	Create your own editable parameters.

Reference

Related Transformers

RasterBandAdder

RasterBandPropertyExtractor

Processing Behavior	Feature-Based
Feature Holding	No
Dependencies	None
FME Licensing Level	FME Professional Edition and above
Aliases
History
Categories	Rasters

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 RasterBandNameSetter on the FME Community.

 

Examples may contain information licensed under the Open Government Licence – Vancouver