FME Transformers: 2024.1
Categories and Related Transformers
Categories
Rasters
Related Transformers
RasterObjectDetectionModelTrainer
RasterObjectDetector
RasterObjectDetectorSampleGenerator
Aids in preparation of positive and negative samples provided by the user to be used by the RasterObjectDetectionModelTrainer.
Typical Uses
A hand-picked selection of positive samples is used in the preparation step of creating a custom detection model.
This is the suggested way of preparing samples to be supplied to the RasterObjectDetectionModelTrainer for custom detection model creation. Hand-picking good quality positive samples yields a higher accuracy detection model, compared to artificially generated samples.
Configuration
Input Ports
Input
The transformer accepts any feature but all contents (except parameters) will be ignored and preserved with the output feature.
Output Ports
Output
The Output port returns the original feature and the following attributes:
- _out_bg_desc_fname: Path to the background description file
- _out_num_negative_samples: Number of negative samples in the background description file
- _out_vec_fname: Path to the .vec file which will contain the positive samples
- _out_num_positive_samples: Number of positive samples in the .vec file
<Rejected>
This port returns a feature with all its original contents and an fme_rejection_message containing the error message if any occur.
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
For both positive and negative sample directories, we advise to collect your images into a single directory (one for positive, and another for negatives). If you have a "working directory" where you want your project files to reside, a sub-directory there containing your negative samples is a suggested location (but it can be anywhere).
Negative Samples
Training a detection model requires a set of negative or background images that do not contain the object you are trying to detect. Depending on the application, you may get away with using random images. However, if your object(s) have a very specific background, you may want to take the positive samples and crop out the object to get some samples that do not contain your object.
|
Source Directory |
Directory containing negative sample images. For best operation, make sure the names do not contain spaces or special characters. |
|
Operation Mode |
|
Positive Samples
A very good positive sample set is a key to a high quality detection model. This might be a time consuming process but it is best to find your object in its natural setting (where you will be detecting it). For instance, if you are planning to detect cars at a certain intersection, images of that intersection will work best. You will also need to annotate the images manually or using opencv_annotate tool, which can be found in [FME_HOME]/plugins/opencv/. You can read more about how to use the tool here. Follow the instructions on how to annotate your samples. In short, call opencv_annotation --annotations={path/to/output/annotations/file.txt} --images={/path/to/positive/samples/dir}. There are also two optional parameters: --maxWindowHeight [maximum image height to resize in case they are too tall] --resizeFactor [factor to resize the image by if it's too tall]
The produced .txt file can be supplied to the Annotation File parameter. The annotation file should contain one line per each annotated image in the format: [path to image] [number of annotations] [x1_1] [y1_1] [width_1] [height_1] ... [x1_n] [y1_n] [width_n] [height_n]
|
Annotation File |
Positive annotation file produced manually or by calling opencv_annotation. |
|
Number of Samples |
Number of positive samples contained in the annotation file. |
|
Width and Height |
Width and Height of the detection window of the resulting detection model. Determines the minimum size of the object that the model will be able to detect. |
Output
|
Background Description File |
Path to the output background description file. We recommend outputting this file in the subdirectory that contains your directory with negative samples. This file can be input into the RasterObjectDetectionModelTrainer using the Background Description File parameter. |
|
Prepared Positives File |
Output file containing the prepared positive samples. This file can be input into RasterObjectDetectionModelTrainer using the Positive Samples File parameter. |
Editing Transformer Parameters
Transformer parameters can be set by directly entering values, using expressions, or referencing other elements in the workspace such as attribute values or user parameters. Various editors and context menus are available to assist. To see what is available, click 
beside the applicable parameter.
How to Set Parameter Values
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.
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.
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.
Content Types
| These functions manipulate and format strings. | |
|
Special Characters |
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
Table Tools
Transformers with table-style parameters have additional tools for populating and manipulating values.
|
Row Reordering
|
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. |
|
Filter
|
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
|
Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers. |
|
Reset/Refresh
|
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.
For more information, see Transformer Parameter Menu Options.
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 RasterObjectDetectorSamplePreparer on the FME Community.