FrequDistOfMatrix

Declaration: FrequDistOfMatrix (Data: TDouble2DArray; Mask: TBool2DArray; LoX, LoY, HiX, HiY: longint; FirstBin, LastBin, BinWidth: double; var FrequDist: TIntArray; var Underflow, Overflow, MaxCnt: longint): integer;
The function FrequDistOfMatrix calculates the frequency distribution of the values contained in the array Data. The parameters LoX, LoY, HiX and HiY control the region of the data array to be used for the analysis (0-based array index values). Setting all four values to zero is equivalent to using the entire array. Further you may restrict the region which is used for the calculations by using the Mask parameter. Pixels whose corresponding Mask value is TRUE are ommitted from the calculations.

The parameters FirstBin and LastBin specify the left (lower) boundary of the first and the last bin of the frequency distribution. The parameter BinWidth defines the width of the bins. A particular bin of the histogram spans the range from FirstBin + i*BinWidth to FirstBin + (i+1)*BinWidth, with i being the bin number (starting from zero). The integer array FrequDist contains the counts of the distribution. FrequDist is automatically resized. Values which don't fit into the histogram (i.e. values which are less than FirstBin, or greater than LastBin + BinWidth) are counted in the variable parameters UnderFlow and OverFlow. The variable parameter MaxCnt returns the maximum count over all bins.

The function returns the following error codes:

 0 ... everything is OK
-1 ... LoX, LoY, LoX, or HiX is out of range
-2 ... LoX/Y must not be greater than HiX/Y
-3 ... FirstBin must not be ≥ LastBin
-4 ... BinWidth must be > 0
-5 ... BinWidth is too small, resulting in too many bins (max. 1000 allowed)
-6 ... the sizes of Mask and Data array do not match

Sample
program:
The following sample code lets you select two different layers of the currently loaded dataset. The frequency distributions of the data of the two layers are then displayed and compared by means of a chi2-test.
program FrequDistribution;

const
  PAGE = 1;       // chart page
  NBINS = 100;    // number of bins of the frequency distribution

(******************************************************************************)
procedure ListDistributions (Distri1, Distri2: TIntArray);
(******************************************************************************)

var
  i     : integer;

begin
with ChartBook.Tables[PAGE] do
  begin
  NrOfRows := length(Distri1);
  for i:=1 to length(Distri1) do  // lines
    Elem[1,i] := IntToStr(Distri1[i-1]);
  for i:=1 to length(Distri2) do  // lines
    Elem[2,i] := IntToStr(Distri1[i-1]);
  end;
end;


(******************************************************************************)
procedure DrawDistribution (Distri: TIntArray; Color: TColor; FirstBin,
                            Binwidth, Offset: double);
(******************************************************************************)

var
  i     : integer;

begin
with ChartBook.Charts[PAGE] do
  begin
  DataColor := Color;
  for i:=1 to length(Distri) do  // lines
    begin
    MoveTo (FirstBin+Binwidth*(i-1)+offset, 0);
    DrawTo (FirstBin+Binwidth*(i-1)+offset, Distri[i-1]);
    end;
  MoveTo (FirstBin, Distri[0]);  // envelope
  for i:=1 to length(Distri) do
    DrawTo (FirstBin+Binwidth*(i-1)+offset, Distri[i-1]);
  AutoRange (1,4);
  Update;
  end;
end;

(******************************************************************************)
// main program
(******************************************************************************)

var
  Data           : TDouble2DArray;
  ll1, ll2       : integer;
  FrequDist1     : TIntArray;
  FrequDist2     : TIntArray;
  Underflow,
  Overflow,
  MaxCnt         : longint;
  LList          : TIntArray;
  Chi2, p        : double;
  df             : integer;
  nObs, nExp     : integer;
  min1, max1     : double;
  min2, max2     : double;
  minidx, maxidx : integer;
  offset         : double;
  Mask           : TBool2DArray;

begin
ll1 := SelectLayer (1, false, false, LList, 'Please select a layer');
GetCubeLayer (ll1,1,Data);
MinMaxMatrix (Data, 0, 0, 0, 0, min1, max1);
ll2 := SelectLayer (1, false, false, LList, 'Please select a layer to compare');
GetCubeLayer (ll2,1,Data);
MinMaxMatrix (Data, 0, 0, 0, 0, min2, max2);
MinMaxVector([Min1, min2, max1, max2], 0, 3, min1, max1, minidx, maxidx);

if ll1 = ll2              // displace plots if the distributions
  then offset := 0.2      // come from the same layers
  else offset := 0.0;

ResizeBoolMatrix (Mask, GetCubeSize(dimX), GetCubeSize(dimY));
FillBoolMatrix (Mask, false);
if FrequDistOfMatrix (Data, Mask,
                      0,0,0,0,              // LoX, LoY, HiX, HiY,
                      min1, max1,           // FirstBin, LastBin,
                      (max1-min1)/NBINS,    // BinWidth,
                      FrequDist1,
                      Underflow, Overflow, MaxCnt) = 0 then
  begin
  ChartBook.Reset;
  ChartBook.Configure
     (PAGE,               // page 1
      true, true, false, // only the chart is visible
      250, 250);          // default width & height
  ChartBook.TabCaption[PAGE] := 'Frequency Distribution';
  with ChartBook.Charts[PAGE] do
    begin
    Reset;
    GridStyle := gsDotLines;
    GridColor := clSilver;
    ScalePropsY[1].ShortTicks := false;
    end;
  DrawDistribution (FrequDist1, clBlue, min1, (max1-min1)/NBINS, -offset);
  GetCubeLayer (ll1,1,Data);
  if FrequDistOfMatrix (Data, Mask,
                        0,0,0,0,              // LoX, LoY, HiX, HiY,
                        min1, max1,           // FirstBin, LastBin
                        (max1-min1)/NBINS,    // BinWidth,
                        FrequDist2,
                        Underflow, Overflow, MaxCnt) = 0 then
    begin
    DrawDistribution (FrequDist2, clRed, min1, (max1-min1)/NBINS, +offset);
    PerformChi2DistComp (FrequDist1, FrequDist2, Chi2, p, df, nobs, nexp);
    ChartBook.Charts[PAGE].Caption := 'Frequency Distribution of Layer '+
                                      IntToStr(ll1)+' (red) and Layer '+
                                      IntToStr(ll2)+' (blue). p = '+
                                      SigDigStr(p,12,4,true);
    ListDistributions (FrequDist1, FrequDist2);
    end;
  end;
end.


Last Update: 2018-Sep-17