User Tools

Site Tools


api:dk11:activex:tatukgis_xdk11.itgis_statisticspixel

ITGIS_StatisticsPixel interface

DK11 for ActiveX | TatukGIS_XDK11.ITGIS_StatisticsPixel | Interfaces | Methods | Properties

Statistics class for raster layers.

Available also on: Delphi | .NET | Java.

Syntax

// C#
public interface ITGIS_StatisticsPixel: ITGIS_StatisticsLayer
{
}
' VisualBasic
Public Interface ITGIS_StatisticsPixel
  Implements ITGIS_StatisticsLayer
End Class
// Oxygene
type
  ITGIS_StatisticsPixel = public interface( ITGIS_StatisticsLayer )
  end;

Implements

Methods

Inherited Overrides Protected
Name Visibility Description
Add public Add statistics result definition.
(Inherited from ITGIS_StatisticsAbstract)
AddAll public Add statistics result definitions for all available datasets.
(Inherited from ITGIS_StatisticsAbstract)
AddAllBands public Add statistics result definitions for all bands from pixel layer;
AddAllBands_2 public Add statistics result definitions for all bands from pixel layer;
AddAll_2 public Add statistics result definitions for all available datasets.
(Inherited from ITGIS_StatisticsAbstract)
Add_2 public Add statistics result definition.
(Inherited from ITGIS_StatisticsAbstract)
Add_3 public Add statistics result definition.
(Inherited from ITGIS_StatisticsAbstract)
Add_4 public Add statistics result definition.
(Inherited from ITGIS_StatisticsAbstract)
AttachDelphiObj public Only for internal use of TatukGIS.
(Inherited from ITBaseObject)
Calculate public Calculate requested statistics from the entire layer.
(Inherited from ITGIS_StatisticsAbstract)
Calculate_2 public Calculate requested statistics from filtered elements of the layer.
(Inherited from ITGIS_StatisticsAbstract)
Create_ public Create an object.
(Inherited from ITGIS_StatisticsLayer)
DelphiObj public Only for internal use of TatukGIS.
(Inherited from ITBaseObject)
Get public Get statistics result by name.
(Inherited from ITGIS_StatisticsAbstract)
LoadFromFile public Parse statistics file and load all information into parent layer.
(Inherited from ITGIS_StatisticsAbstract)
LoadFromFile_2 public Parse statistics file and load all information into parent layer.
(Inherited from ITGIS_StatisticsAbstract)
Reset public Reset statistics object to initial state.
(Inherited from ITGIS_StatisticsAbstract)
ResetModified public Undo changes in requested statistics definitions.
(Inherited from ITGIS_StatisticsAbstract)
SaveToFile public Save layer statistics into auxiliary file.
(Inherited from ITGIS_StatisticsAbstract)
SaveToFile_2 public Save layer statistics into auxiliary file.
(Inherited from ITGIS_StatisticsAbstract)

Properties

Inherited Protected
Name Visibility Description
Age public Age of the statistics.
(Inherited from ITGIS_StatisticsAbstract)
AvailableResults public List of available results names; read-only.
(Inherited from ITGIS_StatisticsAbstract)
DefinedResults public List of already defined results names; read-only.
(Inherited from ITGIS_StatisticsAbstract)
FastStatistics public Determines the state if 'Fast Statistics' was computed; read-only.
(Inherited from ITGIS_StatisticsAbstract)
Layer public Layer assigned to statistics; read-only.
(Inherited from ITGIS_StatisticsLayer)
Modified public True if requested statistics have changed.
(Inherited from ITGIS_StatisticsAbstract)
Obsolete public Check validity of statistics.
(Inherited from ITGIS_StatisticsAbstract)
UseBesselCorrection public If True, statistics class will use Bessel's correction.
(Inherited from ITGIS_StatisticsAbstract)

Remarks

This class inherits from TGIS_StatisticsAbstract and is specialised for pixel layers, e.g.:

  • AddAllBands method,
  • To avoid long calculation on big images, FastStatistics property is set to True by default. It means that statistics engine uses resampling for pixel layers greater than 2048 x 2048 cells. In this case results are approximate with high accuracy. Set False to compute fully accurate statistics.

See TGIS_StatisticsAbstract class.

Example

Pseudocode:

// layer.Statistics is an instance of TGIS_StatisticsAbstract so casting is needed
stats = TGIS_StatisticsPixel(layer.Statistics);

// add all bands from pixel layer
stats.AddAllBands(TGIS_StatisticalFunctions.BasicStatistics);

stats.Calculate;

// demand a result
stats_result = stats.Get(<valid_name>);

Valid names are 'A', 'R', 'G', 'B', 'H', 'S', 'L' for images and 'Value' for grid (listed in stats.AvailableResults list).

Use later like in TGIS_Abstract example.

2019/09/27 01:05