This commit is contained in:
Fabian Märki
2017-02-28 14:07:04 +01:00
parent 5bb1c4a363
commit 418996df4a

View File

@ -182,8 +182,8 @@ A request is performed by sending a valid JSON object in the HTTP request body.
- **fields**: Array of requested fields (see [here](Readme.md#requested_fields)).
- **aggregation**: Setting this attribute activates data aggregation (see [here](Readme.md#data_aggregation) for its specification).
- **response**: Specifies the format of the response of the requested data (see [here](Readme.md#response_format)). If this value is not set it defaults to JSON.
- **mapping**: Activates a table like alignment of the response which allows a mapping of values belonging to the same pulse-id/global time (see [here](Readme.md#value_mapping)). Leave this parameter undefined for the default response alignment.
- **valueTransformations**: Provides the option to apply transformations to channel values (see [here](Readme.md#value_transformations)). Transformations are mapped to channels based on the provided pattern and backend.
- **mapping**: Activates a table like alignment of the response which allows a mapping of values belonging to the same pulse-id/global time (see [here](Readme.md#value_mapping) - usually left undefined).
- **valueTransformations**: Provides the option to apply transformations to channel values (see [here](Readme.md#value_transformations)).
<a name="define_channel_names"/>
@ -423,13 +423,13 @@ Following transformation sequence resizes images by the factor of 8, sets the va
- **valueAggregation**: Defines how the pixel values should be aggregated (values: **first-value**|max-value|mean-value). *first-value* uses the first value of the reduction square (very fast but signals might get lost), *max-value* uses the max value of the reduction square, and *mean-value* the mean value of the reduction square.
- **valueFunctions**: Array of functions to be applied to pixel values.
- **min**: Map all values smaller than the defined values to the *mapTo* value. Allows to define a filter to eliminate noise (using "mapTo":0) or to set a lower pixel value bound (e.g. to focus on a specific pixel value range - need to be used together with a *max* value function). In case *mapTo* is not defined it defaults to *min*.
- **max**: Map all values bigger than the defined values to the *mapTo* value. In case *mapTo* is not defined it defaults to *max*.
- **min**: Map all values smaller than the defined values to the *mapTo* value. Allows to define a filter to eliminate noise (using "mapTo":0) or to set a lower pixel value bound (e.g. to focus on a specific pixel value range - need to be used together with the *max* value function). In case *mapTo* is not defined it defaults to *min*.
- **max**: Map all values bigger than the defined values to the *mapTo* value. Can be used to set a upper pixel value bound (e.g. to focus on a specific pixel value range - need to be used together with the *min* value function) In case *mapTo* is not defined it defaults to *max*.
- **colorModel**: The color model to be used for the image.
- **type**: The color model type (values: linear|**temperature**|gradient). Each type has a decent default color scheme (linear uses a grayscale, temperatur a blue to red, and gradient a rainbow color scheme).
- **nrOfColors**: The number of colors to map between the min. and max. pixel value (use a power of 2 like 16, 32, 64, 128, or 256). The more colors you use the more details will be visible but the larger the images will be).
- **colors**: The colors to use for the color model (defaults for *linear* ["#000000","#FFFFFF"] (grayscale), for *temperature* ["#3B4CC0","#B40426"], and for *gradient* ["#0000FF","#00FFFF","#00FF00","#FFFF00","#FF0000"] (rainbow: blue, cyan, green, yellow, red)).
- **nrOfColors**: The number of colors to map between the min. and max. pixel value (use a power of 2 like 16, 32, 64, 128, or 256). The more colors used the more details will be visible but the larger the images will get).
- **colors**: The colors to use for the color model (defaults for *linear* "#000000","#FFFFFF" (grayscale), for *temperature* "#3B4CC0","#B40426", and for *gradient* "#0000FF","#00FFFF","#00FF00","#FFFF00","#FF0000" (rainbow: blue, cyan, green, yellow, red)).
- **imageFormat**: The output image format (values: **png**|jpg).
- **imageEncoder**: The encoding of the image (values: **base64string**|byte).