public interface NotebookService extends ImageJService
| Modifier and Type | Interface and Description |
|---|---|
static class |
NotebookService.ValueScaling
Strategy to use for scaling the image intensity values.
|
| Modifier and Type | Method and Description |
|---|---|
default Object |
display(Dataset source)
Converts the given image to a form renderable by scientific notebooks.
|
default Object |
display(List<?> list)
Converts the given list data to a form renderable by scientific notebooks.
|
default Object |
display(List<?> list,
List<String> rowHeaders)
Converts the given list data to a form renderable by scientific notebooks.
|
default Object |
display(List<?> list,
String colHeader)
Converts the given list data to a form renderable by scientific notebooks.
|
default <T> Object |
display(List<T> list,
String colHeader,
List<String> rowHeaders)
Converts the given list data to a form renderable by scientific notebooks.
|
default Object |
display(Map<?,?> map)
Converts the given map data to a form renderable by scientific notebooks.
|
default <T> Object |
display(Map<?,T> map,
String colHeader)
Converts the given map data to a form renderable by scientific notebooks.
|
Object |
display(Object source)
Converts the given object to a form renderable by scientific notebooks.
|
default <T extends RealType<T>> |
display(RandomAccessibleInterval<T> source)
Converts the given image to a form renderable by scientific notebooks.
|
default <T extends RealType<T>> |
display(RandomAccessibleInterval<T> source,
double[] min,
double[] max)
Converts the given image to a form renderable by scientific notebooks.
|
default <T extends RealType<T>> |
display(RandomAccessibleInterval<T> source,
double min,
double max)
Converts the given image to a form renderable by scientific notebooks.
|
default <T extends RealType<T>> |
display(RandomAccessibleInterval<T> source,
int xAxis,
int yAxis,
int cAxis,
double[] min,
double[] max,
long... pos)
Converts the given image to a form renderable by scientific notebooks.
|
default <T extends RealType<T>> |
display(RandomAccessibleInterval<T> source,
int xAxis,
int yAxis,
int cAxis,
NotebookService.ValueScaling scaling,
long... pos)
Converts the given image to a form renderable by scientific notebooks.
|
default NotebookTable |
methods(Class<?> type)
Outputs a table of public methods for the given class.
|
NotebookTable |
methods(Class<?> type,
String prefix)
Outputs a table of public methods for the given class.
|
default NotebookTable |
methods(Object o)
Outputs a table of public methods for the given object.
|
default NotebookTable |
methods(Object o,
String prefix)
Outputs a table of public methods for the given object.
|
<T extends RealType<T> & NativeType<T>> |
mosaic(int[] gridLayout,
RandomAccessibleInterval<T>... images)
Organizes the given list of images into an N-dimensional mosaic.
|
default DatasetView |
view(RandomAccessibleInterval<?> source)
Conveniently wraps a
RandomAccessibleInterval into a
DefaultDatasetView. |
default DatasetView |
view(RandomAccessibleInterval<?> source,
double[] min,
double[] max)
Conveniently wraps a
RandomAccessibleInterval into a
DefaultDatasetView and presets the channel ranges to the given
minimum and maximum arrays. |
default DatasetView |
view(RandomAccessibleInterval<?> source,
double min,
double max)
Conveniently wraps a
RandomAccessibleInterval into a
DefaultDatasetView and presets the channel ranges to the given
minimum and maximum values. |
<T extends RealType<T>> |
viewRealType(RandomAccessibleInterval<T> source)
Conveniently wraps a
RandomAccessibleInterval of RealType
into a DefaultDatasetView and presets the channel ranges to the
given minimum and maximum arrays. |
initialize, registerEventHandlersgetIdentifier, logcontext, getContext, setContextcompareTo, getPriority, setPrioritygetInfo, setInfogetLocationgetVersiondisposeObject display(Object source)
source - The object to render.default Object display(Map<?,?> map)
The map is treated as a single-column table, with each key of the map
defining the row header for a particular row, and the corresponding value
containing the cell of data. See Tables.wrap(Map, String).
map - Map data to render.default <T> Object display(Map<?,T> map, String colHeader)
display(Map, String) for details.
The map is treated as a single-column table, with each key of the map
defining the row header for a particular row, and the corresponding value
containing the cell of data. See Tables.wrap(Map, String).
map - Map data to render.colHeader - Table column header label. Pass null for no column header.default Object display(List<?> list)
display(List, String, List) for details.list - List data to render.default Object display(List<?> list, String colHeader)
display(List, String, List) for details.list - List data to render.colHeader - Table column header label. Pass null for no column header.Tables.wrap(java.util.Map<?, T>, java.lang.String)default Object display(List<?> list, List<String> rowHeaders)
display(List, String, List) for details.list - List data to render.rowHeaders - List of table row header labels. Pass null for no row
headers.Tables.wrap(java.util.Map<?, T>, java.lang.String)default <T> Object display(List<T> list, String colHeader, List<String> rowHeaders)
Three sorts of lists are supported:
Tables.wrap(List, List).Tables.wrap(List, String, List).list - List data to render; see above for details.colHeader - Table column header label. Pass null for no column header.rowHeaders - List of table row header labels. Pass null for no row
headers.default Object display(Dataset source)
source - The image to render.default <T extends RealType<T>> Object display(RandomAccessibleInterval<T> source)
source - The image to render.default <T extends RealType<T>> Object display(RandomAccessibleInterval<T> source, double min, double max)
source - The image to render.min - The minimum value allowed on the display.max - The maximum value allowed on the display.default <T extends RealType<T>> Object display(RandomAccessibleInterval<T> source, double[] min, double[] max)
source - The image to render.min - The minimum value per dimension allowed on the display.max - The maximum value per dimension allowed on the display.default <T extends RealType<T>> Object display(RandomAccessibleInterval<T> source, int xAxis, int yAxis, int cAxis, NotebookService.ValueScaling scaling, long... pos)
source - The image to render.xAxis - The image dimension to use for the X axis.yAxis - The image dimension to use for the Y axis.cAxis - The image dimension to use for compositing multiple channels,
or -1 for no compositing.scaling - Value scaling strategy; see NotebookService.ValueScaling.pos - Dimensional position of the image. Passing null or the empty
array will display the default (typically the first) position.default <T extends RealType<T>> Object display(RandomAccessibleInterval<T> source, int xAxis, int yAxis, int cAxis, double[] min, double[] max, long... pos)
source - The image to render.xAxis - The image dimension to use for the X axis.yAxis - The image dimension to use for the Y axis.cAxis - The image dimension to use for compositing multiple channels,
or -1 for no compositing.min - The minimum value per dimension allowed on the displaymax - The maximum value per dimension allowed on the displaypos - Dimensional position of the image. Passing null or the empty
array will display the default (typically the first) position.<T extends RealType<T> & NativeType<T>> RandomAccessibleInterval<T> mosaic(int[] gridLayout, RandomAccessibleInterval<T>... images)
For example, passing a grid layout of {2, 2} with four images {A, B, C, D} will result in them being laid out along the first two axes (let's call them X and Y) in a 2 x 2 grid:
AB CD
The images do not need to be of equal size; images will be padded along each dimension as needed so that everything lines up in a grid. In the example above, if A and C have different widths, then the first column will be as wide as the wider of the two. Same for the second column with images B and D. If A and B have different heights, than the first row will be as tall as the taller of the two. And same for the second row with images C and D.
Normally, the number of grid cells (i.e., the product of the grid dimensions) should match the given number of images. However, the algorithm handles a mismatch in either direction. If the number of grid cells is less than the number of images, than the excess images are discarded—i.e., they will not appear anywhere in the mosaic. On the other hand, if the number of grid cells exceeds the given number of images, then some grid cells will be empty. The cells are filled along the first dimension fastest, so e.g. a grid layout of {2, 3, 2} will fill as follows: 000, 100, 010, 110, 020, 120, 001, 101, 011, 111, 021, 121.
gridLayout - Dimensions of the grid.images - Images to combine into the mosaic.default NotebookTable methods(Object o)
o - The object for which to generate a table of its methods.default NotebookTable methods(Object o, String prefix)
o - The object for which to generate a table of its methods.prefix - The starting characters to use for limiting method names.default NotebookTable methods(Class<?> type)
type - The class for which to generate a table of its methods.NotebookTable methods(Class<?> type, String prefix)
type - The class for which to generate a table of its methods.prefix - The starting characters to use for limiting method names.default DatasetView view(RandomAccessibleInterval<?> source)
RandomAccessibleInterval into a
DefaultDatasetView.source - - the input datadefault DatasetView view(RandomAccessibleInterval<?> source, double min, double max)
RandomAccessibleInterval into a
DefaultDatasetView and presets the channel ranges to the given
minimum and maximum values.source - - the input datamin - - the minimum for the channel rangesmax - - the maximum for the channel rangesdefault DatasetView view(RandomAccessibleInterval<?> source, double[] min, double[] max)
RandomAccessibleInterval into a
DefaultDatasetView and presets the channel ranges to the given
minimum and maximum arrays.source - - the input datamin - - the minimum for the channel rangesmax - - the maximum for the channel ranges<T extends RealType<T>> DatasetView viewRealType(RandomAccessibleInterval<T> source)
RandomAccessibleInterval of RealType
into a DefaultDatasetView and presets the channel ranges to the
given minimum and maximum arrays.source - - the input dataCopyright © 2014–2022 ImageJ. All rights reserved.