repicea.stats.data

Class GenericHierarchicalSpatialDataStructure

java.lang.Object

repicea.stats.data.GenericStatisticalDataStructure

repicea.stats.data.GenericHierarchicalStatisticalDataStructure

repicea.stats.data.GenericHierarchicalSpatialDataStructure

All Implemented Interfaces:

HierarchicalSpatialDataStructure, HierarchicalStatisticalDataStructure, StatisticalDataStructure

public class GenericHierarchicalSpatialDataStructure
extends GenericHierarchicalStatisticalDataStructure
implements HierarchicalSpatialDataStructure

This class is the basic class for a hierarchical and spatial data structure.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	angleCalculated
protected java.util.Map<java.lang.Integer,java.util.Map<java.lang.Integer,Matrix>>	angleMap
protected boolean	distanceCalculated
protected java.util.List<java.lang.String>	distanceFields
protected java.util.Map<java.lang.Integer,java.util.Map<java.lang.Integer,java.lang.Double>>	distanceMap

Fields inherited from class repicea.stats.data.GenericHierarchicalStatisticalDataStructure

hierarchicalStructure, matricesZ, randomEffectsSpecifications

Fields inherited from class repicea.stats.data.GenericStatisticalDataStructure

dataSet, isInterceptModel, matrixX, vectorY

Constructor Summary

Constructors

Constructor and Description
GenericHierarchicalSpatialDataStructure(DataSet dataSet) General constructor.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.Integer,java.util.Map<java.lang.Integer,Matrix>>	getAngleBetweenObservations() This method returns the angle map between the observations.
protected Matrix	getAnglesBetweenObservations(int indexA, int indexB)
protected double	getDistanceBetweenObservations(int indexA, int indexB) This method computes the Euclidian distance between two observations regardless of the dimensions.
java.util.Map<java.lang.Integer,java.util.Map<java.lang.Integer,java.lang.Double>>	getDistancesBetweenObservations() This method returns the distance map between the observations.
void	setDistanceFields(java.util.List<java.lang.String> fields) This method sets the distance field names.

Methods inherited from class repicea.stats.data.GenericHierarchicalStatisticalDataStructure

constructMatrices, getHierarchicalStructure, getHierarchicalStructureLevel, getMatrixZ, isThereAnyHierarchicalStructure, recordRandomEffects, setHierarchicalStructureLevel, setRandomEffectStructure

Methods inherited from class repicea.stats.data.GenericStatisticalDataStructure

computeDummyVariables, getDataSet, getMatrixX, getNumberOfObservations, getVectorY, isInterceptModel, setInterceptModel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface repicea.stats.data.HierarchicalStatisticalDataStructure

getHierarchicalStructure, getHierarchicalStructureLevel, getMatrixZ, isThereAnyHierarchicalStructure, setHierarchicalStructureLevel

Methods inherited from interface repicea.stats.data.StatisticalDataStructure

constructMatrices, getDataSet, getMatrixX, getNumberOfObservations, getVectorY, isInterceptModel, setInterceptModel

Field Detail

distanceMap

protected java.util.Map<java.lang.Integer,java.util.Map<java.lang.Integer,java.lang.Double>> distanceMap

distanceFields

protected java.util.List<java.lang.String> distanceFields

distanceCalculated

protected boolean distanceCalculated

angleMap

protected java.util.Map<java.lang.Integer,java.util.Map<java.lang.Integer,Matrix>> angleMap

angleCalculated

protected boolean angleCalculated

Constructor Detail

GenericHierarchicalSpatialDataStructure

public GenericHierarchicalSpatialDataStructure(DataSet dataSet)

General constructor. To be implemented in derived class.

Parameters:

dataSet - a DataSet instance

Method Detail

setDistanceFields

public void setDistanceFields(java.util.List<java.lang.String> fields)

Description copied from interface: HierarchicalSpatialDataStructure

This method sets the distance field names.

Specified by:

setDistanceFields in interface HierarchicalSpatialDataStructure

Parameters:

fields - a List that contains the names of the fields that serve to compute the Euclidian distance

getDistancesBetweenObservations

public java.util.Map<java.lang.Integer,java.util.Map<java.lang.Integer,java.lang.Double>> getDistancesBetweenObservations()

Description copied from interface: HierarchicalSpatialDataStructure

This method returns the distance map between the observations. The keys represent the observation index, whereas the double is the distance.

Specified by:

getDistancesBetweenObservations in interface HierarchicalSpatialDataStructure

Returns:

a Map instance

getAngleBetweenObservations

public java.util.Map<java.lang.Integer,java.util.Map<java.lang.Integer,Matrix>> getAngleBetweenObservations()

Description copied from interface: HierarchicalSpatialDataStructure

This method returns the angle map between the observations. The keys represent the observation index, whereas the double is the angle in radians.

Specified by:

getAngleBetweenObservations in interface HierarchicalSpatialDataStructure

Returns:

a Map instance

getAnglesBetweenObservations

protected Matrix getAnglesBetweenObservations(int indexA,
                                              int indexB)

getDistanceBetweenObservations

protected double getDistanceBetweenObservations(int indexA,
                                                int indexB)

This method computes the Euclidian distance between two observations regardless of the dimensions.

Parameters:

indexA - the index of the first observation

indexB - the index of the second observation

Returns:

a double the Euclidian distance