Evaluates basic arithmetic , minimum, maximum or average operations on the cell values of a pair of rasters.
- Recalculating raster cell values by processing them individually against another raster
How does it work?
The RasterCellValueCalculator receives pairs of raster features, and evaluates a defined arithmetic expression on the band values of each pair of corresponding cells.
Each pair of rasters must have:
- the same number of rows and columns
- the same number of bands (or selected bands)
- the same Nodata value, or have no Nodata value
The rasters are routed into A and B input ports, and an Operation is selected to perform, constructing a basic expression in the form A <operation> B. Operations available include addition, subtraction, multiplication, division, and three basic statistics - minimum, maximum, and average. The order of A and B is fixed, and matters for certain operations including division and subtraction.
The new values are output on the same band from which they were calculated. Preserve Interpretation determines whether or not the band is converted to a different type on output - for example, the division of two integers may produce a floating-point decimal result, converting the output band to interpretation type real64.
If the rasters are mismatched either in dimension (number of rows and columns) or number of bands (or selected bands), an error will occur.
Position information for georeferenced rasters is not taken into consideration.
For multi-band rasters, the first selected band of raster A is combined with the first selected band of raster B, the second selected band of raster A is combined with the second selected band of raster B, and so on. To restrict operation to specific band(s), use a RasterSelector prior to the RasterCellValueReplacer.
This transformer supports raster band selection. The RasterSelector can be used to modify the selection. Palettes are not supported.
In this example, we will use a RasterCellValueCalculator to isolate land zoning that falls with 150 meters of major arteries.
We start with two numeric rasters. The first represents zoning, with integer values ranging from 1 to 10, where each value arbitrarily represents a zone type. The selected pixel here, with a value of 10, is zoned Industrial This will be our “A” raster.
The second raster represents 150 meter buffers along arterial roads. Pixels will have a value of either 0 or 1, where 1 represents pixels inside the buffer zones, and 0 outside the buffer zones. This is our “B” raster.
The pair of rasters is routed into a RasterCellValueCalculator.
In the parameters dialog, the Operation is set to “/” - division. This will perform A / B, and so the zone values (from 1 to 10) will be divided by either 0 or 1.
Cells that fall within a buffer retain their original value (being divided by 1). Cells that fall outside the buffer fail to be divided by 0 - and so become “Nodata” values. The output raster feature is shown here over a blue background to show the Nodata areas clearly.
- To perform basic calculations between one raster cell and a numeric value, consider using the RasterSingularCellValueCalculator
- For more complex calculations, including multiple operators, consider using the RasterExpressionEvaluator.
- Nodata values can be set with the RasterBandNodataSetter or removed with the RasterBandNodataRemover.
- Palettes may be resolved using the RasterPaletteResolver or removed using the RasterPaletteRemover.
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 combining raster with vector data.
For information on raster geometry and properties, see Rasters (IFMERaster).
Working with Rasters
|RasterCellOriginSetter||Sets the cell origin point within cells in a raster.|
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.|
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.|
|RasterRegisterer||Transforms an image to minimize its difference with another.|
|RasterResampler||Resamples rasters, based on specified output dimensions, cell size in ground units, or percentage of original, and interpolates new cell values.|
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.
|RasterSharpener||Enhances the features of a raster image. The RasterSharpener enhances the borders, lines, and curves while reducing noise in the flat areas of the raster image.|
|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
|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.|
Alters the interpretation type of individual raster bands, converting cell values if necessary.
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
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.|
|RasterSegmenter||Partitions a raster image into arbitrarily sized groups of cells from the input image based on intensity differences in the input raster image cells.|
|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
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.|
Alters the interpretation type of raster palettes.
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.|
|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.|
Selects specific bands and palettes of a raster for subsequent transformer operations.
Vectors and Rasters
|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.|
|PointCloudOnRasterComponentSetter||Sets point cloud component values by overlaying a point cloud on a raster. The component values for each point are interpolated from band values at the point location.|
|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.|
Pairs of raster features to perform calculations on. Palettes are not supported.
Raster features with calculated values according to parameter selections, stored in the same band they were provided in.
Unselected bands are appended to the output raster, unchanged. The unselected bands of raster A are appended first, followed by the unselected bands of raster B.
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:
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.
To perform a calculation on more than one pair of rasters, a set of Group By attributes must be specified.
Each group must contain one A raster and one B raster. Group By attributes are always added to the output feature.
|Group By Mode||
Process At End (Blocking): This is the default behavior. Processing will only occur in this transformer once all input is present.
Process When Group Changes (Advanced): This transformer will process input groups in order. Changes of the value of the Group By parameter on the input stream will trigger processing on the currently accumulating group. This may improve overall speed (particularly with multiple, equally-sized groups), but could cause undesired behavior if input groups are not truly ordered.
Considerations for Using Group By
There are two typical reasons for using Process When Group Changes (Advanced) . The first is incoming data that is intended to be processed in groups (and is already so ordered). In this case, the structure dictates Group By usage - not performance considerations.
The second possible reason is potential performance gains.
Performance gains are most likely when the data is already sorted (or read using a SQL ORDER BY statement) since less work is required of FME. If the data needs ordering, it can be sorted in the workspace (though the added processing overhead may negate any gains).
Sorting becomes more difficult according to the number of data streams. Multiple streams of data could be almost impossible to sort into the correct order, since all features matching a Group By value need to arrive before any features (of any feature type or dataset) belonging to the next group. In this case, using Group By with Process At End (Blocking) may be the equivalent and simpler approach.
Note: Multiple feature types and features from multiple datasets will not generally naturally occur in the correct order.
As with many scenarios, testing different approaches in your workspace with your data is the only definitive way to identify performance gains.
The operation to perform. Choices include:
Yes: Each output band will have the same interpretation as its input bands, as long as the input bands share the same interpretation.
No: The interpretation of each output band will be automatically determined.
If the input bands have different interpretations, the interpretation of each output band will be automatically determined.
Note that when converting between different data types, a Bounded Cast is used. As a result, when a calculated value does not fit in the destination interpretation, the corresponding destination value will either be set to the minimum or maximum value possible in the destination data type.
If Yes, attributes from the original features will be merged onto the output feature.
Group By attributes are always added to the output feature.
If attributes on the A and B features share the same name, values from the B feature attributes take precedence.
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.
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.
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.
Set values depending on one or more test conditions that either pass or fail.
Expressions and strings can include a number of functions, characters, parameters, and more.
When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.
|These functions manipulate and format strings.|
|A set of control characters is available in the Text Editor.|
|Math functions are available in both editors.|
|Date/Time Functions||Date and time functions are available in the Text Editor.|
|These operators are available in the Arithmetic Editor.|
|These return primarily feature-specific values.|
|FME and workspace-specific parameters may be used.|
|Creating and Modifying User Parameters||Create your own editable parameters.|
Dialog Options - Tables
Transformers with table-style parameters have additional tools for populating and manipulating values.
Enabled once you have clicked on a row item. Choices include:
Cut, Copy, and Paste
Enabled once you have clicked on a row item. Choices include:
Cut, copy, and paste may be used within a transformer, or between transformers.
|Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output.|
|Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers.|
Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers.
Note: Not all tools are available in all transformers.
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 RasterCellValueCalculator on the FME Community.
Examples may contain information licensed under the Open Government Licence – Vancouver and/or the Open Government Licence – Canada.