10.111. Read Image
Group (Subgroup)
IO (Input)
Description
Reads a single 2D image file into a newly created Image Geometry. To read a numbered sequence of slices into a 3D volume instead, use Read Images [3D Stack].
This filter does not depend on ITK. It uses stb_image for PNG/JPEG/BMP files and libtiff for TIFF files.
The following image types are supported:
PNG (via stb)
JPEG / JPG (via stb)
BMP (via stb)
TIFF / TIF (via libtiff)
Origin & Spacing Caveats
The user can optionally override the origin and spacing for the imported image. Spacing is the physical size of each pixel and Origin is the coordinate of the lower-left corner of the geometry; both are expressed in the same physical length units (for example microns). The default values from the input file will be used unless the user explicitly enables the “Set Origin” and/or “Set Spacing” options.
When setting a custom origin, the user can choose whether to place the origin at the corner of the geometry (default) or at the center of the geometry by enabling the “Put Input Origin at the Center of Geometry” option.
Origin & Spacing Processing
The Origin & Spacing Processing parameter provides the following choices:
Preprocessed [0]: Origin and spacing overrides are applied before any cropping operations.
Postprocessed [1]: Origin and spacing overrides are applied after cropping operations.
Output Data Type
The Output Data Type parameter provides the following choices:
uint8 [0]: Convert image data to 8-bit unsigned integer.
uint16 [1]: Convert image data to 16-bit unsigned integer.
uint32 [2]: Convert image data to 32-bit unsigned integer.
Data Type Conversion
The user can optionally convert the image data to a different data type by enabling the “Set Image Data Type” option. Conversion is performed by normalizing the source value against the source type’s maximum and scaling to the destination type’s maximum.
Cropping Caveats
The user can crop the incoming 2D image using the Cropping Options section. The cropping type options are:
No Cropping: Read the full image into an image geometry
Voxel Subvolume: Crop the image using voxel (pixel) coordinates
Physical Subvolume: Crop the image using physical coordinates
Both subvolume cropping types have checkboxes to turn on/off cropping in the X and Y dimensions. For example, if Physical Subvolume is selected and only Crop Y Dimension is enabled, the image will be cropped in the Y dimension only using physical coordinate bounds.
Required Input Sources
None — this filter reads directly from a single image file on disk.
Input Parameter(s)
Parameter Name |
Parameter Type |
Parameter Notes |
Description |
|---|---|---|---|
File |
FileSystemPath |
Input image file |
|
Length Unit |
Choices |
The length unit that will be set into the created image geometry |
|
Set Image Data Type |
Bool |
Set the final created image data type. |
|
Output Data Type |
Choices |
Numeric Type of data to create |
Origin & Spacing Options
Parameter Name |
Parameter Type |
Parameter Notes |
Description |
|---|---|---|---|
Set Origin |
Bool |
Specifies if the origin should be changed |
|
Put Input Origin at the Center of Geometry |
Bool |
Specifies if the origin should be aligned with the corner (false) or center (true) |
|
Origin (Physical Units) |
Vector of Float32 Values |
Order=X,Y,Z |
Specifies the new origin values in physical units. |
Set Spacing |
Bool |
Specifies if the spacing should be changed |
|
Spacing (Physical Units) |
Vector of Float32 Values |
Order=X,Y,Z |
Specifies the new spacing values in physical units. |
Origin & Spacing Processing |
Choices |
Whether the origin & spacing should be preprocessed or postprocessed. |
Cropping Options
Parameter Name |
Parameter Type |
Parameter Notes |
Description |
|---|---|---|---|
Cropping Options |
CropGeometry |
The cropping options used to crop images. These include picking the cropping type, the cropping dimensions, and the cropping ranges for each chosen dimension. |
Output Data Object(s)
Parameter Name |
Parameter Type |
Parameter Notes |
Description |
|---|---|---|---|
Created Image Geometry |
DataGroupCreation |
The path to the created Image Geometry |
|
Created Cell Attribute Matrix |
DataObjectName |
The name of the created cell attribute matrix |
|
Created Cell Data |
DataObjectName |
The name of the created image data array. Will be stored in the created Cell Attribute Matrix |
Example Pipelines
License & Copyright
Please see the description file distributed with this plugin.
DREAM3D-NX Help
If you need help, need to file a bug report or want to request a new feature, please head over to the DREAM3DNX-Issues GitHub site where the community of DREAM3D-NX users can help answer your questions.