Package loci.formats.dicom

Class DicomFileInfo

java.lang.Object

loci.formats.dicom.DicomFileInfo

All Implemented Interfaces:

Comparable<DicomFileInfo>

public class DicomFileInfo
extends Object
implements Comparable<DicomFileInfo>

Structure containing metadata for one DICOM file (instance).

Field Summary

Fields

Modifier and Type	Field	Description
List<String>	channelNames
int	concatenationIndex
loci.formats.CoreMetadata	coreMetadata
boolean	edf
String	file
String	imageType
Length	pixelSizeX
Length	pixelSizeY
Length	pixelSizeZ
List<Double>	positionX
List<Double>	positionY
List<Double>	positionZ
List<DicomTile>	tiles
Timestamp	timestamp
List<Double>	zOffsets

Constructor Summary

Constructors

Constructor	Description
DicomFileInfo()	Construct an empty object to be populated later.
DicomFileInfo(String filePath)	Construct an object from the given file.

Method Summary

Modifier and Type	Method	Description
int	compareTo(DicomFileInfo info)

Methods inherited from class java.lang.Object

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

Field Details

coreMetadata

public loci.formats.CoreMetadata coreMetadata

file

public String file

concatenationIndex

public int concatenationIndex

tiles

public List<DicomTile> tiles

imageType

public String imageType

zOffsets

public List<Double> zOffsets

edf

public boolean edf

timestamp

public Timestamp timestamp

pixelSizeX

public Length pixelSizeX

pixelSizeY

public Length pixelSizeY

pixelSizeZ

public Length pixelSizeZ

positionX

public List<Double> positionX

positionY

public List<Double> positionY

positionZ

public List<Double> positionZ

channelNames

public List<String> channelNames

Constructor Details

DicomFileInfo

public DicomFileInfo()

Construct an empty object to be populated later.

DicomFileInfo

public DicomFileInfo(String filePath)
              throws loci.formats.FormatException,
IOException

Construct an object from the given file. A DicomReader will be used to initialize the file and extract metadata.

Parameters:

filePath - DICOM file

Throws:

loci.formats.FormatException - if file initialization fails

IOException - if file initialization fails

Method Details

compareTo

public int compareTo(DicomFileInfo info)

Specified by:

compareTo in interface Comparable<DicomFileInfo>