no.petroware.logio.xtf

Class XtfFileReader

java.lang.Object

no.petroware.logio.xtf.XtfFileReader

public final class XtfFileReader
extends Object

Class for reading XTF survey files.

Typical usage:

   XtfFileReader reader = new XtfFileReader(new File("path/to/file.XTF"));
   XtfFile xtfFile = reader.read(true);
   

If the curve data is not needed, it is possible to read only the metadata from the disk file. The curve data may be filled in later:

   XtfFileReader reader = new XtfFileReader(new File("path/to/file.XTF"));
   XtfFile xtfFile = reader.read(false);
   :
   reader.readData(xtfFile);
   

Note that even if only metadata is read, all sub-files and curve information are properly established as this information comes from metadata. Only the curve values will be missing.

Author:

Petroware AS

Constructor Summary

Constructors

Constructor and Description
XtfFileReader(File file) Create a XTF file reader for the specified disk file.
XtfFileReader(InputStream inputStream) Create a XTF file reader for the specified stream.

Method Summary

Modifier and Type	Method and Description
static double	isXtfFile(File file, byte[] content) Get the probability that the specified file is an XTF file.
XtfFile	read(boolean shouldReadBulkData) Read the XTF file from the disk file of this reader.
void	readData(XtfFile xtfFile) Read curve data from an XTF files where the meta data has already been read.

Methods inherited from class java.lang.Object

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

Constructor Detail

XtfFileReader

public XtfFileReader(InputStream inputStream)

Create a XTF file reader for the specified stream.

Parameters:

inputStream - Stream to read. Non-null.

Throws:

IllegalArgumentException - If inputStream is null.

XtfFileReader

public XtfFileReader(File file)

Create a XTF file reader for the specified disk file.

Parameters:

file - Disk file to read. Non-null.

Throws:

IllegalArgumentException - If file is null.

Method Detail

isXtfFile

public static double isXtfFile(File file,
                               byte[] content)

Get the probability that the specified file is an XTF file.

The check can be done with or without considering the content of the file. In the latter case, only the file name (typically its extension) is considered. In the former case a portion from the start of the file is used to match for known patterns. By passing the portion as an argument, the client code can read this once and then pass it to different classifiers in order to determine its most likely type.

Getting a portion of a file can be done by:

   File file = ...;
   BufferedInputStream stream = new BufferedInputStream(new FileInputStream(file));
   byte[] content = new byte[2000];
   stream.read(content, 0, content.length);
   stream.close();
   

Parameters:

file - File to check. Null to classify on content only.

content - A number of bytes from the start of the file. Null to classify on file name only.

Returns:

Probability that the file is an XTF file. [0.0,1.0].

Throws:

IllegalArgumentException - If file is null.

readData

public void readData(XtfFile xtfFile)
              throws IOException

Read curve data from an XTF files where the meta data has already been read. This will preserve the existing XtfFile structure in case the XTF file is read in two operations:

   // Read meta data
   XtfFile xtfFile = reader.read(false);

   // Read the curve data
   reader.readData(xtfFile);
   

There is nothing to gain in performance with this approach so in case the result is not cached, the following will be equivalent:

   // Read meta data
   XtfFile xtfFile = reader.read(false);

   // Read mate-data and curve data
   xtfFile = reader.read(true);
   

Parameters:

xtfFile - XTF file to populate with curve data.

Throws:

IllegalArgumentException - If xtfFile is null.

IOException - If the read operation fails for some reason.

read

public XtfFile read(boolean shouldReadBulkData)
             throws IOException

Read the XTF file from the disk file of this reader.

Parameters:

shouldReadBulkData - Indicate if bulk data should be read. False to read header information only.

Returns:

The XTF file read.

Throws:

IOException - If the read operation fails for some reason.