public class OpenedMultiFile extends Object implements OpenedImageFile
OpenedImageFile
where the image is formed from more than one file on the file-system.
It ignores multiple series.
Constructor and Description |
---|
OpenedMultiFile(StackReader stackReader,
ParsedFilePathBag fileBag,
ExecutionTimeRecorder executionTimeRecorder) |
Modifier and Type | Method and Description |
---|---|
int |
bitDepth(Logger logger)
The bit-depth of the image voxels e.g.
|
Optional<List<String>> |
channelNames(Logger logger)
The names of each channel, if they are known.
|
void |
close()
Closes the opened image-file, removing any intermediate data-structures.
|
Dimensions |
dimensionsForSeries(int seriesIndex,
Logger logger)
The
Dimensions associated with a particular series. |
boolean |
isRGB(Logger logger)
Whether the image-file has RGB encoded voxels.
|
int |
numberChannels(Logger logger)
The number of channels in the image-file e.g.
|
int |
numberFrames(Logger logger)
The number of frames in the image-file i.e.
|
int |
numberSeries()
The number of series (distinct sets of images) in the image-file.
|
TimeSeries |
open(int seriesIndex,
Logger logger)
Open when we don't have a specific-type.
|
Optional<ImagePyramidMetadata> |
pyramid()
Metadata to describe an image-pyramid, if it exists for this opened-image.
|
ImageTimestampsAttributes |
timestamps()
The timestamps and file-attributes associated with the image.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
metadata, open, openCheckType
public OpenedMultiFile(StackReader stackReader, ParsedFilePathBag fileBag, ExecutionTimeRecorder executionTimeRecorder)
public int numberSeries()
OpenedImageFile
numberSeries
in interface OpenedImageFile
public TimeSeries open(int seriesIndex, Logger logger) throws ImageIOException
OpenedImageFile
open
in interface OpenedImageFile
seriesIndex
- the index of the series of the open, zero-indexed.logger
- the logger.ImageIOException
- if an error occurs reading the image during this operation.public Optional<List<String>> channelNames(Logger logger)
OpenedImageFile
channelNames
in interface OpenedImageFile
logger
- the logger.OpenedImageFile.numberChannels(Logger)
.public int numberChannels(Logger logger) throws ImageIOException
OpenedImageFile
numberChannels
in interface OpenedImageFile
logger
- the logger.ImageIOException
- if an error occurs reading the image to determine this information.public int bitDepth(Logger logger) throws ImageIOException
OpenedImageFile
bitDepth
in interface OpenedImageFile
logger
- the logger.ImageIOException
- if an error occurs reading the image to determine this information.public boolean isRGB(Logger logger) throws ImageIOException
OpenedImageFile
isRGB
in interface OpenedImageFile
logger
- the logger.ImageIOException
- if an error occurs reading the image to determine this information.public int numberFrames(Logger logger) throws ImageIOException
OpenedImageFile
numberFrames
in interface OpenedImageFile
logger
- the logger.ImageIOException
- if an error occurs reading the image to determine this information.public ImageTimestampsAttributes timestamps() throws ImageIOException
OpenedImageFile
timestamps
in interface OpenedImageFile
ImageIOException
- if an error occurs reading the image to determine this information.public void close() throws ImageIOException
OpenedImageFile
close
in interface AutoCloseable
close
in interface OpenedImageFile
ImageIOException
public Dimensions dimensionsForSeries(int seriesIndex, Logger logger) throws ImageIOException
OpenedImageFile
Dimensions
associated with a particular series.dimensionsForSeries
in interface OpenedImageFile
seriesIndex
- the index of the series.logger
- a logger for any non-fatal errors. Fatal errors throw an exception.ImageIOException
- if any filesystem-related input-output failure occurs.public Optional<ImagePyramidMetadata> pyramid() throws ImageIOException
OpenedImageFile
pyramid
in interface OpenedImageFile
Optional.empty()
if no pyramid exists.ImageIOException
- if an error occurs reading the image to determine this information.Copyright © 2010–2023 Owen Feehan, ETH Zurich, University of Zurich, Hoffmann-La Roche. All rights reserved.