Package org.anchoranalysis.image.io.bean.stack.metadata.reader

Class FromStackReader

Object

AnchorBean<ImageMetadataReader>

ImageMetadataReader

FromStackReader

public class FromStackReader
extends ImageMetadataReader

Uses a StackReader to read the image-metadata.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
FromStackReader()
FromStackReader(StackReader stackReader)	Create from a StackReader.

Method Summary

Modifier and Type	Method	Description
int	getSeriesIndex()	The series to open to the read the metadata (zero-indexed).
StackReader	getStackReader()	The StackReader to use to read the image metadata.
ImageMetadata	openFile(Path path, StackReader defaultStackReader, OperationContext context)	Opens a file containing one or more images but does not read an image.
void	setSeriesIndex(int seriesIndex)	The series to open to the read the metadata (zero-indexed).
void	setStackReader(StackReader stackReader)	The StackReader to use to read the image metadata.

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

Methods inherited from class java.lang.Object

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

Constructor Details

FromStackReader

public FromStackReader(StackReader stackReader)

Create from a StackReader.

Parameters:

stackReader - the reader.

FromStackReader

public FromStackReader()

Method Details

openFile

public ImageMetadata openFile(Path path,
 StackReader defaultStackReader,
 OperationContext context)
                       throws ImageIOException

Description copied from class: ImageMetadataReader

Opens a file containing one or more images but does not read an image.

Specified by:

openFile in class ImageMetadataReader

Parameters:

path - where the file is located.

defaultStackReader - the default StackReader to use, if needed, and if not otherwise specified, for reading metadata.

context - context for reading a stack from the file-system.

Returns:

an interface to the opened file that should be closed when no longer in use.

Throws:

ImageIOException - if the file cannot be read.

getStackReader

public StackReader getStackReader()

The StackReader to use to read the image metadata.

If not specified, the default StackReader is used. Note that this bean does not allow the default -instance to be passed by DefaultInstance, as the bean often needs to be specified in the defaultBeans.xml configuration file, where it is not already known.

setStackReader

public void setStackReader(StackReader stackReader)

The StackReader to use to read the image metadata.

If not specified, the default StackReader is used. Note that this bean does not allow the default -instance to be passed by DefaultInstance, as the bean often needs to be specified in the defaultBeans.xml configuration file, where it is not already known.

getSeriesIndex

public int getSeriesIndex()

The series to open to the read the metadata (zero-indexed).

setSeriesIndex

public void setSeriesIndex(int seriesIndex)

The series to open to the read the metadata (zero-indexed).