loci.formats.in

Class SPCReader

java.lang.Object

loci.formats.FormatHandler

loci.formats.FormatReader

loci.formats.in.SPCReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, IFormatHandler, IFormatReader, IMetadataConfigurable, IPyramidHandler

public class SPCReader
extends FormatReader

SPCReader is the file format reader for Becker & Hickl SPC-Image SPC FIFO files.

Author:

Ian i.munro at imperial.ac.uk Ported from Matlab code kindly provided by ulorenzo at ikasle.ehu.eus. This format is documented in the TCSPC Handbook available from http://www.becker-hickl.com/handbookphp.htm See Page 675 FIFO Data Files (SPC-134, SPC-144, SPC-154, SPC-830). Note that this code assumes the presence of pixel clock events and therefore the MacroTime information is not used.

Field Summary

Fields

Modifier and Type	Field and Description
private int	adcResShift
private java.util.ArrayList<java.lang.String>	allFiles List of all files to open
private int	binSize
private int	bpp
protected int	bufLength
private int	channel
private int	currentFrame
private int	currentLine
private int	currentPixel
private boolean	endOfFrameFlag
(package private) java.util.List<java.lang.Integer>	endOfFrameList
(package private) java.util.List<java.lang.Integer>	frameClockList
private boolean	lineMode
private int	nBuffers
protected int	nChannels Number of spectral nChannels.
private int	nFrames
private int	nLines
private int	nPixels
protected int	nTimebins Number of time bins in lifetime histogram.
protected byte[]	rawBuf
private java.lang.String	spcId
protected int	storedChannel
protected int	storedT
static java.lang.String	TAC_GAIN
static java.lang.String	TAC_RANGE
protected byte[]	Tstore
(package private) java.nio.ByteBuffer	tstoreb

Fields inherited from class loci.formats.FormatReader

core, coreIndex, datasetDescription, domains, filterMetadata, flattenedResolutions, group, hasCompanionFiles, in, indexedAsRGB, metadata, metadataStore, normalizeData, resolution, saveOriginalMetadata, series, suffixNecessary, suffixSufficient, THUMBNAIL_DIMENSION

Fields inherited from class loci.formats.FormatHandler

COMPRESSION_SUFFIXES, currentId, format, LOGGER, metadataOptions, suffixes

Fields inherited from interface loci.formats.IFormatReader

CAN_GROUP, CANNOT_GROUP, MUST_GROUP

Constructor Summary

Constructors

Constructor and Description
SPCReader() Constructs a new SPC reader.

Method Summary

Modifier and Type	Method and Description
void	close(boolean fileOnly) Closes the currently open file.
int	fileGroupOption(java.lang.String id) Returns an indication of whether the files in a multi-file dataset can be handled individually.
java.lang.String[]	getSeriesUsedFiles(boolean noPixels) Returns an array of filenames needed to open the current series.
protected void	initFile(java.lang.String id) Initializes the given file (parsing header information, etc.).
private void	invalidAndMark(int blockPtr)
private void	invalidAndMarkInit(int blockPtr)
boolean	isSingleFile(java.lang.String id) Returns true if the named file is expected to be the only file in the dataset.
boolean	isThisType(java.lang.String name, boolean open) Checks if a file matches the type of this format reader.
byte[]	openBytes(int no, byte[] buf, int x, int y, int w, int h) Obtains a sub-image of the specified image plane into a pre-allocated byte array.
private double	parseSetup(java.lang.String tag, java.lang.String setup)
private void	photon(int blockPtr)
private void	processBuffer(int noOfBytes)
void	reopenFile() Reopen any files that were closed, and which are expected to be open while the reader is open.

Methods inherited from class loci.formats.FormatReader

addGlobalMeta, addGlobalMeta, addGlobalMeta, addGlobalMeta, addGlobalMeta, addGlobalMeta, addGlobalMeta, addGlobalMeta, addGlobalMeta, addGlobalMetaList, addMeta, addMetaList, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMeta, addSeriesMetaList, close, coreIndexToSeries, flattenHashtables, get16BitLookupTable, get8BitLookupTable, getAcquisitionMode, getAdvancedSeriesUsedFiles, getAdvancedUsedFiles, getArcType, getAvailableOptions, getBinning, getBitsPerPixel, getCompression, getContrastMethod, getCoreIndex, getCoreMetadataList, getCorrection, getCurrentCore, getCurrentFile, getDatasetStructureDescription, getDetectorType, getDimensionOrder, getDimensionOrder, getDomains, getEffectiveSizeC, getExperimentType, getFilamentType, getFillRule, getFilterType, getFontFamily, getFontStyle, getGlobalMeta, getGlobalMetadata, getIlluminationType, getImageCount, getImmersion, getIndex, getIndex, getLaserMedium, getLaserType, getMarker, getMedium, getMetadataStore, getMetadataStoreRoot, getMetadataValue, getMicrobeamManipulationType, getMicroscopeType, getModuloC, getModuloT, getModuloZ, getNamingConvention, getOptimalTileHeight, getOptimalTileWidth, getPixelType, getPixelType, getPossibleDomains, getPulse, getRequiredDirectories, getResolution, getResolutionCount, getRGBChannelCount, getRotationTransform, getSeries, getSeriesCount, getSeriesMeta, getSeriesMetadata, getSeriesMetadataValue, getSeriesUsedFiles, getSizeC, getSizeT, getSizeX, getSizeY, getSizeZ, getThumbSizeX, getThumbSizeY, getUnderlyingReaders, getUsedFiles, getUsedFiles, getZCTCoords, getZCTModuloCoords, hasCompanionFiles, hasFlattenedResolutions, isFalseColor, isGroupFiles, isIndexed, isInterleaved, isInterleaved, isLittleEndian, isMetadataComplete, isMetadataFiltered, isNormalized, isOrderCertain, isOriginalMetadataPopulated, isRGB, isThisType, isThisType, isThisType, isThumbnailSeries, isUsedFile, makeFilterMetadata, openBytes, openBytes, openBytes, openPlane, openThumbBytes, readPlane, readPlane, readPlane, seriesToCoreIndex, setCoreIndex, setFlattenedResolutions, setGroupFiles, setId, setMetadataFiltered, setMetadataStore, setNormalized, setOriginalMetadataPopulated, setResolution, setSeries, updateMetadataLists

Methods inherited from class loci.formats.FormatHandler

checkSuffix, checkSuffix, getFormat, getMetadataOptions, getNativeDataType, getSuffixes, getSupportedMetadataLevels, setMetadataOptions

Methods inherited from class java.lang.Object

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

Methods inherited from interface loci.formats.IFormatHandler

getFormat, getNativeDataType, getSuffixes

Methods inherited from interface loci.formats.IMetadataConfigurable

getMetadataOptions, getSupportedMetadataLevels, setMetadataOptions

Field Detail

TAC_RANGE

public static final java.lang.String TAC_RANGE

See Also:

Constant Field Values

TAC_GAIN

public static final java.lang.String TAC_GAIN

See Also:

Constant Field Values

adcResShift

private final int adcResShift

See Also:

Constant Field Values

allFiles

private java.util.ArrayList<java.lang.String> allFiles

List of all files to open

nTimebins

protected int nTimebins

Number of time bins in lifetime histogram.

nChannels

protected int nChannels

Number of spectral nChannels.

Tstore

protected byte[] Tstore

tstoreb

java.nio.ByteBuffer tstoreb

storedChannel

protected int storedChannel

storedT

protected int storedT

currentPixel

private int currentPixel

currentLine

private int currentLine

currentFrame

private int currentFrame

bufLength

protected int bufLength

rawBuf

protected byte[] rawBuf

nBuffers

private int nBuffers

nLines

private int nLines

nFrames

private int nFrames

nPixels

private int nPixels

endOfFrameFlag

private boolean endOfFrameFlag

bpp

private int bpp

binSize

private int binSize

channel

private int channel

frameClockList

java.util.List<java.lang.Integer> frameClockList

endOfFrameList

java.util.List<java.lang.Integer> endOfFrameList

lineMode

private boolean lineMode

spcId

private java.lang.String spcId

Constructor Detail

SPCReader

public SPCReader()

Constructs a new SPC reader.

Method Detail

isSingleFile

public boolean isSingleFile(java.lang.String id)
                     throws FormatException,
                            java.io.IOException

Description copied from interface: IFormatReader

Returns true if the named file is expected to be the only file in the dataset. For single-file formats, always returns true.

Specified by:

isSingleFile in interface IFormatReader

Overrides:

isSingleFile in class FormatReader

Throws:

FormatException

java.io.IOException

fileGroupOption

public int fileGroupOption(java.lang.String id)
                    throws FormatException,
                           java.io.IOException

Description copied from interface: IFormatReader

Returns an indication of whether the files in a multi-file dataset can be handled individually. This method is only useful for formats and datasets which contain multiple files.

Specified by:

fileGroupOption in interface IFormatReader

Overrides:

fileGroupOption in class FormatReader

Parameters:

id - a file in the multi-file dataset

Returns:

an int indicating that we cannot, must, or might group the files. A return value of FormatTools.MUST_GROUP indicates that the files cannot be handled separately; the reader will always detect and read all files in the dataset. FormatTools.CAN_GROUP indicates that the files may be handled separately, but file grouping must then be disabled via IFormatReader.setGroupFiles(boolean). FormatTools.CANNOT_GROUP indicates that the files must be handled separately; the reader will not attempt to read all files in the dataset (this is rare).

Throws:

FormatException

java.io.IOException

See Also:

FormatTools.MUST_GROUP, FormatTools.CAN_GROUP, FormatTools.CANNOT_GROUP

isThisType

public boolean isThisType(java.lang.String name,
                          boolean open)

Description copied from class: FormatReader

Checks if a file matches the type of this format reader. Checks filename suffixes against those known for this format. If the suffix check is inconclusive and the open parameter is true, the file is opened and tested with FormatReader.isThisType(RandomAccessInputStream).

Specified by:

isThisType in interface IFormatReader

Overrides:

isThisType in class FormatReader

open - If true, and the file extension is insufficient to determine the file type, the (existing) file is opened for further analysis.

getSeriesUsedFiles

public java.lang.String[] getSeriesUsedFiles(boolean noPixels)

Description copied from interface: IFormatReader

Returns an array of filenames needed to open the current series. If the 'noPixels' flag is set, then only files that do not contain pixel data will be returned. The first element in the array is expected to be the path passed to IFormatHandler.setId(String), if appropriate based upon 'noPixels'. The remaining elements are expected to be in a consistent order; if a directory listing is necessary to build the list then it should be sorted first.

Specified by:

getSeriesUsedFiles in interface IFormatReader

Overrides:

getSeriesUsedFiles in class FormatReader

reopenFile

public void reopenFile()
                throws java.io.IOException

Description copied from interface: IFormatReader

Reopen any files that were closed, and which are expected to be open while the reader is open. This assumes that IFormatHandler.setId(java.lang.String) has been called, but close(false) has not been called.

Specified by:

reopenFile in interface IFormatReader

Overrides:

reopenFile in class FormatReader

Throws:

java.io.IOException

openBytes

public byte[] openBytes(int no,
                        byte[] buf,
                        int x,
                        int y,
                        int w,
                        int h)
                 throws FormatException,
                        java.io.IOException

Description copied from interface: IFormatReader

Obtains a sub-image of the specified image plane into a pre-allocated byte array.

Specified by:

openBytes in interface IFormatReader

Specified by:

openBytes in class FormatReader

Parameters:

no - the plane index within the current series.

buf - a pre-allocated buffer.

x - X coordinate of the upper-left corner of the sub-image

y - Y coordinate of the upper-left corner of the sub-image

w - width of the sub-image

h - height of the sub-image

Returns:

the pre-allocated buffer buf for convenience.

Throws:

FormatException - if there was a problem parsing the metadata of the file.

java.io.IOException - if there was a problem reading the file.

See Also:

IFormatReader.openBytes(int, byte[], int, int, int, int)

close

public void close(boolean fileOnly)
           throws java.io.IOException

Description copied from interface: IFormatReader

Closes the currently open file. If the flag is set, this is all that happens; if unset, it is equivalent to calling Closeable.close().

Specified by:

close in interface IFormatReader

Overrides:

close in class FormatReader

Throws:

java.io.IOException

initFile

protected void initFile(java.lang.String id)
                 throws FormatException,
                        java.io.IOException

Description copied from class: FormatReader

Initializes the given file (parsing header information, etc.). Most subclasses should override this method to perform initialization operations such as parsing metadata.

Overrides:

initFile in class FormatReader

Throws:

FormatException - if a parsing error occurs processing the file.

java.io.IOException - if an I/O error occurs processing the file

processBuffer

private void processBuffer(int noOfBytes)

invalidAndMark

private void invalidAndMark(int blockPtr)

invalidAndMarkInit

private void invalidAndMarkInit(int blockPtr)

photon

private void photon(int blockPtr)

parseSetup

private double parseSetup(java.lang.String tag,
                          java.lang.String setup)