Package org.anchoranalysis.image.io.object.output.hdf5

Class HDF5ObjectsGenerator

Object

SingleFileTypeGenerator<ObjectCollection,ObjectCollection>

OneStageGenerator<ObjectCollection>

HDF5ObjectsGenerator

All Implemented Interfaces:

Generator<ObjectCollection>, TransformingGenerator<ObjectCollection,ObjectCollection>, ElementWriter<ObjectCollection>

public class HDF5ObjectsGenerator
extends OneStageGenerator<ObjectCollection>

A generator that writes a ObjectCollection to a HDF5 file.

Author:

Owen Feehan

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NUMBER_OBJECTS_ATTRIBUTE_NAME	Name of the attribute in the root of the HDF5 that stores the number of objects.

Constructor Summary

Constructors

Constructor	Description
HDF5ObjectsGenerator()	Creates with compression activated.
HDF5ObjectsGenerator(boolean compressed)	Creates a new HDF5ObjectsGenerator instance.

Method Summary

Modifier and Type	Method	Description
String	selectFileExtension(OutputWriteSettings settings, Optional<Logger> logger)	Selects the file/extension to be used for outputting the file.
void	writeToFile(ObjectCollection element, OutputWriteSettings settings, Path filePath)	Write generated content for {code element} to the file filePath.

Methods inherited from class org.anchoranalysis.io.generator.OneStageGenerator

transform

Methods inherited from class org.anchoranalysis.io.generator.SingleFileTypeGenerator

write, writeWithIndex

Methods inherited from class java.lang.Object

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

Field Details

NUMBER_OBJECTS_ATTRIBUTE_NAME

public static final String NUMBER_OBJECTS_ATTRIBUTE_NAME

Name of the attribute in the root of the HDF5 that stores the number of objects.

See Also:

• Constant Field Values

Constructor Details

HDF5ObjectsGenerator

public HDF5ObjectsGenerator()

Creates with compression activated.

HDF5ObjectsGenerator

public HDF5ObjectsGenerator(boolean compressed)

Creates a new HDF5ObjectsGenerator instance.

Parameters:

compressed - Whether to use compression when writing the object-masks in HDF5.

Method Details

writeToFile

public void writeToFile(ObjectCollection element,
 OutputWriteSettings settings,
 Path filePath)

Description copied from class: SingleFileTypeGenerator

Write generated content for {code element} to the file filePath.

This function deliberately leaves ambiguity over what occurs if a file already exists at filePath.

Specified by:

writeToFile in class SingleFileTypeGenerator<ObjectCollection,ObjectCollection>

Parameters:

element - element to be assigned and then transformed.

settings - settings for outputting.

filePath - the path to the file to write to.

selectFileExtension

public String selectFileExtension(OutputWriteSettings settings,
 Optional<Logger> logger)

Description copied from class: SingleFileTypeGenerator

Selects the file/extension to be used for outputting the file.

Specified by:

selectFileExtension in class SingleFileTypeGenerator<ObjectCollection,ObjectCollection>

Parameters:

settings - settings for outputting.

logger - logger for warning for information messages when outputting.

Returns:

the file extension (without leading period) to be used for outputting.