gkdtree

Class FileNode<T>

java.lang.Object

gkdtree.FileNode<T>

Type Parameters:

T -

public class FileNode<T>
extends java.lang.Object

The File-Node class handles file save and load operations. If a file does not fit into the main memory, the file load is handled in subsequent load steps. The File-Node is part of a Quad/Octree structure if the data is too large to fit into main memory. The generic parameter T is for the data values (e.g. every point inside the data is of type Short). Storage data-structure: - File: header: - dimension d - d * size (only valid for original file) - Corresponding File-Class: - file-name - lower/upper bounds - size General comments: - Loads a single file and its partitions - Sometimes only a subset of points contained within a FileNode is required. In case of selecting a boundary inside the spatial dimension with limited domain (e.g. only consider values between 1 and 10). - (A file-node is a dimension smaller if one value is stored at every data point.) Ideas during implementation: - blurring a vector-field

Author:

DarkMatt

Field Summary

Fields

Modifier and Type	Field and Description
Boundary	b Boundaries of the data.
int	current_file_part_load The current part of the file loaded.
int	dimension Dimensionality of the data in its spatial extent.
java.lang.String	filename The full file-name.
int	left_child Left child of the file-octree structure.
static int	MAX_ARRAY_SIZE The maximum size that can fit into main memory.
int[]	offset
int	partition_count Number of partitions required to read the file.
int	right_child Right child of the file-octree structure.

Constructor Summary

Constructors

Constructor and Description
FileNode(java.lang.String filename, int level, int index, Boundary b, java.lang.Class<T> type) A file-node is initialized with a relative but complete path name.

Method Summary

Methods

Modifier and Type	Method and Description
void	closeLoadFile() Closes the current file load.
void	closeWriteFile() Closes the currently opened file, which was used for a file write.
void	createFile() Method to create an empty file with the specified filename.
int	get_number_of_values()
T[]	getSingleFile() Reads a single file.
void	initFileLoad() Initializes a file load.
void	initFileWrite(int[] data_size) Initializes a file-write.
T[]	loadNextFilePart() Loads an array of data of type T from the currently opened file.
static void	setReadBufferSize(int in)
void	setSingleFile(T[] data) Sets a leaf node to the data input array.
void	writeNextFilePart(short data) Writes a single element to the currently opened file.
void	writeNextFilePart(short[] data, int size) Writes a data block to the opened file.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_ARRAY_SIZE

public static final int MAX_ARRAY_SIZE

The maximum size that can fit into main memory. (needs to be: data-size = i * MAX_ARRAY_SIZE)

See Also:

Constant Field Values

filename

public java.lang.String filename

The full file-name.

b

public Boundary b

Boundaries of the data. When loading a file, the original

left_child

public int left_child

Left child of the file-octree structure.

right_child

public int right_child

Right child of the file-octree structure.

dimension

public int dimension

Dimensionality of the data in its spatial extent. This is the overall dimensionality - 1. (If one value is stored at every grid point.)

partition_count

public int partition_count

Number of partitions required to read the file.

current_file_part_load

public int current_file_part_load

The current part of the file loaded. This is reset on init-load.

offset

public int[] offset

Constructor Detail

FileNode

public FileNode(java.lang.String filename,
        int level,
        int index,
        Boundary b,
        java.lang.Class<T> type)

A file-node is initialized with a relative but complete path name. The level (depth) inside the tree and an index going from the left most element to the right one. A boundary defines the extent of the data and the type of the data is defined with the type parameter.

Parameters:

filename -

level -

index -

b -

type -

Method Detail

setReadBufferSize

public static void setReadBufferSize(int in)

createFile

public void createFile()

Method to create an empty file with the specified filename.

initFileWrite

public void initFileWrite(int[] data_size)

Initializes a file-write. After initializing a file write, multiple data-block can be written to the opened file. (The final size is unknown at this point.)

Parameters:

data_size -

writeNextFilePart

public void writeNextFilePart(short[] data,
                     int size)

Writes a data block to the opened file. (If there is no opened file an exception is thrown.)

Parameters:

data -

size -

writeNextFilePart

public void writeNextFilePart(short data)

Writes a single element to the currently opened file.

Parameters:

data -

closeWriteFile

public void closeWriteFile()

Closes the currently opened file, which was used for a file write.

initFileLoad

public void initFileLoad()

Initializes a file load. Reads the data size and allows successive loading of file chunks.

loadNextFilePart

public T[] loadNextFilePart()

Loads an array of data of type T from the currently opened file. In addition the offset parameter defines the current starting point inside the array as an n-dimensional position. The size of the output is always the maximal size, except for the last read which may be smaller.

Returns:

T[]

closeLoadFile

public void closeLoadFile()

Closes the current file load.

getSingleFile

public T[] getSingleFile()

Reads a single file. This is only possible for leaf nodes. Otherwise the data may not fit into memory.

Returns:

T[]

setSingleFile

public void setSingleFile(T[] data)

Sets a leaf node to the data input array.

Parameters:

data -

get_number_of_values

public int get_number_of_values()