public final class MetadataTools
extends java.lang.Object
MetadataStore
, MetadataRetrieve
,
and OME-XML strings.
Most of the methods require the optional loci.formats.ome
package, and optional ome-xml.jar library, to be present at runtime.
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
createLSID(java.lang.String type,
int... indices)
Constructs an LSID, given the object type and indices.
|
static IMetadata |
createOMEXMLMetadata()
Creates an OME-XML metadata object using reflection, to avoid
direct dependencies on the optional
loci.formats.ome package. |
static java.lang.String[] |
keys(java.util.Hashtable<java.lang.String,java.lang.Object> meta)
Gets a sorted list of keys from the given hashtable.
|
static java.lang.String |
makeSaneDimensionOrder(java.lang.String dimensionOrder)
Adjusts the given dimension order as needed so that it contains exactly
one of each of the following characters: 'X', 'Y', 'Z', 'C', 'T'.
|
static void |
merge(java.util.Map<java.lang.String,java.lang.Object> src,
java.util.Map<java.lang.String,java.lang.Object> dest,
java.lang.String prefix)
Merges the given lists of metadata, prepending the
specified prefix for the destination keys.
|
static void |
populateMetadata(MetadataStore store,
int series,
java.lang.String imageName,
boolean littleEndian,
java.lang.String dimensionOrder,
java.lang.String pixelType,
int sizeX,
int sizeY,
int sizeZ,
int sizeC,
int sizeT,
int samplesPerPixel)
Populates the given
MetadataStore , for the specified series, using
the provided values. |
static void |
populateMetadata(MetadataStore store,
int series,
java.lang.String imageName,
CoreMetadata coreMeta)
Populates the given
MetadataStore , for the specified series, using
the values from the provided CoreMetadata . |
static void |
populateMetadata(MetadataStore store,
java.lang.String file,
int series,
java.lang.String imageName,
boolean littleEndian,
java.lang.String dimensionOrder,
java.lang.String pixelType,
int sizeX,
int sizeY,
int sizeZ,
int sizeC,
int sizeT,
int samplesPerPixel)
Populates the given
MetadataStore , for the specified series, using
the provided values. |
static void |
populatePixels(MetadataStore store,
IFormatReader r)
Populates the 'pixels' element of the given metadata store, using core
metadata from the given reader.
|
static void |
populatePixels(MetadataStore store,
IFormatReader r,
boolean doPlane)
Populates the 'pixels' element of the given metadata store, using core
metadata from the given reader.
|
static void |
populatePixels(MetadataStore store,
IFormatReader r,
boolean doPlane,
boolean doImageName)
Populates the 'pixels' element of the given metadata store, using core
metadata from the given reader.
|
static void |
populatePixelsOnly(MetadataStore store,
IFormatReader r) |
static void |
populatePixelsOnly(MetadataStore store,
int series,
boolean littleEndian,
java.lang.String dimensionOrder,
java.lang.String pixelType,
int sizeX,
int sizeY,
int sizeZ,
int sizeC,
int sizeT,
int samplesPerPixel) |
static void |
setDefaultCreationDate(MetadataStore store,
java.lang.String id,
int series)
Sets a default creation date.
|
static void |
setDefaultDateEnabled(boolean enabled)
Disables the setting of a default creation date.
|
static void |
verifyMinimumPopulated(MetadataRetrieve src)
Checks whether the given metadata object has the minimum metadata
populated to successfully describe an Image.
|
static void |
verifyMinimumPopulated(MetadataRetrieve src,
int n)
Checks whether the given metadata object has the minimum metadata
populated to successfully describe the nth Image.
|
public static void populatePixels(MetadataStore store, IFormatReader r)
public static void populatePixels(MetadataStore store, IFormatReader r, boolean doPlane)
public static void populatePixels(MetadataStore store, IFormatReader r, boolean doPlane, boolean doImageName)
public static void populateMetadata(MetadataStore store, int series, java.lang.String imageName, CoreMetadata coreMeta)
MetadataStore
, for the specified series, using
the values from the provided CoreMetadata
.
After calling this method, the metadata store will be sufficiently
populated for use with an IFormatWriter
(assuming it is also a
MetadataRetrieve
).
public static void populateMetadata(MetadataStore store, int series, java.lang.String imageName, boolean littleEndian, java.lang.String dimensionOrder, java.lang.String pixelType, int sizeX, int sizeY, int sizeZ, int sizeC, int sizeT, int samplesPerPixel)
MetadataStore
, for the specified series, using
the provided values.
After calling this method, the metadata store will be sufficiently
populated for use with an IFormatWriter
(assuming it is also a
MetadataRetrieve
).
public static void populateMetadata(MetadataStore store, java.lang.String file, int series, java.lang.String imageName, boolean littleEndian, java.lang.String dimensionOrder, java.lang.String pixelType, int sizeX, int sizeY, int sizeZ, int sizeC, int sizeT, int samplesPerPixel)
MetadataStore
, for the specified series, using
the provided values.
After calling this method, the metadata store will be sufficiently
populated for use with an IFormatWriter
(assuming it is also a
MetadataRetrieve
).
public static void populatePixelsOnly(MetadataStore store, IFormatReader r)
public static void populatePixelsOnly(MetadataStore store, int series, boolean littleEndian, java.lang.String dimensionOrder, java.lang.String pixelType, int sizeX, int sizeY, int sizeZ, int sizeC, int sizeT, int samplesPerPixel)
public static java.lang.String createLSID(java.lang.String type, int... indices)
public static void verifyMinimumPopulated(MetadataRetrieve src) throws FormatException
FormatException
- if there is a missing metadata field,
or the metadata object is uninitializedpublic static void verifyMinimumPopulated(MetadataRetrieve src, int n) throws FormatException
FormatException
- if there is a missing metadata field,
or the metadata object is uninitializedpublic static void setDefaultDateEnabled(boolean enabled)
enabled
- See above.setDefaultCreationDate(MetadataStore, String, int)
public static void setDefaultCreationDate(MetadataStore store, java.lang.String id, int series)
setDefaultDateEnabled(boolean)
public static java.lang.String makeSaneDimensionOrder(java.lang.String dimensionOrder)
public static java.lang.String[] keys(java.util.Hashtable<java.lang.String,java.lang.Object> meta)
public static void merge(java.util.Map<java.lang.String,java.lang.Object> src, java.util.Map<java.lang.String,java.lang.Object> dest, java.lang.String prefix)
public static IMetadata createOMEXMLMetadata()
loci.formats.ome
package.AbstractOMEXMLMetadata
,
or null if one cannot be created.Copyright © 2014 Open Microscopy Environment