vrt.Band

One VRT band.

Usage

Source

vrt.Band(
    dtype,
    sources=list(),
    nodata=None,
    description="",
    color_interp=ColorInterp.gray,
    unit=None,
    metadata=dict(),
    pixel_function=None,
    scale=None,
    offset=None
)

Parameters

dtype: str

NumPy dtype name.

sources: list[Source] = list()

Sources in draw order: a later source wins where they overlap.

nodata: float | None = None

Band nodata value.

description: str = ""

Band description.

color_interp: ColorInterp = ColorInterp.gray

Colour interpretation.

unit: str | None = None

Unit of the pixel values.

metadata: dict[str, str] = dict()

Band metadata items.

pixel_function: PixelFunction | None = None

Pixel function combining the sources; setting it makes a derived band.

scale: float | None = None

Scale and offset turning pixel values into physical values; None writes none.

offset: float | None = None
Scale and offset turning pixel values into physical values; None writes none.

Methods

Name Description
__eq__() Compare all fields, treating NaN nodata as equal.

__eq__()

Compare all fields, treating NaN nodata as equal.

Usage

Source

__eq__(other)
Parameters
other: object
Object to compare with.
Returns
bool
Whether other is a Band with equal fields.