add help docs and ?
This commit is contained in:
28
docs/nodes/Image.md
Normal file
28
docs/nodes/Image.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# Image
|
||||
|
||||
Load any supported file. SPM formats (.gwy, .sxm, .ibw) and HDF5 (.h5, .hdf5) provide calibrated dimensions; each channel gets its own output. Images (.png, .tiff, .jpg) and arrays (.npy, .npz) are loaded as uncalibrated fields.
|
||||
|
||||
## Inputs
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|------|------|----------|-------------|
|
||||
| path | FILE_PATH | No | File path input from a Folder node or other path source; overrides the filename widget |
|
||||
|
||||
## Outputs
|
||||
|
||||
| Name | Type | Description |
|
||||
|------|------|-------------|
|
||||
| path | FILE_PATH | Resolved absolute file path |
|
||||
| field | DATA_FIELD | Loaded data field (one per channel for multi-channel formats) |
|
||||
|
||||
## Controls
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
|------|------|---------|-------------|
|
||||
| filename | FILE_PICKER | "" | Path to the file to load; hidden when path input is connected |
|
||||
| colormap | dropdown | viridis | Colormap applied to the loaded field; hidden when colormap_map is connected |
|
||||
|
||||
## Limitations
|
||||
|
||||
- Uncalibrated formats (images, arrays) emit a warning and produce fields without physical dimensions.
|
||||
- Multi-channel files (e.g. .gwy with multiple data channels) produce one DATA_FIELD output socket per channel; the socket count is determined at load time.
|
||||
Reference in New Issue
Block a user