Functions
bool	Image.ClearOverviews ()
	Clears the overviews for the datasource. More...

GdalRasterBand	Image.get_Band (int bandIndex)
	Gets the band with the specified index. More...

double	Image.get_BandMaximum (int bandIndex)
	Gets the maximum value for the specified band. More...

double	Image.get_BandMinimum (int bandIndex)
	Gets the minimum value for the specified band. More...

uint	Image.get_ValueWithAlpha (int Row, int Column)
	Gets the value of the specified pixel including the alpha component. More...

void	Image.set_ValueWithAlpha (int Row, int Column, uint pVal)
	Sets the value of the specified pixel including the alpha component. More...

bool	Image.SetBandMinMax (int bandIndex, double min, double max)
	Sets the band minimum maximum values for the band. Values outside of this range will not be rendered. More...

bool	Image.SetDefaultMinMax (int bandIndex)
	Calculates the minimum and maximum values for the specified band and caches them for further use. More...

Properties
GdalRasterBand	Image.ActiveBand `[get]`
	Gets the active band (the one used for rendering when grid rendering is on). More...

GridColorScheme	Image.ActiveColorScheme `[get]`
	Gets the active color scheme used for the rendering, it may be either default or custom one. More...

int	Image.AlphaBandIndex `[get, set]`
	Gets or sets the index of the alpha band. More...

int	Image.BlueBandIndex `[get, set]`
	Gets or sets the index of the blue band (used when RGB rendering is chosen). More...

float	Image.Brightness `[get, set]`
	Gets or sets the brightness of the image. More...

int	Image.BufferOffsetX `[get]`
	Gets the index of the left most pixel of the original image that was included in the current buffer. More...

int	Image.BufferOffsetY `[get]`
	Gets the index of the top most pixel of the original image that was included in the current buffer. More...

uint	Image.ColorizeColor `[get, set]`
	Gets or sets the color of the colorize. More...

float	Image.ColorizeIntensity `[get, set]`
	Gets or sets the colorize intensity. More...

float	Image.Contrast `[get, set]`
	Gets or sets the contrast of the image. More...

bool	Image.ForceSingleBandRendering `[get, set]`
	Gets or sets a value indicating whether the band set by Image.ActiveBandIndex will be used rather then RGB rendering. More...

float	Image.Gamma `[get, set]`
	Gets or sets the gamma correction value for the image. More...

GdalDriver	Image.GdalDriver `[get]`
	Gets the GDAL driver which manages the current datasource. More...

int	Image.GreenBandIndex `[get, set]`
	Gets or sets the index of the green band (used when RGB rendering is chosen). More...

float	Image.Hue `[get, set]`
	Gets or sets the hue of the image. More...

bool	Image.IgnoreColorTable `[get, set]`
	Gets or sets a value indicating whether built-in color table of the image will be ignored. More...

tkPaletteInterpretation	Image.PaletteInterpretation2 `[get]`
	Gets the palette interpretation for the image. More...

int	Image.RedBandIndex `[get, set]`
	Gets or sets the index of the red band (used when RGB rendering is chosen). More...

tkRasterRendering	Image.RenderingMode `[get]`
	Gets the current rendering mode for the image (depends on the values of other properties). More...

bool	Image.ReverseGreyscale `[get, set]`
	Gets or sets a value indicating whether colors should be reversed during gray scale rendering (i.e. the smallest values are white). More...

float	Image.Saturation `[get, set]`
	Gets or sets the saturation of the image. More...

bool	Image.UseActiveBandAsAlpha `[get, set]`
	Gets or sets a value indicating whether to use active band as an alpha band as well. More...

bool	Image.UseRgbBandMapping `[get, set]`
	Gets or sets a value indicating whether RGB band mapping will be used. More...

Detailed Description

Here is a list of properties and methods added in the version 4.9.4. The properties and methods described here belong to Image class.

Function Documentation

◆ ClearOverviews()

bool Image.ClearOverviews ( )

Clears the overviews for the datasource.

New API 4.9.4:: Added in version 4.9.4

◆ get_Band()

GdalRasterBand Image.get_Band ( int bandIndex )

Gets the band with the specified index.

Parameters

bandIndex Index of the band.

Returns: Raster band.

New API 4.9.4:: Added in version 4.9.4

◆ get_BandMaximum()

double Image.get_BandMaximum ( int bandIndex )

Gets the maximum value for the specified band.

Parameters

bandIndex Index of the band.

New API 4.9.4:: Added in version 4.9.4

◆ get_BandMinimum()

double Image.get_BandMinimum ( int bandIndex )

Gets the minimum value for the specified band.

Parameters

bandIndex Index of the band.

New API 4.9.4:: Added in version 4.9.4

◆ get_ValueWithAlpha()

uint Image.get_ValueWithAlpha	(	int	Row,
		int	Column
	)

Gets the value of the specified pixel including the alpha component.

Parameters

Row	The row.
Column	The column.

Returns: 32bit unsigned integer value.

New API 4.9.4:: Added in version 4.9.4

◆ set_ValueWithAlpha()

void Image.set_ValueWithAlpha	(	int	Row,
		int	Column,
		uint	pVal
	)

Sets the value of the specified pixel including the alpha component.

Parameters

Row	The row.
Column	The column.
pVal	The value to set.

New API 4.9.4:: Added in version 4.9.4

◆ SetBandMinMax()

bool Image.SetBandMinMax	(	int	bandIndex,
		double	min,
		double	max
	)

Sets the band minimum maximum values for the band. Values outside of this range will not be rendered.

Parameters

bandIndex	Index of the band.
min	The minimum.
max	The maximum.

Returns: True on success.

New API 4.9.4:: Added in version 4.9.4

◆ SetDefaultMinMax()

bool Image.SetDefaultMinMax ( int bandIndex )

Calculates the minimum and maximum values for the specified band and caches them for further use.

Parameters

bandIndex Index of the band.

Returns: True on success.

New API 4.9.4:: Added in version 4.9.4

Properties

◆ ActiveBand

GdalRasterBand Image.ActiveBand

get

Gets the active band (the one used for rendering when grid rendering is on).

New API 4.9.4:: Added in version 4.9.4

◆ ActiveColorScheme

GridColorScheme Image.ActiveColorScheme

get

Gets the active color scheme used for the rendering, it may be either default or custom one.

New API 4.9.4:: Added in version 4.9.4

◆ AlphaBandIndex

int Image.AlphaBandIndex

getset

Gets or sets the index of the alpha band.

New API 4.9.4:: Added in version 4.9.4

◆ BlueBandIndex

int Image.BlueBandIndex

getset

Gets or sets the index of the blue band (used when RGB rendering is chosen).

New API 4.9.4:: Added in version 4.9.4

◆ Brightness

float Image.Brightness

getset

Gets or sets the brightness of the image.

New API 4.9.4:: Added in version 4.9.4

◆ BufferOffsetX

int Image.BufferOffsetX

get

Gets the index of the left most pixel of the original image that was included in the current buffer.

New API 4.9.4:: Added in version 4.9.4

◆ BufferOffsetY

int Image.BufferOffsetY

get

Gets the index of the top most pixel of the original image that was included in the current buffer.

New API 4.9.4:: Added in version 4.9.4

◆ ColorizeColor

uint Image.ColorizeColor

getset

Gets or sets the color of the colorize.

New API 4.9.4:: Added in version 4.9.4

◆ ColorizeIntensity

float Image.ColorizeIntensity

getset

Gets or sets the colorize intensity.

New API 4.9.4:: Added in version 4.9.4

◆ Contrast

float Image.Contrast

getset

Gets or sets the contrast of the image.

New API 4.9.4:: Added in version 4.9.4

◆ ForceSingleBandRendering

bool Image.ForceSingleBandRendering

getset

Gets or sets a value indicating whether the band set by Image.ActiveBandIndex will be used rather then RGB rendering.

New API 4.9.4:: Added in version 4.9.4

◆ Gamma

float Image.Gamma

getset

Gets or sets the gamma correction value for the image.

New API 4.9.4:: Added in version 4.9.4

◆ GdalDriver

GdalDriver Image.GdalDriver

get

Gets the GDAL driver which manages the current datasource.

New API 4.9.4:: Added in version 4.9.4

◆ GreenBandIndex

int Image.GreenBandIndex

getset

Gets or sets the index of the green band (used when RGB rendering is chosen).

New API 4.9.4:: Added in version 4.9.4

◆ Hue

float Image.Hue

getset

Gets or sets the hue of the image.

New API 4.9.4:: Added in version 4.9.4

◆ IgnoreColorTable

bool Image.IgnoreColorTable

getset

Gets or sets a value indicating whether built-in color table of the image will be ignored.

New API 4.9.4:: Added in version 4.9.4

◆ PaletteInterpretation2

tkPaletteInterpretation Image.PaletteInterpretation2

get

Gets the palette interpretation for the image.

New API 4.9.4:: Added in version 4.9.4

◆ RedBandIndex

int Image.RedBandIndex

getset

Gets or sets the index of the red band (used when RGB rendering is chosen).

New API 4.9.4:: Added in version 4.9.4

◆ RenderingMode

tkRasterRendering Image.RenderingMode

get

Gets the current rendering mode for the image (depends on the values of other properties).

New API 4.9.4:: Added in version 4.9.4

◆ ReverseGreyscale

bool Image.ReverseGreyscale

getset

Gets or sets a value indicating whether colors should be reversed during gray scale rendering (i.e. the smallest values are white).

New API 4.9.4:: Added in version 4.9.4

◆ Saturation

float Image.Saturation

getset

Gets or sets the saturation of the image.

New API 4.9.4:: Added in version 4.9.4

◆ UseActiveBandAsAlpha

bool Image.UseActiveBandAsAlpha

getset

Gets or sets a value indicating whether to use active band as an alpha band as well.

New API 4.9.4:: Added in version 4.9.4

◆ UseRgbBandMapping

bool Image.UseRgbBandMapping

getset

Gets or sets a value indicating whether RGB band mapping will be used.

See also: RedBandIndex, GreenBandIndex, BlueBandIndex, AlphaBandIndex

New API 4.9.4:: Added in version 4.9.4

Functions

Properties

Detailed Description

Function Documentation

◆ ClearOverviews()

◆ get_Band()

◆ get_BandMaximum()

◆ get_BandMinimum()

◆ get_ValueWithAlpha()

◆ set_ValueWithAlpha()

◆ SetBandMinMax()

◆ SetDefaultMinMax()

Properties

◆ ActiveBand

◆ ActiveColorScheme

◆ AlphaBandIndex

◆ BlueBandIndex

◆ Brightness

◆ BufferOffsetX

◆ BufferOffsetY

◆ ColorizeColor

◆ ColorizeIntensity

◆ Contrast

◆ ForceSingleBandRendering

◆ Gamma

◆ GdalDriver

◆ GreenBandIndex

◆ Hue

◆ IgnoreColorTable

◆ PaletteInterpretation2

◆ RedBandIndex

◆ RenderingMode

◆ ReverseGreyscale

◆ Saturation

◆ UseActiveBandAsAlpha

◆ UseRgbBandMapping