Class GeoTIFFImage

constructor

• new GeoTIFFImage(
      fileDirectory: ImageFileDirectory,
      littleEndian: boolean,
      cache: boolean,
      source: BaseSource,
  ): GeoTIFFImage

  Parameters

  • fileDirectory: ImageFileDirectory

    The parsed file directory

  • littleEndian: boolean

    Whether the file is encoded in little or big endian

  • cache: boolean

    Whether or not decoded tiles shall be cached

  • source: BaseSource

    The datasource to read from

  Returns GeoTIFFImage

fileDirectory

isTiled

littleEndian

planarConfiguration

source

tiles

getArrayForSample

• getArrayForSample(
      sampleIndex: number,
      sizeOrData: number | ArrayBufferLike,
  ): TypedArray

  Parameters

  • sampleIndex: number
  • sizeOrData: number | ArrayBufferLike

  Returns TypedArray

getBitsPerSample

• getBitsPerSample(sampleIndex?: number): number

  Parameters

  • sampleIndex: number = 0

  Returns number

getBlockHeight

• getBlockHeight(y: number): number

  Parameters

  • y: number

  Returns number

getBlockWidth

• getBlockWidth(): number

  Returns number

getBoundingBox

• getBoundingBox(tilegrid?: boolean): number[]

  Returns the image bounding box as an array of 4 values: min-x, min-y, max-x and max-y. When the image has no affine transformation, then an exception is thrown.

  Parameters

  • Optionaltilegrid: boolean = false

    If true return extent for a tilegrid without adjustment for ModelTransformation.

  Returns number[]

  The bounding box

getBytesPerPixel

• getBytesPerPixel(): number

  Calculates the number of bytes for each pixel across all samples. Only full bytes are supported, an exception is thrown when this is not the case.

  Returns number

  the bytes per pixel

getFileDirectory

• getFileDirectory(): ImageFileDirectory

  Returns the associated parsed file directory.

  Returns ImageFileDirectory

  the parsed file directory

getGDALMetadata

• getGDALMetadata(sample?: number | null): Promise<Record<string, unknown> | null>

  Returns the parsed GDAL metadata items.

  If sample is passed to null, dataset-level metadata will be returned. Otherwise only metadata specific to the provided sample will be returned.

  Parameters

  • Optionalsample: number | null = null

    The sample index.

  Returns Promise<Record<string, unknown> | null>

  The GDAL metadata items

getGDALNoData

• getGDALNoData(): number | null

  Returns the GDAL nodata value

  Returns number | null

getGeoKeys

• getGeoKeys(): Partial<Record<GeoKeyName, any>> | null

  Returns the associated parsed geo keys.

  Returns Partial<Record<GeoKeyName, any>> | null

  the parsed geo keys

getHeight

• getHeight(): number

  Returns the height of the image.

  Returns number

  the height of the image

getOrigin

• getOrigin(): number[]

  Returns the image origin as a XYZ-vector. When the image has no affine transformation, then an exception is thrown.

  Returns number[]

  The origin as a vector

getReaderForSample

• getReaderForSample(
      sampleIndex: number,
  ): (this: DataView, byteOffset: number, littleEndian: boolean) => number

  Parameters

  • sampleIndex: number

  Returns (this: DataView, byteOffset: number, littleEndian: boolean) => number

getResolution

• getResolution(referenceImage?: GeoTIFFImage | null): number[]

  Returns the image resolution as a XYZ-vector. When the image has no affine transformation, then an exception is thrown.

  Parameters

  • OptionalreferenceImage: GeoTIFFImage | null = null

    A reference image to calculate the resolution from in cases when the current image does not have the required tags on its own.

  Returns number[]

  The resolution as a vector

getSampleByteSize

• getSampleByteSize(i: number): number

  Parameters

  • i: number

  Returns number

getSampleFormat

• getSampleFormat(sampleIndex?: number): number

  Parameters

  • sampleIndex: number = 0

  Returns number

getSamplesPerPixel

• getSamplesPerPixel(): number

  Returns the number of samples per pixel.

  Returns number

  the number of samples per pixel

getTiePoints

• getTiePoints(): Promise<
      { i: number; j: number; k: number; x: number; y: number; z: number }[],
  >

  Returns an array of tiepoints.

  Returns Promise<{ i: number; j: number; k: number; x: number; y: number; z: number }[]>

  the tiepoints

getTileHeight

• getTileHeight(): number

  Returns the height of each tile.

  Returns number

  the height of each tile

getTileOrStrip

• getTileOrStrip(
      x: number,
      y: number,
      sample: number,
      poolOrDecoder: default | DecoderWorker,
      signal?: AbortSignal,
  ): Promise<{ data: ArrayBufferLike; sample: number; x: number; y: number }>

  Returns the decoded strip or tile.

  Parameters

  • x: number

    the strip or tile x-offset

  • y: number

    the tile y-offset (0 for stripped images)

  • sample: number

    the sample to get for separated samples

  • poolOrDecoder: default | DecoderWorker

    the decoder or decoder pool

  • Optionalsignal: AbortSignal

    An AbortSignal that may be signalled if the request is to be aborted

  Returns Promise<{ data: ArrayBufferLike; sample: number; x: number; y: number }>

  the decoded strip or tile

getTileWidth

• getTileWidth(): number

  Returns the width of each tile.

  Returns number

  the width of each tile

getWidth

• getWidth(): number

  Returns the width of the image.

  Returns number

  the width of the image

pixelIsArea

• pixelIsArea(): boolean

  Returns whether or not the pixels of the image depict an area (or point).

  Returns boolean

  Whether the pixels are a point

readRasters

• readRasters(
      options: ReadRastersOptions & { interleave: true },
  ): Promise<TypedArrayWithDimensions>

  Parameters

  • options: ReadRastersOptions & { interleave: true }

    optional parameters

  Returns Promise<TypedArrayWithDimensions>

  the decoded arrays as a promise

• readRasters(
      options: ReadRastersOptions & { interleave: false },
  ): Promise<TypedArrayArrayWithDimensions>

  Parameters

  • options: ReadRastersOptions & { interleave: false }

    optional parameters

  Returns Promise<TypedArrayArrayWithDimensions>

  the decoded arrays as a promise

• readRasters(
      options: ReadRastersOptions & { interleave: boolean },
  ): Promise<ReadRasterResult>

  Parameters

  • options: ReadRastersOptions & { interleave: boolean }

    optional parameters

  Returns Promise<ReadRasterResult>

  the decoded arrays as a promise

• readRasters(
      options?: ReadRastersOptions,
  ): Promise<TypedArrayArrayWithDimensions>

  Parameters

  • Optionaloptions: ReadRastersOptions

    optional parameters

  Returns Promise<TypedArrayArrayWithDimensions>

  the decoded arrays as a promise

readRGB

• readRGB(
      options: ReadRGBOptions & { interleave: true },
  ): Promise<TypedArrayWithDimensions>

  Parameters

  • options: ReadRGBOptions & { interleave: true }

    optional parameters

  Returns Promise<TypedArrayWithDimensions>

  the RGB array as a Promise

• readRGB(
      options: ReadRGBOptions & { interleave: false },
  ): Promise<TypedArrayArrayWithDimensions>

  Parameters

  • options: ReadRGBOptions & { interleave: false }

    optional parameters

  Returns Promise<TypedArrayArrayWithDimensions>

  the RGB array as a Promise

• readRGB(
      options: ReadRGBOptions & { interleave: boolean },
  ): Promise<ReadRasterResult>

  Parameters

  • options: ReadRGBOptions & { interleave: boolean }

    optional parameters

  Returns Promise<ReadRasterResult>

  the RGB array as a Promise

• readRGB(options?: ReadRGBOptions): Promise<TypedArrayArrayWithDimensions>

  Parameters

  • Optionaloptions: ReadRGBOptions

    optional parameters

  Returns Promise<TypedArrayArrayWithDimensions>

  the RGB array as a Promise