AbstractImageMetadata (SCIFIO Core 0.48.0 API)

java.lang.Object
- io.scif.AbstractImageMetadata

All Implemented Interfaces:

HasMetaTable, ImageMetadata, org.scijava.Named

Direct Known Subclasses:

DefaultImageMetadata
```
public abstract class AbstractImageMetadata
extends Object
implements ImageMetadata
```
Abstract superclass of all ImageMetadata implementations.

Author:

Mark Hiner

See Also:

ImageMetadata, DefaultImageMetadata

Field Summary

Fields
Modifier and Type Field and Description

static long THUMBNAIL_DIMENSION
Default thumbnail width and height.

Fields
Modifier and Type	Field and Description
`static long`	`THUMBNAIL_DIMENSION` Default thumbnail width and height.

Constructor Summary

Constructors
Constructor and Description

AbstractImageMetadata()

AbstractImageMetadata(ImageMetadata copy)

Constructors
Constructor and Description
`AbstractImageMetadata()`
`AbstractImageMetadata(ImageMetadata copy)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAxis(net.imagej.axis.AxisType axisType, long value)` As `ImageMetadata.addAxis(CalibratedAxis, long)` using the default calibration value, per `FormatTools.createAxis(AxisType)`.
`void`	`addAxis(net.imagej.axis.CalibratedAxis axis)` Appends the provided `CalibratedAxis` to the metadata's list of axes, with a length of 1.
`void`	`addAxis(net.imagej.axis.CalibratedAxis axis, long value)` Appends the provided CalibratedAxis to the current CalibratedAxis array and creates a corresponding entry with the specified value in axis lengths.
`void`	`copy(ImageMetadata toCopy)` Populates this ImageMetadata using the provided instance.
`List<net.imagej.axis.CalibratedAxis>`	`getAxes()` Returns an array of the types for axes associated with the specified image index.
`long[]`	`getAxesLengths()` Returns an array of the lengths for axes associated with the specified image index.
`long[]`	`getAxesLengths(List<net.imagej.axis.CalibratedAxis> axes)` Returns an array of the lengths for axes in the provided CalibratedAxis list.
`long[]`	`getAxesLengthsNonPlanar()` Returns an array of the lengths for the non-planar axes in this image.
`long[]`	`getAxesLengthsPlanar()` Returns an array of the lengths for the planar axes in this image.
`List<net.imagej.axis.CalibratedAxis>`	`getAxesNonPlanar()` Returns an array of the CalibratedAxis that define the number of planes in the dataset.
`List<net.imagej.axis.CalibratedAxis>`	`getAxesPlanar()` Returns an array of the CalibratedAxis that, together, define the bounds of a single plane in the dataset.
`net.imagej.axis.CalibratedAxis`	`getAxis(net.imagej.axis.AxisType axisType)` Returns the CalibratedAxis associated with the given type.
`net.imagej.axis.CalibratedAxis`	`getAxis(int axisIndex)` Gets the axis of the (zero-indexed) specified plane.
`int`	`getAxisIndex(net.imagej.axis.AxisType axisType)` As `ImageMetadata.getAxisIndex(CalibratedAxis)` but only requires the `AxisType` of the desired axis.
`int`	`getAxisIndex(net.imagej.axis.CalibratedAxis axis)` Returns the array index for the specified CalibratedAxis.
`long`	`getAxisLength(net.imagej.axis.AxisType t)` As `ImageMetadata.getAxisLength(CalibratedAxis)` but only requires the `AxisType` of the desired axis.
`long`	`getAxisLength(net.imagej.axis.CalibratedAxis t)` A convenience method for looking up the length of an axis based on its type.
`long`	`getAxisLength(int axisIndex)` Gets the length of the (zero-indexed) specified plane.
`int`	`getBitsPerPixel()` Returns the number of valid bits per pixel.
`int`	`getInterleavedAxisCount()` Returns the number of interleaved axes in this image.
`String`	`getName()`
`int`	`getPixelType()` Returns the data type associated with a pixel.
`int`	`getPlanarAxisCount()` Returns the number of planar axes in this image.
`long`	`getPlaneCount()`
`long`	`getPlaneSize()` Returns the size, in bytes, of one plane in this image.
`Object`	`getROIs()` Retrieves the ROIs associated with this image.
`long`	`getSize()` Returns the size, in bytes, of all planes in this image.
`MetaTable`	`getTable()`
`Object`	`getTables()` Retrieves the tables associated with this image.
`long`	`getThumbSizeX()` Returns the width (in pixels) of the thumbnail planes in this image.
`long`	`getThumbSizeY()` Returns the height (in pixels) of the thumbnail planes in this image.
`boolean`	`isFalseColor()` Returns true if we can ignore the color map (if present).
`boolean`	`isIndexed()` Returns true if the planes are stored as indexed color.
`boolean`	`isLittleEndian()` Returns true if each pixel's bytes are in little endian order.
`boolean`	`isMetadataComplete()` Returns true if we are confident that all of the metadata stored within the image has been parsed.
`boolean`	`isMultichannel()` Returns true if the `Axes.CHANNEL` axis is a planar axis.
`boolean`	`isOrderCertain()` Returns true if we are confident that the dimension order is correct.
`boolean`	`isThumbnail()` Determines whether or not this image is a lower-resolution copy of another image.
`void`	`populate(String name, List<net.imagej.axis.CalibratedAxis> axes, long[] lengths, int pixelType, boolean orderCertain, boolean littleEndian, boolean indexed, boolean falseColor, boolean metadataComplete)` As `ImageMetadata.populate(String, List, long[], int, boolean, boolean, boolean, boolean, boolean)` but automatically determines bits per pixel.
`void`	`populate(String name, List<net.imagej.axis.CalibratedAxis> axes, long[] lengths, int pixelType, int bitsPerPixel, boolean orderCertain, boolean littleEndian, boolean indexed, boolean falseColor, boolean metadataComplete)` Convenience method for manually populating an ImageMetadata.
`void`	`setAxes(net.imagej.axis.CalibratedAxis... axisTypes)` Sets the Axes types for this image.
`void`	`setAxes(net.imagej.axis.CalibratedAxis[] axes, long[] axisLengths)` Convenience method to set both the axis types and lengths for this ImageMetadata.
`void`	`setAxis(int index, net.imagej.axis.CalibratedAxis axis)` Sets the axis at the specified index, if an axis with a matching type is not already defined.
`void`	`setAxisLength(net.imagej.axis.AxisType axisType, long length)` As `ImageMetadata.setAxisLength(CalibratedAxis, long)` but requires only the AxisType.
`void`	`setAxisLength(net.imagej.axis.CalibratedAxis axis, long length)` Sets the length for the specified axis.
`void`	`setAxisLengths(long[] axisLengths)` Sets the lengths of each axis.
`void`	`setAxisType(int index, net.imagej.axis.AxisType axisType)` As `ImageMetadata.setAxis(int, CalibratedAxis)` but using the default calibration values, per `FormatTools.createAxis(AxisType)`.
`void`	`setAxisTypes(net.imagej.axis.AxisType... axisTypes)` Sets the Axes types for this image.
`void`	`setBitsPerPixel(int bitsPerPixel)` Sets the number of valid bits per pixel.
`void`	`setFalseColor(boolean falseColor)` Sets whether or not we can ignore the color map (if present).
`void`	`setIndexed(boolean indexed)` Sets whether or not the planes are stored as indexed color.
`void`	`setInterleavedAxisCount(int count)` Sets the number of interleaved axes in this image.
`void`	`setLittleEndian(boolean littleEndian)` Sets whether or not each pixel's bytes are in little endian order.
`void`	`setMetadataComplete(boolean metadataComplete)` Sets whether or not we are confident that all of the metadata stored within the image has been parsed.
`void`	`setName(String name)`
`void`	`setOrderCertain(boolean orderCertain)` Sets whether or not we are confident that the dimension order is correct.
`void`	`setPixelType(int pixelType)` Sets the data type associated with a pixel.
`void`	`setPlanarAxisCount(int count)` Sets the number of planar axes in this image.
`void`	`setROIs(Object rois)` Sets the ROIs associated with this image.
`void`	`setTable(MetaTable table)` Sets the table for this component
`void`	`setTables(Object tables)` Sets the tables associated with this image.
`void`	`setThumbnail(boolean thumbnail)` Sets whether or not this image is a lower-resolution copy of another image.
`void`	`setThumbSizeX(long thumbSizeX)` Sets width (in pixels) of thumbnail planes in this image.
`void`	`setThumbSizeY(long thumbSizeY)` Sets height (in pixels) of thumbnail planes in this image.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.scif.ImageMetadata
copy

- Field Detail
  - THUMBNAIL_DIMENSION
```
public static final long THUMBNAIL_DIMENSION
```
    Default thumbnail width and height.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractImageMetadata
```
public AbstractImageMetadata()
```
  - AbstractImageMetadata
```
public AbstractImageMetadata(ImageMetadata copy)
```
- Method Detail
  - setThumbSizeX
```
public void setThumbSizeX(long thumbSizeX)
```
    Description copied from interface: ImageMetadata
    
    Sets width (in pixels) of thumbnail planes in this image.
    
    Specified by:
    
    setThumbSizeX in interface ImageMetadata
  - setThumbSizeY
```
public void setThumbSizeY(long thumbSizeY)
```
    Description copied from interface: ImageMetadata
    
    Sets height (in pixels) of thumbnail planes in this image.
    
    Specified by:
    
    setThumbSizeY in interface ImageMetadata
  - setPixelType
```
public void setPixelType(int pixelType)
```
    Description copied from interface: ImageMetadata
    
    Sets the data type associated with a pixel. Valid pixel type constants (e.g., FormatTools.INT8) are enumerated in FormatTools.
    
    Specified by:
    
    setPixelType in interface ImageMetadata
  - setBitsPerPixel
```
public void setBitsPerPixel(int bitsPerPixel)
```
    Description copied from interface: ImageMetadata
    
    Sets the number of valid bits per pixel.
    
    Specified by:
    
    setBitsPerPixel in interface ImageMetadata
  - setOrderCertain
```
public void setOrderCertain(boolean orderCertain)
```
    Description copied from interface: ImageMetadata
    
    Sets whether or not we are confident that the dimension order is correct.
    
    Specified by:
    
    setOrderCertain in interface ImageMetadata
  - setLittleEndian
```
public void setLittleEndian(boolean littleEndian)
```
    Description copied from interface: ImageMetadata
    
    Sets whether or not each pixel's bytes are in little endian order.
    
    Specified by:
    
    setLittleEndian in interface ImageMetadata
  - setIndexed
```
public void setIndexed(boolean indexed)
```
    Description copied from interface: ImageMetadata
    
    Sets whether or not the planes are stored as indexed color. An indexed color image treats each pixel value as an index into a color table containing one or more (typically 3) actual values for the pixel.
    
    Specified by:
    
    setIndexed in interface ImageMetadata
  - setPlanarAxisCount
```
public void setPlanarAxisCount(int count)
```
    Description copied from interface: ImageMetadata
    
    Sets the number of planar axes in this image. This value represents the number of dimensional axes constituting each Plane (as returned by the Reader.openPlane(int, long) methods). This value is necessary to determine the total plane count for an N-dimensional image, as well as how many pixels there are per plane.
    For example, suppose we have a 4-dimensional image with axes (X, Y, Z, T) and extents (768, 512, 7, 13). If there are two planar axes, then each plane is 768 x 512 and there are 7 x 13 = 91 total planes. But if we have three planar axes, then each plane is 768 x 512 x 7 and there are 13 total planes.
    
    Specified by:
    
    setPlanarAxisCount in interface ImageMetadata
    
    See Also:
    
    Reader.openPlane(int, long)
  - setInterleavedAxisCount
```
public void setInterleavedAxisCount(int count)
```
    Description copied from interface: ImageMetadata
    
    Sets the number of interleaved axes in this image. This must be a value between [0, planarAxisCount). Interleaved axes are planar axes that do not constitute the "canonical" axes - e.g., in a CXY image with an interleaved axis count of 1, the C axis is interleaved, and each plane is an XY plane with C different representations.
    
    Specified by:
    
    setInterleavedAxisCount in interface ImageMetadata
  - setFalseColor
```
public void setFalseColor(boolean falseColor)
```
    Description copied from interface: ImageMetadata
    
    Sets whether or not we can ignore the color map (if present).
    
    Specified by:
    
    setFalseColor in interface ImageMetadata
  - setMetadataComplete
```
public void setMetadataComplete(boolean metadataComplete)
```
    Description copied from interface: ImageMetadata
    
    Sets whether or not we are confident that all of the metadata stored within the image has been parsed.
    
    Specified by:
    
    setMetadataComplete in interface ImageMetadata
  - setThumbnail
```
public void setThumbnail(boolean thumbnail)
```
    Description copied from interface: ImageMetadata
    
    Sets whether or not this image is a lower-resolution copy of another image.
    
    Specified by:
    
    setThumbnail in interface ImageMetadata
  - setAxes
```
public void setAxes(net.imagej.axis.CalibratedAxis[] axes,
                    long[] axisLengths)
```
    Description copied from interface: ImageMetadata
    
    Convenience method to set both the axis types and lengths for this ImageMetadata.
    
    Specified by:
    
    setAxes in interface ImageMetadata
  - setAxisTypes
```
public void setAxisTypes(net.imagej.axis.AxisType... axisTypes)
```
    Description copied from interface: ImageMetadata
    
    Sets the Axes types for this image. Order is implied by ordering within this array
    
    Specified by:
    
    setAxisTypes in interface ImageMetadata
  - setAxes
```
public void setAxes(net.imagej.axis.CalibratedAxis... axisTypes)
```
    Description copied from interface: ImageMetadata
    
    Sets the Axes types for this image. Order is implied by ordering within this array
    
    Specified by:
    
    setAxes in interface ImageMetadata
  - setAxisLengths
```
public void setAxisLengths(long[] axisLengths)
```
    Description copied from interface: ImageMetadata
    
    Sets the lengths of each axis. Order is parallel of axes.
    NB: axes must already exist for this method to be called. Use ImageMetadata.setAxes(CalibratedAxis[]) or ImageMetadata.setAxes(net.imagej.axis.CalibratedAxis[], long[])
    
    Specified by:
    
    setAxisLengths in interface ImageMetadata
  - setAxisLength
```
public void setAxisLength(net.imagej.axis.CalibratedAxis axis,
                          long length)
```
    Description copied from interface: ImageMetadata
    
    Sets the length for the specified axis. Adds the axis if if its type is not already present in the image.
    
    Specified by:
    
    setAxisLength in interface ImageMetadata
  - setAxisLength
```
public void setAxisLength(net.imagej.axis.AxisType axisType,
                          long length)
```
    Description copied from interface: ImageMetadata
    
    As ImageMetadata.setAxisLength(CalibratedAxis, long) but requires only the AxisType.
    
    Specified by:
    
    setAxisLength in interface ImageMetadata
  - setAxis
```
public void setAxis(int index,
                    net.imagej.axis.CalibratedAxis axis)
```
    Description copied from interface: ImageMetadata
    
    Sets the axis at the specified index, if an axis with a matching type is not already defined. Otherwise the axes are re-ordered, per List.add(int, Object).
    
    Specified by:
    
    setAxis in interface ImageMetadata
  - setAxisType
```
public void setAxisType(int index,
                        net.imagej.axis.AxisType axisType)
```
    Description copied from interface: ImageMetadata
    
    As ImageMetadata.setAxis(int, CalibratedAxis) but using the default calibration values, per FormatTools.createAxis(AxisType).
    
    Specified by:
    
    setAxisType in interface ImageMetadata
  - setROIs
```
public void setROIs(Object rois)
```
    Description copied from interface: ImageMetadata
    
    Sets the ROIs associated with this image.
    
    Specified by:
    
    setROIs in interface ImageMetadata
  - setTables
```
public void setTables(Object tables)
```
    Description copied from interface: ImageMetadata
    
    Sets the tables associated with this image.
    
    Specified by:
    
    setTables in interface ImageMetadata
  - getSize
```
public long getSize()
```
    Description copied from interface: ImageMetadata
    
    Returns the size, in bytes, of all planes in this image.
    
    Specified by:
    
    getSize in interface ImageMetadata
  - getPlaneSize
```
public long getPlaneSize()
```
    Description copied from interface: ImageMetadata
    
    Returns the size, in bytes, of one plane in this image.
    
    Specified by:
    
    getPlaneSize in interface ImageMetadata
  - getThumbSizeX
```
public long getThumbSizeX()
```
    Description copied from interface: ImageMetadata
    
    Returns the width (in pixels) of the thumbnail planes in this image.
    
    Specified by:
    
    getThumbSizeX in interface ImageMetadata
  - getThumbSizeY
```
public long getThumbSizeY()
```
    Description copied from interface: ImageMetadata
    
    Returns the height (in pixels) of the thumbnail planes in this image.
    
    Specified by:
    
    getThumbSizeY in interface ImageMetadata
  - getAxis
```
public net.imagej.axis.CalibratedAxis getAxis(net.imagej.axis.AxisType axisType)
```
    Description copied from interface: ImageMetadata
    
    Returns the CalibratedAxis associated with the given type. Useful to retrieve calibration information.
    
    Specified by:
    
    getAxis in interface ImageMetadata
  - getPixelType
```
public int getPixelType()
```
    Description copied from interface: ImageMetadata
    
    Returns the data type associated with a pixel. Valid pixel type constants (e.g., FormatTools.INT8) are enumerated in FormatTools.
    
    Specified by:
    
    getPixelType in interface ImageMetadata
  - getBitsPerPixel
```
public int getBitsPerPixel()
```
    Description copied from interface: ImageMetadata
    
    Returns the number of valid bits per pixel.
    
    Specified by:
    
    getBitsPerPixel in interface ImageMetadata
  - getAxes
```
public List<net.imagej.axis.CalibratedAxis> getAxes()
```
    Description copied from interface: ImageMetadata
    
    Returns an array of the types for axes associated with the specified image index. Order is consistent with the axis length (int) array returned by ImageMetadata.getAxesLengths().
    CalibratedAxis order is sorted and represents order within the image.
    
    Specified by:
    
    getAxes in interface ImageMetadata
    
    Returns:
    
    List of CalibratedAxes. Ordering in the list indicates the axis order in the image.
  - getAxesPlanar
```
public List<net.imagej.axis.CalibratedAxis> getAxesPlanar()
```
    Description copied from interface: ImageMetadata
    
    Returns an array of the CalibratedAxis that, together, define the bounds of a single plane in the dataset.
    
    Specified by:
    
    getAxesPlanar in interface ImageMetadata
    
    Returns:
    
    List of CalibratedAxes. Ordering in the list indicates the axis order in the image.
  - getAxesNonPlanar
```
public List<net.imagej.axis.CalibratedAxis> getAxesNonPlanar()
```
    Description copied from interface: ImageMetadata
    
    Returns an array of the CalibratedAxis that define the number of planes in the dataset.
    
    Specified by:
    
    getAxesNonPlanar in interface ImageMetadata
    
    Returns:
    
    List of CalibratedAxes. Ordering in the list indicates the axis order in the image.
  - getPlaneCount
```
public long getPlaneCount()
```
    Specified by:
    
    getPlaneCount in interface ImageMetadata
    
    Returns:
    
    the number of planes in this image
  - getAxesLengths
```
public long[] getAxesLengths()
```
    Description copied from interface: ImageMetadata
    
    Returns an array of the lengths for axes associated with the specified image index.
    Ordering is consistent with the CalibratedAxis array returned by ImageMetadata.getAxes().
    
    Specified by:
    
    getAxesLengths in interface ImageMetadata
    
    Returns:
    
    Sorted axis length array
  - getAxesLengths
```
public long[] getAxesLengths(List<net.imagej.axis.CalibratedAxis> axes)
```
    Description copied from interface: ImageMetadata
    
    Returns an array of the lengths for axes in the provided CalibratedAxis list.
    Ordering of the lengths is consistent with the provided ordering.
    
    Specified by:
    
    getAxesLengths in interface ImageMetadata
    
    Returns:
    
    Sorted axis length array
  - getAxesLengthsPlanar
```
public long[] getAxesLengthsPlanar()
```
    Description copied from interface: ImageMetadata
    
    Returns an array of the lengths for the planar axes in this image.
    
    Specified by:
    
    getAxesLengthsPlanar in interface ImageMetadata
    
    Returns:
    
    Sorted axis length array
  - getAxesLengthsNonPlanar
```
public long[] getAxesLengthsNonPlanar()
```
    Description copied from interface: ImageMetadata
    
    Returns an array of the lengths for the non-planar axes in this image.
    
    Specified by:
    
    getAxesLengthsNonPlanar in interface ImageMetadata
    
    Returns:
    
    Sorted axis length array
  - isOrderCertain
```
public boolean isOrderCertain()
```
    Description copied from interface: ImageMetadata
    
    Returns true if we are confident that the dimension order is correct.
    
    Specified by:
    
    isOrderCertain in interface ImageMetadata
  - isLittleEndian
```
public boolean isLittleEndian()
```
    Description copied from interface: ImageMetadata
    
    Returns true if each pixel's bytes are in little endian order.
    
    Specified by:
    
    isLittleEndian in interface ImageMetadata
  - isIndexed
```
public boolean isIndexed()
```
    Description copied from interface: ImageMetadata
    
    Returns true if the planes are stored as indexed color.
    
    Specified by:
    
    isIndexed in interface ImageMetadata
  - getPlanarAxisCount
```
public int getPlanarAxisCount()
```
    Description copied from interface: ImageMetadata
    
    Returns the number of planar axes in this image.
    
    Specified by:
    
    getPlanarAxisCount in interface ImageMetadata
  - getInterleavedAxisCount
```
public int getInterleavedAxisCount()
```
    Description copied from interface: ImageMetadata
    
    Returns the number of interleaved axes in this image.
    
    Specified by:
    
    getInterleavedAxisCount in interface ImageMetadata
  - isMultichannel
```
public boolean isMultichannel()
```
    Description copied from interface: ImageMetadata
    
    Returns true if the Axes.CHANNEL axis is a planar axis.
    
    Specified by:
    
    isMultichannel in interface ImageMetadata
  - isFalseColor
```
public boolean isFalseColor()
```
    Description copied from interface: ImageMetadata
    
    Returns true if we can ignore the color map (if present).
    
    Specified by:
    
    isFalseColor in interface ImageMetadata
  - isMetadataComplete
```
public boolean isMetadataComplete()
```
    Description copied from interface: ImageMetadata
    
    Returns true if we are confident that all of the metadata stored within the image has been parsed.
    
    Specified by:
    
    isMetadataComplete in interface ImageMetadata
  - isThumbnail
```
public boolean isThumbnail()
```
    Description copied from interface: ImageMetadata
    
    Determines whether or not this image is a lower-resolution copy of another image.
    
    Specified by:
    
    isThumbnail in interface ImageMetadata
    
    Returns:
    
    true if this image is a thumbnail
  - getAxis
```
public net.imagej.axis.CalibratedAxis getAxis(int axisIndex)
```
    Description copied from interface: ImageMetadata
    
    Gets the axis of the (zero-indexed) specified plane.
    
    Specified by:
    
    getAxis in interface ImageMetadata
    
    Parameters:
    
    axisIndex - - index of the desired axis within this image
    
    Returns:
    
    Type of the desired plane.
  - getAxisLength
```
public long getAxisLength(int axisIndex)
```
    Description copied from interface: ImageMetadata
    
    Gets the length of the (zero-indexed) specified plane.
    
    Specified by:
    
    getAxisLength in interface ImageMetadata
    
    Parameters:
    
    axisIndex - - index of the desired axis within this image
    
    Returns:
    
    Length of the desired axis, or 1 if the axis is not found.
  - getAxisLength
```
public long getAxisLength(net.imagej.axis.CalibratedAxis t)
```
    Description copied from interface: ImageMetadata
    
    A convenience method for looking up the length of an axis based on its type. No knowledge of plane ordering is necessary.
    
    Specified by:
    
    getAxisLength in interface ImageMetadata
    
    Parameters:
    
    t - - CalibratedAxis to look up
    
    Returns:
    
    Length of axis t, or 1 if the axis is not found.
  - getAxisLength
```
public long getAxisLength(net.imagej.axis.AxisType t)
```
    Description copied from interface: ImageMetadata
    
    As ImageMetadata.getAxisLength(CalibratedAxis) but only requires the AxisType of the desired axis.
    
    Specified by:
    
    getAxisLength in interface ImageMetadata
    
    Parameters:
    
    t - - CalibratedAxis to look up
    
    Returns:
    
    Length of axis t, or 1 if the axis is not found.
  - getAxisIndex
```
public int getAxisIndex(net.imagej.axis.CalibratedAxis axis)
```
    Description copied from interface: ImageMetadata
    
    Returns the array index for the specified CalibratedAxis. This index can be used in other Axes methods for looking up lengths, etc...
    This method can also be used as an existence check for the target CalibratedAxis.
    
    Specified by:
    
    getAxisIndex in interface ImageMetadata
    
    Parameters:
    
    axis - - axis to look up
    
    Returns:
    
    The index of the desired axis or -1 if not found.
  - getAxisIndex
```
public int getAxisIndex(net.imagej.axis.AxisType axisType)
```
    Description copied from interface: ImageMetadata
    
    As ImageMetadata.getAxisIndex(CalibratedAxis) but only requires the AxisType of the desired axis.
    
    Specified by:
    
    getAxisIndex in interface ImageMetadata
    
    Parameters:
    
    axisType - - axis type to look up
    
    Returns:
    
    The index of the desired axis or -1 if not found.
  - getROIs
```
public Object getROIs()
```
    Description copied from interface: ImageMetadata
    
    Retrieves the ROIs associated with this image.
    
    Specified by:
    
    getROIs in interface ImageMetadata
  - getTables
```
public Object getTables()
```
    Description copied from interface: ImageMetadata
    
    Retrieves the tables associated with this image.
    
    Specified by:
    
    getTables in interface ImageMetadata
  - addAxis
```
public void addAxis(net.imagej.axis.CalibratedAxis axis)
```
    Description copied from interface: ImageMetadata
    
    Appends the provided CalibratedAxis to the metadata's list of axes, with a length of 1.
    
    Specified by:
    
    addAxis in interface ImageMetadata
    
    Parameters:
    
    axis - - The new axis
  - addAxis
```
public void addAxis(net.imagej.axis.CalibratedAxis axis,
                    long value)
```
    Description copied from interface: ImageMetadata
    
    Appends the provided CalibratedAxis to the current CalibratedAxis array and creates a corresponding entry with the specified value in axis lengths.
    
    Specified by:
    
    addAxis in interface ImageMetadata
    
    Parameters:
    
    axis - - The new axis
    
    value - - length of the new axis
  - addAxis
```
public void addAxis(net.imagej.axis.AxisType axisType,
                    long value)
```
    Description copied from interface: ImageMetadata
    
    As ImageMetadata.addAxis(CalibratedAxis, long) using the default calibration value, per FormatTools.createAxis(AxisType).
    
    Specified by:
    
    addAxis in interface ImageMetadata
  - copy
```
public void copy(ImageMetadata toCopy)
```
    Description copied from interface: ImageMetadata
    
    Populates this ImageMetadata using the provided instance.
    
    Specified by:
    
    copy in interface ImageMetadata
    
    Parameters:
    
    toCopy - - ImageMetadata to copy
  - populate
```
public void populate(String name,
                     List<net.imagej.axis.CalibratedAxis> axes,
                     long[] lengths,
                     int pixelType,
                     boolean orderCertain,
                     boolean littleEndian,
                     boolean indexed,
                     boolean falseColor,
                     boolean metadataComplete)
```
    Description copied from interface: ImageMetadata
    
    As ImageMetadata.populate(String, List, long[], int, boolean, boolean, boolean, boolean, boolean) but automatically determines bits per pixel.
    
    Specified by:
    
    populate in interface ImageMetadata
  - populate
```
public void populate(String name,
                     List<net.imagej.axis.CalibratedAxis> axes,
                     long[] lengths,
                     int pixelType,
                     int bitsPerPixel,
                     boolean orderCertain,
                     boolean littleEndian,
                     boolean indexed,
                     boolean falseColor,
                     boolean metadataComplete)
```
    Description copied from interface: ImageMetadata
    
    Convenience method for manually populating an ImageMetadata.
    
    Specified by:
    
    populate in interface ImageMetadata
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface org.scijava.Named
  - setName
```
public void setName(String name)
```
    Specified by:
    
    setName in interface org.scijava.Named
  - getTable
```
public MetaTable getTable()
```
    Specified by:
    
    getTable in interface HasMetaTable
    
    Returns:
    
    the MetaTable attached to this component
  - setTable
```
public void setTable(MetaTable table)
```
    Description copied from interface: HasMetaTable
    
    Sets the table for this component
    
    Specified by:
    
    setTable in interface HasMetaTable
    
    Parameters:
    
    table - - a MetaTable implementation
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AbstractImageMetadata

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.scif.ImageMetadata

Field Detail

THUMBNAIL_DIMENSION

Constructor Detail

AbstractImageMetadata

AbstractImageMetadata

Method Detail

setThumbSizeX

setThumbSizeY

setPixelType

setBitsPerPixel

setOrderCertain

setLittleEndian

setIndexed

setPlanarAxisCount

setInterleavedAxisCount

setFalseColor

setMetadataComplete

setThumbnail

setAxes

setAxisTypes

setAxes

setAxisLengths

setAxisLength

setAxisLength

setAxis

setAxisType

setROIs

setTables

getSize

getPlaneSize

getThumbSizeX

getThumbSizeY

getAxis

getPixelType

getBitsPerPixel

getAxes

getAxesPlanar

getAxesNonPlanar

getPlaneCount

getAxesLengths

getAxesLengths

getAxesLengthsPlanar

getAxesLengthsNonPlanar

isOrderCertain

isLittleEndian

isIndexed

getPlanarAxisCount

getInterleavedAxisCount

isMultichannel

isFalseColor

isMetadataComplete

isThumbnail

getAxis

getAxisLength

getAxisLength

getAxisLength

getAxisIndex

getAxisIndex

getROIs

getTables

addAxis

addAxis

addAxis

copy

populate

populate

getName

setName

getTable

setTable

toString