VoxelSpaceIF

All Known Implementing Classes:

VoxelSpace, VoxelSpaceNode
```
public interface VoxelSpaceIF
```
Translated from orignal C++ Lignum code.

Author:

Alexander Brinkmann

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`calculateMeanQabsQin()`
`double`	`calculateTurbidLight()`
`double`	`calculateTurbidLight(boolean self_shading)`
`void`	`evaluateVerticalNeedleAreaDensity(double Hmax, double Hmin, int n, java.util.Vector<PairMinMax> NAD)`
`void`	`fillVoxelBoxes(double needleA, double leafA)`
`void`	`fillVoxelBoxes(double inivalue, int beginZ, int endZ)`
`void`	`FillVoxelBoxesWithNeedles(double Sf, double Wf, double Rf, double L, int beginZ, int endZ)`
`double`	`getArea()`
`VOBookKeeper`	`getBookKeeper()`
`double`	`getBorderStandExtinction(Point3d p0, PositionVector dir)`
`java.util.Vector<java.lang.Integer>`	`getBoxIndexes(Point3d p)`
`double`	`getBoxVolume()`
`double`	`getFoliageArea()`
`double`	`getFoliageMass()`
`ForestDescriptor`	`getForestDescriptor()`
`double`	`getK_b()`
`double`	`getLeafArea()`
`Point3d`	`getLowerLeftCorner()`
`double`	`getMeanFoliageAreaDensity()`
`PairMinMax`	`getMinMaxNeedleMass()`
`double`	`getNeedleArea()`
`int`	`getNumberOfBoxes()`
`int`	`getNumberOfFilledBoxes()`
`int`	`getNumberOfTreeSegments()`
`double`	`getQabs()`
`double`	`getQin()`
`java.util.Vector<VoxelMovement>`	`getRoute(java.util.Vector<VoxelMovement> vec, int startx, int starty, int startz, PositionVector dir)`
`java.util.Vector<VoxelMovement>`	`getRoute(java.util.Vector<VoxelMovement> vec, Point3d p0, PositionVector dir, ParametricCurve K, boolean pairwise)`
`Point3d`	`getUpperRightCorner()`
`VoxelBox`	`getVoxelBox(Point3d p)`
`double`	`getXbox()`
`int`	`getXindex(double local_xcoord)`
`double`	`getXSideLength()`
`double`	`getYbox()`
`int`	`getYindex(double local_ycoord)`
`double`	`getYSideLength()`
`double`	`getZbox()`
`int`	`getZindex(double local_zcoord)`
`double`	`getZSideLength()`
`void`	`incHitfol()`
`void`	`incHitself()`
`void`	`incHitw()`
`void`	`incNohit()`
`void`	`move(Point3d corner)`
`void`	`reset()`
`void`	`resetQinQabs()`
`void`	`resize(double lX, double lY, double lZ)`
`void`	`resize(double lX, double lY, double lZ, int nX, int nY, int nZ)`
`void`	`resize(int x, int y, int z)`
`void`	`resize(Point3d lower_left, Point3d upper_right)`
`void`	`updateBoxValues()`

Method Detail

calculateMeanQabsQin
```
void calculateMeanQabsQin()
```

calculateTurbidLight
```
double calculateTurbidLight()
```

calculateTurbidLight

double calculateTurbidLight(boolean self_shading)

evaluateVerticalNeedleAreaDensity

void evaluateVerticalNeedleAreaDensity(double Hmax,
                                     double Hmin,
                                     int n,
                                     java.util.Vector<PairMinMax> NAD)

fillVoxelBoxes

void fillVoxelBoxes(double needleA,
                  double leafA)

fillVoxelBoxes

void fillVoxelBoxes(double inivalue,
                  int beginZ,
                  int endZ)

FillVoxelBoxesWithNeedles

void FillVoxelBoxesWithNeedles(double Sf,
                             double Wf,
                             double Rf,
                             double L,
                             int beginZ,
                             int endZ)

getArea
```
double getArea()
```

getBookKeeper
```
VOBookKeeper getBookKeeper()
```

getBorderStandExtinction

double getBorderStandExtinction(Point3d p0,
                              PositionVector dir)

getBoxIndexes

java.util.Vector<java.lang.Integer> getBoxIndexes(Point3d p)

getBoxVolume
```
double getBoxVolume()
```

getFoliageArea
```
double getFoliageArea()
```

getFoliageMass
```
double getFoliageMass()
```

getForestDescriptor
```
ForestDescriptor getForestDescriptor()
```

getK_b
```
double getK_b()
```

getLeafArea
```
double getLeafArea()
```

getLowerLeftCorner
```
Point3d getLowerLeftCorner()
```

getMeanFoliageAreaDensity
```
double getMeanFoliageAreaDensity()
```

getMinMaxNeedleMass
```
PairMinMax getMinMaxNeedleMass()
```

getNeedleArea
```
double getNeedleArea()
```

getNumberOfBoxes
```
int getNumberOfBoxes()
```

getNumberOfFilledBoxes
```
int getNumberOfFilledBoxes()
```

getNumberOfTreeSegments
```
int getNumberOfTreeSegments()
```

getQabs
```
double getQabs()
```

getQin
```
double getQin()
```

getRoute

java.util.Vector<VoxelMovement> getRoute(java.util.Vector<VoxelMovement> vec,
                                       int startx,
                                       int starty,
                                       int startz,
                                       PositionVector dir)

getRoute

java.util.Vector<VoxelMovement> getRoute(java.util.Vector<VoxelMovement> vec,
                                       Point3d p0,
                                       PositionVector dir,
                                       ParametricCurve K,
                                       boolean pairwise)

getUpperRightCorner
```
Point3d getUpperRightCorner()
```

getVoxelBox
```
VoxelBox getVoxelBox(Point3d p)
```

getXbox
```
double getXbox()
```

getXindex
```
int getXindex(double local_xcoord)
```

getXSideLength
```
double getXSideLength()
```

getYbox
```
double getYbox()
```

getYindex
```
int getYindex(double local_ycoord)
```

getYSideLength
```
double getYSideLength()
```

getZbox
```
double getZbox()
```

getZindex
```
int getZindex(double local_zcoord)
```

getZSideLength
```
double getZSideLength()
```

incHitfol
```
void incHitfol()
```

incHitself
```
void incHitself()
```

incHitw
```
void incHitw()
```

incNohit
```
void incNohit()
```

move
```
void move(Point3d corner)
```

reset
```
void reset()
```

resetQinQabs
```
void resetQinQabs()
```

resize

void resize(double lX,
          double lY,
          double lZ)

resize

void resize(double lX,
          double lY,
          double lZ,
          int nX,
          int nY,
          int nZ)

resize

void resize(int x,
          int y,
          int z)

resize

void resize(Point3d lower_left,
          Point3d upper_right)

updateBoxValues
```
void updateBoxValues()
```

Interface VoxelSpaceIF

Method Summary

Method Detail

calculateMeanQabsQin

calculateTurbidLight

calculateTurbidLight

evaluateVerticalNeedleAreaDensity

fillVoxelBoxes

fillVoxelBoxes

FillVoxelBoxesWithNeedles

getArea

getBookKeeper

getBorderStandExtinction

getBoxIndexes

getBoxVolume

getFoliageArea

getFoliageMass

getForestDescriptor

getK_b

getLeafArea

getLowerLeftCorner

getMeanFoliageAreaDensity

getMinMaxNeedleMass

getNeedleArea

getNumberOfBoxes

getNumberOfFilledBoxes

getNumberOfTreeSegments

getQabs

getQin

getRoute

getRoute

getUpperRightCorner

getVoxelBox

getXbox

getXindex

getXSideLength

getYbox

getYindex

getYSideLength

getZbox

getZindex

getZSideLength

incHitfol

incHitself

incHitw

incNohit

move

reset

resetQinQabs

resize

resize

resize

resize

updateBoxValues