GridLoader (Jzy3d API 1.0.0-SNAPSHOT API)

java.lang.Object
- org.jzy3d.maths.GridLoader

All Implemented Interfaces:

IColorMappable

Deprecated.
```
@Deprecated
public class GridLoader
extends Object
implements IColorMappable
```
The GridLoader utility offers a way to convert coordinates mode. When input data is made of lists of x, y, and z points, and that these lists actually contain data that regularly lie on a squared grid (orthonormal grid), the GridLoader allows a smart retrieving of data by providing:
- an 1D array of sorted X coordinates (without doublon).
- an 1D array of sorted Y coordinates (without doublon).
- an 2D array of Z coordinates syncronized with arrays X and Y.
If some data are missing for representing this grid, missing data will be considered as NaN. The actual management of missing values is thus left to the object that loads these data.
In the following example, the o represent a NaN Z value, meaning that there was no (x[i],y[i],z[i]) triplet for representing it correctly:
11111111 y 11111111 11o11111 11111111 x
If some points are missing in the input list to generate a complete grid, the output grid will contain Z=NaN values for missing coordinates.
Author:

Martin Pernollet

Field Summary

Fields
Modifier and Type Field and Description

float[] x
Deprecated.

float[] y
Deprecated.

float[][] z
Deprecated.

Fields
Modifier and Type	Field and Description
`float[]`	`x` Deprecated.
`float[]`	`y` Deprecated.
`float[][]`	`z` Deprecated.

Constructor Summary

Constructors
Constructor and Description

GridLoader(float[] x, float[] y, float[] z)
Deprecated.

Initialize a GridLoader by parsing the square grid directly.

Constructors
Constructor and Description
`GridLoader(float[] x, float[] y, float[] z)` Deprecated. Initialize a GridLoader by parsing the square grid directly.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`extrapolate(int n)` Deprecated. Add extrapolated points on the grid.
`BoundingBox3d`	`getBoundingBox()` Deprecated. Return a BoundingBox indicating the bounds of the loaded data.
`List<Polygon>`	`getExtrapolatedRingPolygons(float ringMax, IColorMap cmap, Color colorFactor)` Deprecated.
`List<Polygon>`	`getInterpolatedRingPolygons(float ringMin, float ringMax, IColorMap cmap, Color colorFactor)` Deprecated. Load data standing on an orthonormal grid.
`double`	`getMax()` Deprecated. Retrieve the upper value boundary for a `IColorMap`.
`double`	`getMin()` Deprecated. Retrieve the lower value boundary for a `IColorMap`.
`Vector<Polygon>`	`getSquarePolygons(IColorMap cmap, Color colorFactor)` Deprecated.
`protected void`	`setData(float[] x, float[] y, float[] z)` Deprecated. Set the array of data.
`void`	`setMax(double zmax)` Deprecated. Set the upper value boundary for a `IColorMap`.
`void`	`setMin(double zmin)` Deprecated. Set the lower value boundary for a `IColorMap`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - x
```
public float[] x
```
    Deprecated.
  - y
```
public float[] y
```
    Deprecated.
  - z
```
public float[][] z
```
    Deprecated.
- Constructor Detail
  - GridLoader
```
public GridLoader(float[] x,
                  float[] y,
                  float[] z)
```
    Deprecated.
    Initialize a GridLoader by parsing the square grid directly. When the grid is parsed, the GridLoader may return either:
    - a set of polygon describing a ring with smooth contour
- Method Detail
  - getBoundingBox
```
public BoundingBox3d getBoundingBox()
```
    Deprecated.
    
    Return a BoundingBox indicating the bounds of the loaded data.
    
    Returns:
    
    a bounding box.
  - setData
```
protected void setData(float[] x,
                       float[] y,
                       float[] z)
```
    Deprecated.
    
    Set the array of data. X,Y, and Z are arrays that must implicitely represent an orthonormal grid. If some data are missing for representing this grid, missing data will be considered as NaN. The actual management of missing values is thus left to the object that loads these data. In the following example, the o represent a NaN Z value, meaning that there was no (x[i],y[i],z[i]) triplet for representing it correctly:
    11111111 y 11111111 11o11111 11111111 x While parsing input data, the minimal and maximal Z values are computed, in order to have the loader ready for computing polygons color with a colormap.
    Parameters: x - list of x coordinates y - list of y coordinates z - list of z coordinates Throws: an - IllegalArgumentException if x, y , and z have not the same size
  getSquarePolygons public Vector<Polygon> getSquarePolygons(IColorMap cmap, Color colorFactor) Deprecated. getExtrapolatedRingPolygons public List<Polygon> getExtrapolatedRingPolygons(float ringMax, IColorMap cmap, Color colorFactor) Deprecated. extrapolate public void extrapolate(int n) Deprecated. Add extrapolated points on the grid. If the grid is too small for extrapolation, the arrays are maximized getInterpolatedRingPolygons public List<Polygon> getInterpolatedRingPolygons(float ringMin, float ringMax, IColorMap cmap, Color colorFactor) Deprecated. Load data standing on an orthonormal grid. Each input point (i.e. the association of x[i], y[j], z[i][j]) will be represented by a polygon centered on this point. The default coordinates of this polygon will be: x[i-1], y[j+1], z[i-1][j+1] x[i-1], y[j-1], z[i-1][j-1] x[i+1], y[j-1], z[i+1][j-1] x[i+1], y[j+1], z[i+1][j+1] There are thus three types of polygons: those that stand completely inside the ringMin and ringMax radius and that have the previous coordinates. those that stand completely outside the ringMin and ringMax radius and that won't be added to the list of polygons. those that have some points in and some points out of the ringMin and ringMax radius. These polygons are recomputed so that "out" points are replaced by two points that make the smooth contour. According to the number of "out" points, the modified polygon will gather 3, 4, or 5 points. As a consequence, it is suggested to provide data ranging outside of ringMin and ringMax, in order to be sure to have a perfect round surface. Parameters: ringMin - the minimum radius of this ring. ringMax - the maximum radius of this ring. colorFactor - a weighting factor for the color returned by the Colormap. getMin public double getMin() Deprecated. Description copied from interface: IColorMappable Retrieve the lower value boundary for a IColorMap. Specified by: getMin in interface IColorMappable Returns: the minimum Z value getMax public double getMax() Deprecated. Description copied from interface: IColorMappable Retrieve the upper value boundary for a IColorMap. Specified by: getMax in interface IColorMappable Returns: the maximum Z value setMin public void setMin(double zmin) Deprecated. Description copied from interface: IColorMappable Set the lower value boundary for a IColorMap. Specified by: setMin in interface IColorMappable Parameters: zmin - the minimum Z value setMax public void setMax(double zmax) Deprecated. Description copied from interface: IColorMappable Set the upper value boundary for a IColorMap. Specified by: setMax in interface IColorMappable Parameters: zmax - the maximum Z value

Class GridLoader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

x

y

z

Constructor Detail

GridLoader

Method Detail

getBoundingBox

setData

getSquarePolygons

getExtrapolatedRingPolygons

extrapolate

getInterpolatedRingPolygons

getMin

getMax

setMin

setMax