Constructor
new MultiGeoTIFF(mainFile, overviewFiles)
Construct a new MultiGeoTIFF from a main and several overview files.
Parameters:
| Name | Type | Description |
|---|---|---|
mainFile |
module:geotiff~GeoTIFF | The main GeoTIFF file. |
overviewFiles |
Array.<module:geotiff~GeoTIFF> | An array of overview files. |
- Source:
Extends
- GeoTIFFBase
- module:geotiff~GeoTIFFBase
Methods
(async) getImage(indexopt) → {Promise.<module:geotiffimage~GeoTIFFImage>}
Get the n-th internal subfile of an image. By default, the first is returned.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
index |
number |
<optional> |
0 | the index of the image to return. |
- Source:
Returns:
the image at the given index
- Type
- Promise.<module:geotiffimage~GeoTIFFImage>
(async) getImageCount() → {Promise.<number>}
Returns the count of the internal subfiles.
- Source:
Returns:
the number of internal subfile images
- Type
- Promise.<number>
(async) readRasters(optionsopt) → {Promise.<module:geotiff~ReadRasterResult>}
(experimental) Reads raster data from the best fitting image. This function uses
the image with the lowest resolution that is still a higher resolution than the
requested resolution.
When specified, the bbox option is translated to the window option and the
resX and resY to width and height respectively.
Then, the readRasters method of the selected
image is called and the result returned.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
options |
module:geotiffimage~ReadRasterOptions |
<optional> |
{} | optional parameters |
- Overrides:
- Source:
- See:
-
- GeoTIFFImage.readRasters
Returns:
the decoded array(s), with height and width, as a promise
- Type
- Promise.<module:geotiff~ReadRasterResult>