api:dk11:python:tatukgis.pdk.tgis_layerpixel
Table of Contents
TGIS_LayerPixel class
DK11 for Python | tatukgis.pdk.TGIS_LayerPixel | Classes | Constructors | Methods | Properties | Events
Encapsulation of a common image layer - abstract class.
Syntax
# Python class TGIS_LayerPixel( TGIS_Layer ):
Inheritance
→ Object → TGIS_LayerAbstract → TGIS_Layer
Constructors
Inherited
Overrides
Protected
Private
| Name | Visibility | Description | |
|---|---|---|---|
| __init__ | public | Create a layer with default parameters. (Overrides TGIS_Layer.__init__) |
|
Methods
Inherited
Overrides
Protected
Private
| Name | Visibility | Description | |
|---|---|---|---|
| Alive | public | Makes a layer non-dormant. (Inherited from TGIS_Layer) |
|
| ApplyAntialiasSettings(bool) | public | Applies antialias settings used in scaling operations. | |
| ApplyAntialiasSettings(bool, TGIS_ScalingFilter) | public | Applies antialias settings used in scaling operations. | |
| ApplyAutoStyle | public | Applies auto-styling to the layer. (Inherited from TGIS_Layer) |
|
| ApplyCuttingPolygon | public | Sets a cutting polygon for a layer. (Inherited from TGIS_Layer) |
|
| AssignedParentLayerInternal | public | Assigns a parent layer. | |
| Build(bool, TGIS_CSCoordinateSystem, TGIS_Extent, float) | public | Builds an in-memory layer. | |
| Build(bool, TGIS_CSCoordinateSystem, TGIS_Extent, int, int) | public | Builds an in-memory layer. | |
| Build(str, bool, TGIS_CSCoordinateSystem, TGIS_Extent, float, TGIS_LayerPixelSubFormat) | public | Builds a layer. | |
| Build(str, bool, TGIS_CSCoordinateSystem, TGIS_Extent, int, int, TGIS_LayerPixelSubFormat) | public | Builds a layer. | |
| Build(str, TGIS_CSCoordinateSystem, TGIS_Extent, float) | public | Builds an image layer. | |
| Build(str, TGIS_CSCoordinateSystem, TGIS_Extent, int, int) | public | Builds an image layer. | |
| ChangeHash | public | Changes the hash for the purpose of verifying layer's modifications. (Inherited from TGIS_Layer) |
|
| ClearModified | public | Sets IsModified flag to false for a layer and its sublayers. (Inherited from TGIS_Layer) |
|
| Dormant | public | Makes a layer dormant. (Inherited from TGIS_Layer) |
|
| DormantGain | public | Calculates the approximate gain (in Megabytes) which can be achieved by releasing memory by calling Dormant method. (Inherited from TGIS_Layer) |
|
| Draw | public | Draws a layer. (Inherited from TGIS_Layer) |
|
| DrawEx | public | Draws a layer within a defined extent. (Inherited from TGIS_Layer) |
|
| DrawFlash | public | Draws a flash. (Inherited from TGIS_Layer) |
|
| DrawSelected | public | Draws only the selected item(s) on layer. (Inherited from TGIS_Layer) |
|
| DrawSelectedEx | public | Draws only the selected item(s) on layer that are within a defined extent. (Inherited from TGIS_Layer) |
|
| ExportLayer | public | Export layer. | |
| FinalizeWrite | public | Performs any operation required to safely finalize write operation, such as building quad trees for TGIS_FilePixelStore. | |
| GenerateRamp(TGIS_Color, TGIS_Color, TGIS_Color, float, float, float, bool, float, float, TGIS_ParamsSectionPixel, bool) | public | Generates a grid ramp. | |
| GenerateRamp(TGIS_Color, TGIS_Color, TGIS_Color, float, float, float, bool, float, float, TGIS_ParamsSectionPixel, bool, TGIS_ColorInterpolationMode) | public | Generates a grid ramp. | |
| GenerateRampEx(float, float, TGIS_ColorMapArray, TGIS_ParamsSectionPixel) | public | Generates a grid ramp from a mapped color array. | |
| GenerateRampEx(float, float, TGIS_ColorMapArray, TGIS_ParamsSectionPixel, TGIS_ColorInterpolationMode) | public | Generates a grid ramp from a mapped color array. | |
| GetAltitudeMapZone | public | Gets an altitude zone map definition. | |
| GetAvailableLayers | public | Gets a list of layers available in storage. (Inherited from TGIS_Layer) |
|
| GetBitmap | public | Fills provided _bitmap array with values defined by _extent. | |
| GetColorRamp | public | Calculates default color ramp RGB values. | |
| GetGrid | public | Fills provided _grid array with values defined by _extent. | |
| GetRawBitmap | public | Fills provided _bitmap array with values defined by _extent. | |
| GetSubLayer | public | Retrieve the layer identified by a name. (Inherited from TGIS_Layer) |
|
| HourglassShake | public | Notifies of busy state using an hourglass. (Inherited from TGIS_Layer) |
|
| ImportLayer(TGIS_LayerPixel, TGIS_Extent) | public | Imports layer from an existing pixel layer. | |
| ImportLayer(TGIS_LayerPixel, TGIS_Extent, TGIS_CSCoordinateSystem, int, int) | public | Imports layer from an existing pixel layer. | |
| ImportLayer(TGIS_LayerPixel, TGIS_Extent, TGIS_CSCoordinateSystem, int, int, TGIS_LayerPixelSubFormat) | public | Imports layer from an existing pixel layer. | |
| InitializeWrite | public | Performs any operation required to safely initialize write operation, such as batch operations for TGIS_FilePixelStore. | |
| IsGrid | public | Checks if the layer type is grid. (Inherited from TGIS_Layer) |
|
| IsPixel | public | Checks if the layer type is pixel. (Inherited from TGIS_Layer) |
|
| IsSupported | public | Checks if the operation is supported by the layer. (Inherited from TGIS_Layer) |
|
| IsVector | public | Checks if the layer type is vector. (Inherited from TGIS_Layer) |
|
| IsVector3D | public | Checks if the layer type is vector 3D. (Inherited from TGIS_Layer) |
|
| IsVisible | public | Checks if the layer is visible in a defined extent and current params. (Inherited from TGIS_Layer) |
|
| Locate | public | If a given point is located in the image area, returns true and sets variables. | |
| LocateEx | public | If a given point is located in the image area, returns true and sets variables. | |
| Lock | public | Locks layer in burst-mode operation. (Inherited from TGIS_Layer) |
|
| LockEstimate | public | Estimates memory size for pixel layer to be update. | |
| LockPixels(TGIS_Extent, TGIS_CSCoordinateSystem, bool) | public | Locks a fragment of the pixel layer for updating. | |
| LockPixels(TGIS_Extent, TGIS_CSCoordinateSystem, float, bool) | public | Locks a fragment of the pixel layer for updating. | |
| LockPixels(TGIS_Extent, TGIS_CSCoordinateSystem, float, int, bool) | public | Locks a fragment of the pixel layer for updating. | |
| LockPixels(TGIS_Extent, TGIS_CSCoordinateSystem, int, bool) | public | Locks a fragment of the pixel layer for updating. | |
| LockPixels(TRect, bool) | public | Locks a fragment of the pixel layer for updating. | |
| LockPixels(TRect, int, bool) | public | Locks a fragment of the pixel layer for updating. | |
| LockPixels(TRect, TGIS_Extent, int, int, int, bool) | public | Locks a fragment of the pixel layer for updating. | |
| Loop(float, TGIS_Shape, bool) | public | Prepares enumerator to iterate the layer through the linear shape. | |
| Loop(float, TGIS_Shape, int, bool) | public | Prepares enumerator to iterate the layer through the linear shape. | |
| Loop(TGIS_Extent, float, bool) | public | Prepares enumerator to iterate the layer (pixels are treated as points). | |
| Loop(TGIS_Extent, float, bool, TGIS_Shape, str, bool) | public | Prepares enumerator to iterate the layer. | |
| Loop(TGIS_Extent, float, bool, TGIS_Shape, str, int, bool) | public | Prepares enumerator to iterate the layer. | |
| Loop(TGIS_Extent, float, int, bool) | public | Prepares enumerator to iterate the layer (pixels are treated as points). | |
| Loop(TGIS_Extent, float, TGIS_Shape, str, bool) | public | Prepares enumerator to iterate the layer (pixels are treated as points). | |
| Loop(TGIS_Extent, float, TGIS_Shape, str, int, bool) | public | Prepares enumerator to iterate the layer (pixels are treated as points). | |
| MapColorValue | public | Maps color value to pixel color. | |
| MapGridValue | public | Maps grid value to pixel color. | |
| MapToRaster | public | Converts map coordinates to raster pixel location. | |
| MapToRasterRect | public | Converts map extent to raster rectangle. | |
| MergeLayer | public | Merge layer to an existing layer. | |
| Move | public | Moves a layer up or down in the viewer zorder list. (Inherited from TGIS_Layer) |
|
| MoveEx | public | Moves a layer up or down in the viewer zorder list (only visible layers). (Inherited from TGIS_Layer) |
|
| MustCalculateStatistics | public | Verifies if all statistics required to properly render the layer are available. (Inherited from TGIS_Layer) |
|
| MustReproject | public | Checks if the layer must be reprojected. (Inherited from TGIS_Layer) |
|
| MustSave | public | Checks if the layer was modified by editing. (Inherited from TGIS_Layer) |
|
| Open | public | Opens the layer. (Inherited from TGIS_Layer) |
|
| Paint | public | Draws the layer or fires PaintLayer event (if defined). (Inherited from TGIS_Layer) |
|
| Prepare | public | Opens the layer. (Inherited from TGIS_Layer) |
|
| PreRecognize | public | Checks if the layer can read the file. (Inherited from TGIS_Layer) |
|
| Project | public | Applies a projection on the single point. (Inherited from TGIS_Layer) |
|
| Project3D | public | Applies a projection on the single point in 3D. (Inherited from TGIS_Layer) |
|
| Project3D_Ref | public | Applies a projection on the single point in 3D. (Inherited from TGIS_Layer) |
|
| ProjectExtent | public | Applies a projection on the extent. (Inherited from TGIS_Layer) |
|
| Project_Ref | public | Applies a projection on the single point. (Inherited from TGIS_Layer) |
|
| PutGrid | public | Puts _grid array into layer at the place defined by _extent. | |
| RaiseBusyEvent | public | Fires Busy event of the layer. (Inherited from TGIS_Layer) |
|
| RaiseBusyPrepare | public | Fires BusyPrepare method of the assigned viewer. (Inherited from TGIS_Layer) |
|
| RaiseBusyRelease | public | Fires BusyRelease method of the assigned viewer. (Inherited from TGIS_Layer) |
|
| RaiseBusyShake | public | Fires BusyShake method of the assigned viewer. (Inherited from TGIS_Layer) |
|
| RasterToMap | public | Converts raster pixel location to map coordinates | |
| RasterToMapRect | public | Convert raster rectangle to map extent | |
| ReadConfig | public | Reads the layer configuration files. (Inherited from TGIS_Layer) |
|
| ReadConfigParam | public | Reads the layer configuration parameters. (Inherited from TGIS_Layer) |
|
| ReadGridLine | public | Reads a specific line of the grid into the preallocated buffer. | |
| RecalcExtent | public | Recalculates extent based on real shapes. (Inherited from TGIS_Layer) |
|
| RecalcProjectedExtent | public | Recalculates a projected extent. (Inherited from TGIS_Layer) |
|
| Recalculate | public | Recalculates layer MinZ and MaxZ values. | |
| ReOpen | public | Reopens the layer. (Inherited from TGIS_Layer) |
|
| RereadConfig | public | Rereads the layer configuration files. (Inherited from TGIS_Layer) |
|
| RevertAll | public | Reverts layer to its original content. (Inherited from TGIS_Layer) |
|
| RootLayer | public | Returns the absolute parent layer. (Inherited from TGIS_Layer) |
|
| SaveAll | public | Saves layer and destroys mirrored items. (Inherited from TGIS_Layer) |
|
| SaveData | public | Saves layer and destroys mirrored items. (Inherited from TGIS_Layer) |
|
| ScaleGrid(TGIS_GridArray, TGIS_GridArray, int, int) | public | Scales grid array using a linear filter by default. | |
| ScaleGrid(TGIS_GridArray, TGIS_GridArray, int, int, TGIS_ScalingFilter) | public | Scales grid array using defined filtering. | |
| SetCSByEPSG | public | Sets up Coordinate System to a coordinate system provided by a EPSG code. (Inherited from TGIS_Layer) |
|
| SetCSByWKT | public | Sets up Coordinate System to a coordinate system provided by a WKT string (GEOGCS or PROJCS). (Inherited from TGIS_Layer) |
|
| SetCSByWKTFile | public | Sets up Coordinate System to a coordinate system provided by a file which contains a WKT string (GEOGCS or PROJCS). (Inherited from TGIS_Layer) |
|
| SetCurrentFileScale | public | Sets internal file scales - (1.0, 1.0) is always possible | |
| SetWorld | public | Sets world parameters (equivalent to worldfile). | |
| Unlock | public | Unlocks layer from burst-mode operation. (Inherited from TGIS_Layer) |
|
| UnlockPixels | public | UnLocks a fragment. | |
| Unproject | public | Applies reverse projection (recovers from the projection) on the single point. (Inherited from TGIS_Layer) |
|
| Unproject3D | public | Applies reverse projection (recovers from the projection) on the singlepoint in 3D. (Inherited from TGIS_Layer) |
|
| Unproject3D_Ref | public | Applies reverse projection (recovers from the projection) on the single point in 3D. (Inherited from TGIS_Layer) |
|
| UnprojectExtent | public | Applies reverse projection (recovers from the projection) on the extent. (Inherited from TGIS_Layer) |
|
| Unproject_Ref | public | Applies reverse projection (recover from projection) on the single point. (Inherited from TGIS_Layer) |
|
| ViewerReParent | public | Sets viewer for the layer and its sublayers. (Inherited from TGIS_Layer) |
|
| WriteConfig | public | Writes layer configuration files. (Inherited from TGIS_Layer) |
|
Properties
Inherited
Protected
Private
| Name | Visibility | Description | |
|---|---|---|---|
| Active | public | Checks if the layer is active? Active means layer is visible and an object can be localized on the layer. (Inherited from TGIS_Layer) |
|
| Addition | public | Additional value. (Inherited from TGIS_Layer) |
|
| Age | public | Age of the layer (since its creation). (Inherited from TGIS_Layer) |
|
| AltitudeMapZonesCount | public | Number of altitude map zones. | |
| Antialias | public | Antialias scaling (for some layers only like PNG and JPG). | |
| AntialiasFilter | public | Scaling filter (like Linear, Lanczos) to be used for scaling images and grids. | |
| BandsCount | public | Number of bands in a file. | |
| Basemap | public | True if the layer must be interpreted as basemap (for background painting). (Inherited from TGIS_Layer) |
|
| BasemapDraw | public | If True, the layer at the moment is drawn inside a basemap thread. (Inherited from TGIS_Layer) |
|
| BitHeight | public | Height of the layer in pixels. | |
| BitWidth | public | Width of the layer in pixels. | |
| CachedPaint | public | False if layer must be painted directly (bypassing cache). (Inherited from TGIS_Layer) |
|
| Capabilities | public | Pixel sub-format list that is available for write operation. | |
| Caption | public | Caption of layer; if not filed directly then will be filed with Name when adding to the Viewer. (Inherited from TGIS_Layer) |
|
| CellHeight | public | Height of a cell in pixels. | |
| CellWidth | public | Width of a cell in pixels. | |
| CodePage | public | Code Page in which text has been stored. (Inherited from TGIS_Layer) |
|
| Collapsed | public | Checks if the layer is collapsed? Collapsed means only the layer's title will be visible inside the legend. (Inherited from TGIS_Layer) |
|
| Comments | public | Additional user comments. (Inherited from TGIS_Layer) |
|
| ConfigFile | public | Configuration file handle. (Inherited from TGIS_Layer) |
|
| ConfigName | public | Configuration file name. (Inherited from TGIS_Layer) |
|
| CS | public | Coordinate System that is assigned to the layer. (Inherited from TGIS_Layer) |
|
| CurrentPage | public | Current page of multipage file. | |
| CustomData | public | List of custom, user-defined data. (Inherited from TGIS_Layer) |
|
| CuttingPolygon | public | Cutting polygon that defines an input image's valid area. | |
| DefaultSubFormat | public | Default subformat information. | |
| DirectMode | public | True if the layer is direct-mode (bypassing cache). (Inherited from TGIS_Layer) |
|
| DormantMode | public | Dormant mode for the layer. (Inherited from TGIS_Layer) |
|
| Driver | public | The layer's driver name. (Inherited from TGIS_Layer) |
|
| Extent | public | Extent of the layer. (Inherited from TGIS_Layer) |
|
| Extent3D | public | Three-dimensional extent of the layer. (Inherited from TGIS_Layer) |
|
| FileCopyrights | public | Copyright information about the layer. (Inherited from TGIS_Layer) |
|
| FileInfo | public | Additional textual information about the layer such as compression, number of pixels, copyright, etc. (Inherited from TGIS_Layer) |
|
| ForcedBandsDefinition | public | Forced interpretation of bands in a layer. | |
| GridBand | public | Grid band number. | |
| HideFromLegend | public | False if the layer should not be visible in legend. (Inherited from TGIS_Layer) |
|
| InPaint | public | True if the layer upon paint process. (Inherited from TGIS_Layer) |
|
| Interpretation | public | The way the layer is interpreted: the default is as a grid, or as an image. | |
| IsExportable | public | True if the layer is exportable. (Inherited from TGIS_Layer) |
|
| IsGridImage | public | True if image is a grid. | |
| IsLocked | public | True if the layer is in locked state. (Inherited from TGIS_Layer) |
|
| IsNativeGridImage | public | True if image is a native grid. | |
| IsOpened | public | True if the layer is opened and is ready for operations. (Inherited from TGIS_Layer) |
|
| IsPersistent | public | True if the layer is persistent. (Inherited from TGIS_Layer) |
|
| IsReadOnly | public | True if the layer is read-only. (Inherited from TGIS_Layer) |
|
| IsTiled | public | True if layer is tiled. | |
| IsTopmost | public | True if the layer can be interpreted as the topmost (trackable) layer. (Inherited from TGIS_Layer) |
|
| Layer3D | public | Mode of 3D operations (Inherited from TGIS_Layer) |
|
| MaxHeight | public | Maximum elevation value of the grid. | |
| MaxHeightThreshold | public | Maximum threshold of the grid elevation values to display. | |
| MaxTileSize | public | Maximum allowed tile size for the layer. (Inherited from TGIS_Layer) |
|
| MinHeight | public | Minimum elevation value of the grid. | |
| MinHeightThreshold | public | Minimum threshold of the grid elevation values to display. | |
| MultiUserMode | public | Type of multiuser mode. (Inherited from TGIS_Layer) |
|
| Name | public | Name of layer; if not filled directly, then will be filled with Path when added to the viewer. (Inherited from TGIS_Layer) |
|
| NoDataColor | public | Color property to define default color to be used to fill "empty" area upon PixelExportManager. | |
| NoDataValue | public | Grid NoData value. | |
| PageCount | public | Number of pages in an image file. | |
| Params | public | Returns parameters for pixel layer. | |
| ParamsList | public | List of all parameter sections attached to the current layer. (Inherited from TGIS_Layer) |
|
| ParentLayer | public | Parent layer of a sub layer. (Inherited from TGIS_Layer) |
|
| Path | public | Path to file holding the layer's data. (Inherited from TGIS_Layer) |
|
| PathTAB | public | Path to a TAB referencing file. | |
| PathWithDriver | public | Path to file with the layer's data extended with driver name. (Inherited from TGIS_Layer) |
|
| Progressive | public | If true (default), then layer can be drawn as progressive. | |
| ProjectedExtent | public | Extent of the layer in projected units. (Inherited from TGIS_Layer) |
|
| Renderer | public | Handle to a renderer used for drawing shapes. (Inherited from TGIS_Layer) |
|
| Statistics | public | Layer statistics engine (Inherited from TGIS_Layer) |
|
| Stream | public | Reference to a potential layer underlying the stream. (Inherited from TGIS_Layer) |
|
| SubFormat | public | Current sub-format information. | |
| SubLayers | public | List of sublayers belonging to the layer. (Inherited from TGIS_Layer) |
|
| SubType | public | Type of sublayer. (Inherited from TGIS_Layer) |
|
| SupportsAutoStyle | public | Indicates whether the layer supports auto styling. (Inherited from TGIS_Layer) |
|
| SupportsTiledPaint | public | Indicates whether the layer supports tiled paint. (Inherited from TGIS_Layer) |
|
| Tag | public | Tag has no predefined meaning. (Inherited from TGIS_Layer) |
|
| TagInternal | public | TagInternal has no predefined meaning. (Inherited from TGIS_Layer) |
|
| TagPointer | public | TagPointer has no predefined meaning. (Inherited from TGIS_Layer) |
|
| TiledDrawMode | public | If True, the layer at the moment is drawn by tiler. (Inherited from TGIS_Layer) |
|
| Transform | public | Custom transformation. (Inherited from TGIS_Layer) |
|
| Transparency | public | Transparency value for the layer (0..100). (Inherited from TGIS_Layer) |
|
| UnSupportedOperations | public | Set of operations not supported by the layer. (Inherited from TGIS_Layer) |
|
| UseConfig | public | True if config file is active. (Inherited from TGIS_Layer) |
|
| UserObject | public | UserObject can be used to associate with the layer a user-defined object. (Inherited from TGIS_Layer) |
|
| Viewer | public | Reference to a viewer object. (Inherited from TGIS_Layer) |
|
| ZOrder | public | Layer's position relative to other layers. (Inherited from TGIS_Layer) |
|
| ZOrderEx | public | Layer position relative to other visible layers. (Inherited from TGIS_Layer) |
|
Events
Inherited
Protected
Private
| Name | Visibility | Description | |
|---|---|---|---|
| GridOperationEvent | published | Grid operation event. | |
| PixelOperationEvent | published | Pixel operation event. | |
References
2024/09/13 01:18