IRaster

class ansys.stk.core.graphics.IRaster

A raster dataset. A raster consists of one or more bands, or sets of values, which are most commonly associated with colors when the raster represents an image…

Overview

Methods

flip	Flips the raster along the given axis.
rotate	Rotate the raster by the given angle.
apply	Apply a raster filter to the raster and returns a new raster with the results of the filtering. The current raster is not modified.
apply_in_place	Apply a raster filter to the raster. The current raster will contain the results of the filtering.
extract_band	Extract the band of raster data associated with the given raster band.
extract_band_from_raster_format	Extract the bands of raster data associated with the given raster format.
copy_from_raster	Copy the data associated with the given raster into this raster.

Properties

attributes	Get the raster attributes that define the raster data.
width	Get the width of the raster in pixels.
height	Get the height of the raster in pixels.

Import detail

from ansys.stk.core.graphics import IRaster

Property detail

property IRaster.attributes: RasterAttributes

Get the raster attributes that define the raster data.

property IRaster.width: int

Get the width of the raster in pixels.

property IRaster.height: int

Get the height of the raster in pixels.

Method detail

IRaster.flip(self, axis: RasterFlipAxis) → None

Flips the raster along the given axis.

Parameters:

axis : RasterFlipAxis

Returns:

None

IRaster.rotate(self, angle: float) → None

Rotate the raster by the given angle.

Parameters:

angle : float

Returns:

None

IRaster.apply(self, filter: IRasterFilter) → IRaster

Apply a raster filter to the raster and returns a new raster with the results of the filtering. The current raster is not modified.

Parameters:

filter : IRasterFilter

Returns:

IRaster

IRaster.apply_in_place(self, filter: IRasterFilter) → None

Apply a raster filter to the raster. The current raster will contain the results of the filtering.

Parameters:

filter : IRasterFilter

Returns:

None

IRaster.extract_band(self, band: RasterBand) → IRaster

Extract the band of raster data associated with the given raster band.

Parameters:

band : RasterBand

Returns:

IRaster

IRaster.extract_band_from_raster_format(self, format: RasterFormat) → IRaster

Extract the bands of raster data associated with the given raster format.

Parameters:

format : RasterFormat

Returns:

IRaster

IRaster.copy_from_raster(self, raster: IRaster) → None

Copy the data associated with the given raster into this raster.

Parameters:

raster : IRaster

Returns:

None