com.openinventor.ldm.readers

Class SoLDMReader

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.misc.SoBase

com.openinventor.inventor.fields.SoFieldContainer

com.openinventor.ldm.readers.SoVolumeReader

com.openinventor.ldm.readers.SoLDMReader

All Implemented Interfaces:

SafeDisposable

Direct Known Subclasses:

SoVRLdmFileReader

public class SoLDMReader
extends SoVolumeReader

Base class for LDM data set readers. This is the base class for specific LDM readers.

See SoVRLdmFileReader for a specific implementation.

This class retrieves the XML tags from an LDM header file (usually a .ldm file) that are general to all LDM files, i.e. the tags that are interpreted by VolumeViz.

Custom tags for classes derived from SoLDMReader can be retrieved by overriding the handleHeader method.

General tags common for all LDM Readers are:

 <?xml version="1.0" encoding="utf-8" ?>
 <VolumeInformation>
   <OriginalFile>3dhead.vol</OriginalFile>
   <Size> //or dimension//
     <U>256</U>
     <V>256</V>
     <W>109</W>
   </Size>
   <TileSize>
     <U>64</U>
     <V>64</V>
     <W>64</W>
   </TileSize>
   <DataType>
      <Type>n</Type><Num>m</Num>
      ...
   <DataType>
   <DataFilename>3DHEAD.dat</DataFilename>//separate datafile//
   <WordFormat>1</WordFormat>//data stored in little/big endian//
   <CompletionFilename>3dhead.fcp</CompletionFilename>//if the conversion was interrupted, refer to this file
 
   <RectilinearMapping>
    <mapping axis="U">
     <map>-180</map>
     <map>-160</map>
     ... one entry per voxel on U axis
    </mapping>
     ... repeat for V, W axis
   </RectilinearMapping>

Note that the minimum tags that MUST be in the LDM header are <Size> or <Dimension> and <TileSize>. Otherwise the reader will throw a "tag missing" exception.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoLDMReader.SoLDMErrors LDM Reader error code.

Nested classes/interfaces inherited from class com.openinventor.ldm.readers.SoVolumeReader

SoVolumeReader.Axis, SoVolumeReader.CoordinateTypes, SoVolumeReader.CopyPolicies, SoVolumeReader.DataInfo, SoVolumeReader.ReadErrors, SoVolumeReader.ReaderTypes, SoVolumeReader.SubVolumeInfo

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	LDM_ALTERNATE_FILE_NOT_FOUND Deprecated. Use SoLDMReader.SoLDMErrors.LDM_ALTERNATE_FILE_NOT_FOUND instead.
static int	LDM_COMPLETION_FILE_NOT_FOUND Deprecated. Use SoLDMReader.SoLDMErrors.LDM_COMPLETION_FILE_NOT_FOUND instead.
static int	LDM_FILE_NOT_FOUND Deprecated. Use SoLDMReader.SoLDMErrors.LDM_FILE_NOT_FOUND instead.
static int	LDM_NO_ERROR Deprecated. Use SoLDMReader.SoLDMErrors.LDM_NO_ERROR instead.
static int	LDM_RD_FILE_NOT_FOUND_ERROR Deprecated. Use SoLDMReader.SoLDMErrors.LDM_RD_FILE_NOT_FOUND_ERROR instead.
static int	LDM_RD_NO_ERROR Deprecated. Use SoLDMReader.SoLDMErrors.LDM_RD_NO_ERROR instead.
static int	LDM_RD_UNKNOWN_ERROR Deprecated. Use SoLDMReader.SoLDMErrors.LDM_RD_UNKNOWN_ERROR instead.
static int	LDM_RD_UNSUPPORTED_DATA_TYPE_ERROR Deprecated. Use SoLDMReader.SoLDMErrors.LDM_RD_UNSUPPORTED_DATA_TYPE_ERROR instead.
static int	LDM_SIZE_TAG_MISSING Deprecated. Use SoLDMReader.SoLDMErrors.LDM_SIZE_TAG_MISSING instead.
static int	LDM_XML_PARSING_ERROR Deprecated. Use SoLDMReader.SoLDMErrors.LDM_XML_PARSING_ERROR instead.
static int	LDM_XML_ROOT_END_TAG_NOT_FOUND Deprecated. Use SoLDMReader.SoLDMErrors.LDM_XML_ROOT_END_TAG_NOT_FOUND instead.
static int	LDM_XML_ROOT_START_TAG_NOT_FOUND Deprecated. Use SoLDMReader.SoLDMErrors.LDM_XML_ROOT_START_TAG_NOT_FOUND instead.

Fields inherited from class com.openinventor.ldm.readers.SoVolumeReader

AM, AVS, COORDINATES_RECTILINEAR, COORDINATES_UNIFORM, COPY, DICOM, GENERIC, LDM, MEMORY, NO_COPY, NO_READER, RASTERSTACK, RD_FILE_FORMAT_NOT_VALID_ERROR, RD_FILE_NOT_FOUND_ERROR, RD_INVALID_DATA_ERROR, RD_NO_ERROR, RD_UNKNOWN_ERROR, RD_UNSUPPORTED_DATA_TYPE_ERROR, SEGY, TIFF, VOL, VOX, X, Y, Z

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoLDMReader() Constructor.

Method Summary

Modifier and Type	Method and Description
SbBox3f	getBbox(int fileId) Returns the bounding box of the data associated with the specified file ID.
SbVec3f	getCenter(int fileId) Returns the center of the data associated with the specified file ID.
SbVec3i32	getDimension() Returns the dimension of the data.
SbBox3f	getSize() Returns the bounding box of the total data in world coordinates.
SbXmlTag	getXmlTag(java.lang.String tagName) Gets the first occurrence of the XML element whose tag name is specified by tagName.
boolean	isLittleEndian() Returns whether the bytes of the data are stored in big or little endian order.

Methods inherited from class com.openinventor.ldm.readers.SoVolumeReader

closeAllHandles, getAppropriateReader, getBorderFlag, getConfiguredWriter, getCoordinateType, getCurrentTimeStep, getDataChar, getDirectCoordSys, getDirectCoordSysAutoDetection, getDoubleMinMax, getFilename, getIntMinMax, getMinMax, getNumSignificantBits, getNumSubsampledTiles, getNumTimeSteps, getNumVoxels, getOriginalFilename, getReaderType, getShortTileSize, getSizeToAllocate, getSubSlice, getSubVolumeInfo, getTileMinMax, getTileSize, isDataConverted, isIgnoredFile, isRGBA, isThreadSafe, readTile, readTile, restoreAllHandles, setCurrentTimeStep, setDirectCoordSysAutoDetection, setDirectCoorSys, setFilename, setInputDataRange, setOutputDataType, setRectilinearCoordinates, setRGBA

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase

dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable, touch

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Field Detail

LDM_NO_ERROR

@Deprecated
public static final int LDM_NO_ERROR

Deprecated. Use SoLDMReader.SoLDMErrors.LDM_NO_ERROR instead.

LDM_FILE_NOT_FOUND

@Deprecated
public static final int LDM_FILE_NOT_FOUND

Deprecated. Use SoLDMReader.SoLDMErrors.LDM_FILE_NOT_FOUND instead.

LDM_XML_ROOT_START_TAG_NOT_FOUND

@Deprecated
public static final int LDM_XML_ROOT_START_TAG_NOT_FOUND

Deprecated. Use SoLDMReader.SoLDMErrors.LDM_XML_ROOT_START_TAG_NOT_FOUND instead.

LDM_XML_ROOT_END_TAG_NOT_FOUND

@Deprecated
public static final int LDM_XML_ROOT_END_TAG_NOT_FOUND

Deprecated. Use SoLDMReader.SoLDMErrors.LDM_XML_ROOT_END_TAG_NOT_FOUND instead.

LDM_ALTERNATE_FILE_NOT_FOUND

@Deprecated
public static final int LDM_ALTERNATE_FILE_NOT_FOUND

Deprecated. Use SoLDMReader.SoLDMErrors.LDM_ALTERNATE_FILE_NOT_FOUND instead.

LDM_XML_PARSING_ERROR

@Deprecated
public static final int LDM_XML_PARSING_ERROR

Deprecated. Use SoLDMReader.SoLDMErrors.LDM_XML_PARSING_ERROR instead.

LDM_SIZE_TAG_MISSING

@Deprecated
public static final int LDM_SIZE_TAG_MISSING

Deprecated. Use SoLDMReader.SoLDMErrors.LDM_SIZE_TAG_MISSING instead.

LDM_COMPLETION_FILE_NOT_FOUND

@Deprecated
public static final int LDM_COMPLETION_FILE_NOT_FOUND

Deprecated. Use SoLDMReader.SoLDMErrors.LDM_COMPLETION_FILE_NOT_FOUND instead.

LDM_RD_NO_ERROR

@Deprecated
public static final int LDM_RD_NO_ERROR

Deprecated. Use SoLDMReader.SoLDMErrors.LDM_RD_NO_ERROR instead.

LDM_RD_FILE_NOT_FOUND_ERROR

@Deprecated
public static final int LDM_RD_FILE_NOT_FOUND_ERROR

Deprecated. Use SoLDMReader.SoLDMErrors.LDM_RD_FILE_NOT_FOUND_ERROR instead.

LDM_RD_UNSUPPORTED_DATA_TYPE_ERROR

@Deprecated
public static final int LDM_RD_UNSUPPORTED_DATA_TYPE_ERROR

Deprecated. Use SoLDMReader.SoLDMErrors.LDM_RD_UNSUPPORTED_DATA_TYPE_ERROR instead.

LDM_RD_UNKNOWN_ERROR

@Deprecated
public static final int LDM_RD_UNKNOWN_ERROR

Deprecated. Use SoLDMReader.SoLDMErrors.LDM_RD_UNKNOWN_ERROR instead.

Constructor Detail

SoLDMReader

public SoLDMReader()

Constructor.

Method Detail

getXmlTag

public SbXmlTag getXmlTag(java.lang.String tagName)

Gets the first occurrence of the XML element whose tag name is specified by tagName. Then the associated value or subtags can be fetched using the SbXmlElement methods. Custom XML tags can be added to the LDM header file by using the method SoLDMConverter.setXmlCallback().

getCenter

public SbVec3f getCenter(int fileId)

Returns the center of the data associated with the specified file ID. If returns false, not supported.

isLittleEndian

public boolean isLittleEndian()

Returns whether the bytes of the data are stored in big or little endian order. The order is little endian if the function returns true.

getBbox

public SbBox3f getBbox(int fileId)

Returns the bounding box of the data associated with the specified file ID. The file ID corresponds to the tile ID in an LDM data file. If returns false, not supported.

getSize

public SbBox3f getSize()

Returns the bounding box of the total data in world coordinates.

getDimension

public SbVec3i32 getDimension()

Returns the dimension of the data.