hdeco: Hierarchical DECOmposition Analysis Environment

Description

A flexible data model and analysis environment for comparing categorical maps. Using information theory, differences between (or among) maps are computed along trajectories as either space or colours are decomposed from coarse to fine aggregations.

Usage

hdeco(BE1 = demoimage1, BE2 = demoimage2, MICIKE = decomppath, MSK = FALSE, MASK = NULL, fnev = "", AutoDecoPath = FALSE, JPG = FALSE, zsir = FALSE, MULTIX = FALSE, RECODEX = FALSE, NXRECODES = 1, LUTX = NULL, RECODEZ = FALSE, NZRECODES = 1, LUTZ = NULL, HISTOGRAM = FALSE, Z1DROP = FALSE, OMITX1 = FALSE, PS = FALSE)

Arguments

BE1

Required: Input categorical map 1 matrix object.

BE2

Input categorical map 2 matrix object (Required if comparing BE1 to BE2).

MICIKE

Required: The decomposition path definition matrix.

MSK

Boolean: TRUE if automatic filtering of zero values is to take place, otherwise FALSE

MASK

If a mask is to be applied, enter the object name.

fnev

ASCII filename to where text results are to be written. If NULL, results are displayed in the command window.

AutoDecoPath

Boolean: if TRUE, a default decomposition path is used - use extreme caution, this is not recommended!

JPG

Boolean: TRUE if graphic results are to be saved in JPEG format, otherwise FALSE to have graphics only displayed in a graphics window.

zsir

Outdated and should be removed in a subsequent version - ignore.

MULTIX

Boolean: TRUE if multiple X-variables will be used, otherwise FALSE.

RECODEX

Boolean: TRUE if X-variables will be recoded.

NXRECODES

Integer: Number of X-variables recodes will be provided by the lookup table.

LUTX

Lookup table for recoding X-variables.

RECODEZ

Boolean: TRUE if Z-variables will be recoded, otherwise FALSE.

NZRECODES

Integer: Indicate how many Z-variable recodes will be provided by the lookup table.

LUTZ

Lookup table for recoding Z-variables.

HISTOGRAM

Boolean: TRUE if histograms of the map(s) are to be drawn, otherwise FALSE.

Z1DROP

Boolean: TRUE if the Z1-variable is to be dropped from the multidimensional array construction. If the Z-variable is recoded and the original data (Z1) are not required, dropping this variable can save considerable space and processing time.

OMITX1

Boolean: TRUE if the X1-variable is to be dropped from the multidimensional array construction. If the Z-variable is recoded and the original data (Z1) are not required, dropping this variable can save considerable space and processing time.

Bolean: TRUE if Postscript versions of the graphics are to be generated, otherwise FALSE.

Value

.NThe cardinality of map and spatial decompositions.
.QNDThe cardinality vector for the specified decomposition.
.QKEPThe multi-dimensional array of probabilities.
.VFONALThe decomposition pathway matrix used in the latest run of HDECO.
.MASKTITLEThe name of the mask used, if specified by the cim attribute.
.CIMThe name of the image(s) processed, if specified by the cim attribute(s).
.COLOURSThe total number of colours entering the HDECO algorithm.
.LUT.XThe lookup table for the X variable(s) if used; otherwise NULL.
.LUT.ZThe lookup table for the Z variable(s) if used; otherwise NULL.
.BASEThe base hypotheses - all X, Y, and Z variables entering the analysis.
.HPROFILThe primary output of hdeco used for producing graphical spectra. The columns represent the joint entropy between null and alternate hypotheses (HALAPF), the entropy of the null hypothesis (HNULL), the entropy of the alternate hypothesis (HALT), the mutual information between the null and alternate hypotheses (MUTU), and the uncertainty coefficient (UNC). Additionally, the G-squared statistic, it's significance value, an indication (SING-MULT=1,2) as to whether the decomposition was for a single or multiple images, and a flag that determines log file phrase selection (DESC=1,2) reflecting either single or multiple image decomposition.
.AHIPOThe alternate hypotheses at each decomposition step - the X, Y, and Z variables comprising the alternate hypotheses.
.NHIPOThe null hypotheses at each decomposition step - the X, Y, and Z variables comprising the null hypotheses.
.KIVALOThe conditional alternate hypotheses identified at each step of the decomposition. These are identified by the integer '2' in the decomposition pathway matrix.

Details

Graphical results are returned to the graphics window, a series of tabular results are stored as hidden objects. To view a listing of these hidden objects, use the provided function ls.().

Examples

Run this code

data(demoimage1)
data(demoimage2)
data(decomppath)
hdeco(BE1=demoimage1, BE2=demoimage2, MICIKE=decomppath)

Run the code above in your browser using DataLab