Pyramid.Constant

Description

Name

class Tinman.Pyramid.Constant

Derived from

Builder

Creates a pixel pyramid with separate uniform colors for the cubemap-Y faces.

Usually, this method is used to create a pixel pyramid that fills holes at the North and South poles (e.g. Mercator voids).

Fields / Required

size

Type

number

Constraint

# > 0

The size of the bottom-most pyramid level, in pixels. Will be round up to the next power of two.


color

The uniform color value for Face.NegY. This is usually the North pole.

Fields / Optional

cube

Type

bool

Default

true

Create an unprojected cubemap pyramid (true) or a projected rectangular pyramid ( false).


tile

Type

number

Constraint

# > 0

Default

256

The tile size, in pixels. Will be round up to the next power of two.


pad

Type

number

Constraint

# >= 0

Default

0

The tile pad of the pyramid, in pixels.


georef

Type

Tinman.Georef

Default

null

The georeference of the pyramid.


second

Type

Tinman.Color

Default

{Color.Name: Zero}

The uniform color value for Face.PosY. This is usually the South pole.

Fields / External

id

Type

Dataset.Id

Returns a unique identifier for this dataset.


metadata

Returns dataset metadata information.


info

Holds detail information about this pixel pyramid.