public interface Dataset extends Data, ImgPlusMetadata, Img<RealType<?>>
ImgPlus
. It also provides a number of convenience methods,
such as the ability to access pixels on a plane-by-plane basis, and create
new Datasets of various types easily.Modifier and Type | Method and Description |
---|---|
default Optional<CalibratedAxis> |
axis(AxisType type)
Gets the axis of the given type.
|
Dataset |
copy() |
void |
copyDataFrom(Dataset other)
Changes a Dataset's internal data and metadata to match that from a given
Dataset.
|
void |
copyInto(Dataset target)
Copies the dataset's pixels into the given target dataset.
|
default long |
dimension(AxisType type)
Gets the length of the axis with the given
AxisType . |
Dataset |
duplicate()
Creates a copy of the dataset.
|
Dataset |
duplicateBlank()
Creates a copy of the dataset, but without copying any pixel values.
|
DatasetFactory |
factory() |
double |
getBytesOfInfo() |
default long |
getChannels()
Gets the length of the
Axes.CHANNEL axis, or 1 if no such axis. |
default long |
getDepth()
Gets the length of the
Axes.Z axis, or 1 if no such axis. |
default long |
getFrames()
Gets the length of the
Axes.TIME axis, or 1 if no such axis. |
default long |
getHeight()
Gets the length of the
Axes.Y axis, or 1 if no such axis. |
ImgPlus<? extends RealType<?>> |
getImgPlus()
TODO
|
Object |
getPlane(int planeNumber)
gets a plane of data from the Dataset.
|
Object |
getPlane(int planeNumber,
boolean copyOK)
gets a plane of data from the Dataset.
|
RealType<?> |
getType()
TODO
|
String |
getTypeLabelLong()
Gets the full string description of the dataset's pixel type.
|
String |
getTypeLabelShort()
Gets a short string description of the dataset's pixel type.
|
default long |
getWidth()
Gets the length of the
Axes.X axis, or 1 if no such axis. |
boolean |
isDirty()
TODO
|
boolean |
isInteger()
TODO
|
boolean |
isRGBMerged()
For use in legacy layer only, this flag allows the various legacy layer
image translators to support color images correctly.
|
boolean |
isSigned()
TODO
|
void |
rebuild()
Informs interested parties that the data object has undergone a major
change, such as the dimensional extents changing.
|
void |
rgbChange()
TODO
|
void |
setAxes(CalibratedAxis[] axes) |
void |
setDirty(boolean value)
TODO
|
void |
setImgPlus(ImgPlus<? extends RealType<?>> imgPlus)
TODO
|
boolean |
setPlane(int planeNum,
Object newPlane)
sets a plane of data within the dataset.
|
boolean |
setPlaneSilently(int planeNum,
Object newPlane)
sets a plane of data within the dataset.
|
void |
setRGBMerged(boolean rgbMerged)
For use in legacy layer only, this flag allows the various legacy layer
image translators to support color images correctly.
|
void |
typeChange()
TODO
|
default <T extends RealType<T>> |
typedImg(T t)
TODO
|
void |
update()
Informs interested parties that the data object has undergone a
non-structural change, such as sample values being updated.
|
decrementReferences, incrementReferences
averageScale
dimensionIndex
axes, axis, setAxis
numDimensions
context, getContext, setContext
getChannelMaximum, getChannelMinimum, getColorTable, getColorTableCount, getCompositeChannelCount, getProperties, getValidBits, initializeColorTables, setChannelMaximum, setChannelMinimum, setColorTable, setCompositeChannelCount, setValidBits
getAt, getAt, getAt, randomAccess, randomAccess
cursor, localizingCursor
firstElement, iterationOrder, size
forEach, iterator, spliterator
dimension, max, max, max, maxAsLongArray, maxAsPoint, min, min, min, minAsLongArray, minAsPoint, realMax, realMin
maxAsDoubleArray, maxAsRealPoint, minAsDoubleArray, minAsRealPoint, realMax, realMax, realMin, realMin
allPositive, allPositive, dimensions, dimensions, dimensionsAsLongArray, dimensionsAsPoint, verify, verify, verifyAllPositive, verifyAllPositive
boolean isDirty()
void setDirty(boolean value)
Object getPlane(int planeNumber)
Object getPlane(int planeNumber, boolean copyOK)
boolean setPlane(int planeNum, Object newPlane)
boolean setPlaneSilently(int planeNum, Object newPlane)
RealType<?> getType()
boolean isSigned()
boolean isInteger()
String getTypeLabelShort()
String getTypeLabelLong()
Dataset duplicate()
Dataset duplicateBlank()
void copyInto(Dataset target)
void setRGBMerged(boolean rgbMerged)
boolean isRGBMerged()
void typeChange()
void rgbChange()
void copyDataFrom(Dataset other)
double getBytesOfInfo()
void setAxes(CalibratedAxis[] axes)
default long getWidth()
Axes.X
axis, or 1 if no such axis.default long getHeight()
Axes.Y
axis, or 1 if no such axis.default long getDepth()
Axes.Z
axis, or 1 if no such axis.default long getFrames()
Axes.TIME
axis, or 1 if no such axis.default long getChannels()
Axes.CHANNEL
axis, or 1 if no such axis.default long dimension(AxisType type)
AxisType
.type
- Type of the axis, e.g. Axes.X
default Optional<CalibratedAxis> axis(AxisType type)
type
- Type of the axis, e.g. Axes.X
Optional
containing the CalibratedAxis
, or empty
if the dataset doesn't have that axisvoid update()
update
in interface Data
DatasetUpdatedEvent
void rebuild()
rebuild
in interface Data
DatasetRestructuredEvent
DatasetFactory factory()
Copyright © 2014–2022 ImageJ. All rights reserved.