napari_ndev.nimage
#
Additional functionality for BioImage objects to be used in napari-ndev.
nImage
#
Bases: BioImage
An nImage is a BioImage with additional functionality for napari-ndev.
Parameters:
-
image
#ImageLike
) –Image to be loaded. Can be a path to an image file, a numpy array, or an xarray DataArray.
-
reader
#Reader
, default:None
) –Reader to be used to load the image. If not provided, a reader will be determined based on the image type.
Attributes:
-
See BioImage for inherited attributes.
–
Methods:
-
get_napari_image_data
–Get the image data as a xarray, optionally loading it into memory.
Source code in src/napari_ndev/nimage.py
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
|
__init__
#
__init__(image, reader=None)
Initialize an nImage with an image, and optionally a reader.
Source code in src/napari_ndev/nimage.py
46 47 48 49 50 51 52 53 54 55 |
|
get_napari_image_data
#
get_napari_image_data(in_memory=None)
Get the image data as a xarray DataArray.
From BioImage documentation:
If you do not want the image pre-stitched together, you can use the base reader
by either instantiating the reader independently or using the .reader
property.
Parameters:
-
in_memory
#bool
, default:None
) –Whether to load the image in memory or not. If None, will determine whether to load in memory based on the image size.
Returns:
-
DataArray
–Image data as a xarray DataArray.
Source code in src/napari_ndev/nimage.py
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
|
get_napari_metadata
#
get_napari_metadata(path)
Get the metadata for the image to be displayed in napari.
Parameters:
-
path
#PathLike
) –Path to the image file.
Returns:
-
dict
–Metadata for the image to be displayed in napari.
Source code in src/napari_ndev/nimage.py
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
|