Package org.anchoranalysis.plugin.io.bean.stack.writer

Class WriteResolutionXml

Object

AnchorBean<StackWriter>

StackWriter

WriteResolutionXml

public class WriteResolutionXml
extends StackWriter

When writing a stack, an additional file is written to indicate the physical voxel sizes, if this information is known.

The path of this file is the raster-path with .xml appended, e.g. rasterFilename.tif.xml.

It contains physical extents of a single voxel (the resolution).

This file will only be present if the physical voxel sizes are known, otherwise no file is written.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
WriteResolutionXml()

Method Summary

Modifier and Type	Method	Description
ImageFileFormat	fileFormat(StackWriteOptions writeOptions)	The file format that will be written by the generator.
StackWriter	getWriter()
void	setWriter(StackWriter writer)
void	writeStack(Stack stack, Path filePath, StackWriteOptions options)	Writes a stack to the filesystem at a particular path.

Methods inherited from class org.anchoranalysis.image.io.bean.stack.writer.StackWriter

fileFormatWarnUnexpected, writeStackWithExtension

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

WriteResolutionXml

public WriteResolutionXml()

Method Details

fileFormat

public ImageFileFormat fileFormat(StackWriteOptions writeOptions)
                           throws ImageIOException

Description copied from class: StackWriter

The file format that will be written by the generator.

Specified by:

fileFormat in class StackWriter

Parameters:

writeOptions - options which may influence how a raster is written.

Returns:

the image file-format.

Throws:

ImageIOException - if unable to successfully determine the file-format to use to write.

writeStack

public void writeStack(Stack stack,
 Path filePath,
 StackWriteOptions options)
                throws ImageIOException

Description copied from class: StackWriter

Writes a stack to the filesystem at a particular path.

Specified by:

writeStack in class StackWriter

Parameters:

stack - the stack to write.

filePath - the path to write the file to.

options - options which may influence how a raster is written.

Throws:

ImageIOException - if anything goes wrong while writing.

getWriter

public StackWriter getWriter()

setWriter

public void setWriter(StackWriter writer)