FC_Parameter

Definition

Parameter string.

typedef struct FC_Parameter

{

  const char *name;

  const char *value;

} FC_Parameter;

Members

name

Parameter name.

value

Parameter value.

Remarks

Parameter defines a set of parameters passed into plugins that are read-only. The structure includes the format info parameters stored in the .RPDef as a name and value map that are converted to a constant for optimization. This structure is used to pass special parameters such as scale and offset that may be required. These parameters are passed to the reader when the image is opened.

You are free to add custom parameters in the .RPDef (FormatInfo node under each Raster). Prefix parameter names with plugin name (for example, “julia:creal”) to avoid conflicts. Names and values are not generally case sensitive, nor is the case preserved.

Common parameters

Name

Description

NCols

Image width

NRows

Image height

PixelType

Pixel type

BitDepth

Bit depth

ColorSpace

Image color space

TileWidth

Tile width ( if used )

TileHeight

Tile height ( if tiled )

Interleave

Image layout

ByteOrder

Image byte order

TreatAsFloat

Assume raw data is float

TreatAsInteger

Assume raw data is integer

ApplyScaleOffset

Apply a scan and offset to data ( elevation )

FloatScale

Scale to use

FloatOffset

Offset to use

ApplyConvert

Use a conversion function