IDS Peak comfortSDK, genericSDK, IPL, and AFL developer manuals are external documents. Please contact us if you need them.
Format of the image pixels. It represents all the information provided by PixelSize and PixelColorFilter combined in a single feature.
This information can be output as a chunk via the ChunkSelector. |
Name |
PixelFormat |
Category |
|
Interface |
Enumeration |
Access |
Read/Write |
Unit |
- |
Visibility |
Beginner |
Values |
Mono8 Mono10 Mono12 Mono16 Mono10p Mono12p Mono12g24IDS BayerBG8 BayerBG10 BayerBG12 BayerBG10p BayerBG12p BayerBG10g40IDS BayerBG12g24IDS BayerGB8 BayerGB10 BayerGB12 BayerGB10p BayerGB12p BayerGB10g40IDS BayerGB12g24IDS BayerGR8 BayerGR10 BayerGR12 BayerGR10p BayerGR12p BayerGR10g40IDS BayerGR12g24IDS BayerRG8 BayerRG10 BayerRG12 BayerRG16 BayerRG10p BayerRG12p BayerRG10g40IDS BayerRG12g24IDS RGB8 RGB10p32 BGR8 BGR10p32 YUV422_8_UYVY |
Standard |
SFNC |
Availability uEye+ |
|
Availability uEye |
|
Values description
•Mono8: Monochrome, with an image size of 8 bits per pixel.
•Mono10: Monochrome, with an image size of 10 bits per pixel, unpacked.
•Mono12: Monochrome, with an image size of 12 bits per pixel, unpacked.
•Mono16: Monochrome, with an image size of 16 bits per pixel, unpacked. This feature is only supported by uEye cameras (UI models).
•Mono10p: Monochrome, with an image size of 10 bits per pixel, packed. This feature is only supported by uEye+ cameras (GV and U3 models).
•Mono12p: Monochrome, with an image size of 12 bits per pixel, packed. This feature is only supported by uEye+ cameras (GV and U3 models).
•Mono10g40IDS: Monochrome, with an image size of 10 bits per pixel, lsb grouped into 40 bits. This pixel format is preliminary and its name and value may change in a future product version. This feature is only supported by uEye+ cameras (GV and U3 models).
•Mono12g24IDS: Monochrome, with an image size of 12 bits per pixel, lsb grouped into 24 bits. This pixel format is preliminary and its name and value may change in a future product version. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerBG8: Bayer blue green filter, with an image size of 8 bits per pixel. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerBG10: Bayer blue green filter, with an image size of 10 bits per pixel, unpacked. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerBG12: Bayer blue green filter, with an image size of 12 bits per pixel, unpacked. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerBG10p: Bayer blue green filter, with an image size of 10 bits per pixel, packed. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerBG12p: Bayer blue green filter, with an image size of 12 bits per pixel, packed. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerBG10g40IDS: Bayer blue green filter, with an image size of 10 bits per pixel, lsb grouped into 40 bits. This pixel format is preliminary and its name and value may change in a future product version. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerBG12g24IDS: Bayer blue green filter, with an image size of 12 bits per pixel, lsb grouped into 24 bits. This pixel format is preliminary and its name and value may change in a future product version. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerGB8: Bayer green blue filter, with an image size of 8 bits per pixel. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerGB10: Bayer green blue filter, with an image size of 10 bits per pixel, unpacked. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerGB12: Bayer green blue filter, with an image size of 12 bits per pixel, unpacked. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerGB10p: Bayer green blue filter, with an image size of 10 bits per pixel, packed. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerGB12p: Bayer green blue filter, with an image size of 12 bits per pixel, packed. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerGB10g40IDS: Bayer green blue filter, with an image size of 10 bits per pixel, lsb grouped into 40 bits. This pixel format is preliminary and its name and value may change in a future product version. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerGB12g24IDS: Bayer green blue filter, with an image size of 12 bits per pixel, lsb grouped into 24 bits. This pixel format is preliminary and its name and value may change in a future product version. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerGR8: Bayer green red filter, with an image size of 8 bits per pixel. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerGR10: Bayer green red filter, with an image size of 10 bits per pixel, unpacked. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerGR12: Bayer green red filter, with an image size of 12 bits per pixel, unpacked. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerGR10p: Bayer green red filter, with an image size of 10 bits per pixel, packed. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerGR12p: Bayer green red filter, with an image size of 12 bits per pixel, packed. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerGR10g40IDS: Bayer green red filter, with an image size of 10 bits per pixel, lsb grouped into 40 bits. This pixel format is preliminary and its name and value may change in a future product version. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerGR12g24IDS: Bayer green red filter, with an image size of 12 bits per pixel, lsb grouped into 24 bits. This pixel format is preliminary and its name and value may change in a future product version. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerRG8: Bayer red green filter, with an image size of 8 bits per pixel.
•BayerRG10: Bayer red green filter, with an image size of 10 bits per pixel, unpacked.
•BayerRG12: Bayer red green filter, with an image size of 12 bits per pixel, unpacked.
•BayerRG16: Bayer red green filter, with an image size of 16 bits per pixel, unpacked. This feature is only supported by uEye cameras (UI models).
•BayerRG10p: Bayer red green filter, with an image size of 10 bits per pixel, packed. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerRG12p: Bayer red green filter, with an image size of 12 bits per pixel, packed. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerRG10g40IDS: Bayer red green filter, with an image size of 10 bits per pixel, lsb grouped into 40 bits. This pixel format is preliminary and its name and value may change in a future product version. This feature is only supported by uEye+ cameras (GV and U3 models).
•BayerRG12g24IDS: Bayer red green filter, with an image size of 12 bits per pixel, lsb grouped into 24 bits. This pixel format is preliminary and its name and value may change in a future product version. This feature is only supported by uEye+ cameras (GV and U3 models).
•RGB8: Red, green, blue, with an image size of 8 bits per pixel. This feature is only supported by uEye+ cameras (GV and U3 models).
•RGB10p32: Red, green, blue, 10 bits packed at an image size of 32 bits per pixel. This feature is only supported by uEye+ cameras (GV and U3 models).
•BGR8: Blue, green, red, with an image size of 8 bits per pixel. This feature is only supported by uEye+ cameras (GV and U3 models).
•BGR10p32: Blue, green, red, 10 bits packed at an image size of 32 bits per pixel. This feature is only supported by uEye+ cameras (GV and U3 models).
•YUV422_8_UYVY: UYVY 4:2:2, with ah image size of 8 bits per pixel, packed. This feature is only supported by uEye+ cameras (GV and U3 models).
Debayered PixelFormats "RGB8", "RGB10p32", "BGR8" and "BGR10p32" are not available in the SensorOperationMode "Linescan". |
Some pixel formats might not be supported if you are using third party software. Make sure that your selected pixel format is supported. |
Can only be changed if SequencerMode is "Off". |
Code example
C++
// Determine the current entry of PixelFormat
std::string value = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("PixelFormat")->CurrentEntry()->SymbolicValue();
// Get a list of all available entries of PixelFormat
auto allEntries = nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("PixelFormat")->Entries();
std::vector<std::shared_ptr<peak::core::nodes::EnumerationEntryNode>> availableEntries;
for(const auto & entry : allEntries)
{
if ((entry->AccessStatus()!=peak::core::nodes::NodeAccessStatus::NotAvailable)
&& (entry->AccessStatus()!=peak::core::nodes::NodeAccessStatus::NotImplemented))
{
availableEntries.emplace_back(entry);
}
}
// Set PixelFormat to "BayerRG8"
nodeMapRemoteDevice->FindNode<peak::core::nodes::EnumerationNode>("PixelFormat")->SetCurrentEntry("BayerRG8");
C#
// Determine the current entry of PixelFormat
string value = nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("PixelFormat").CurrentEntry().SymbolicValue();
// Get a list of all available entries of PixelFormat
allEntries = nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("PixelFormat").Entries();
List<string> availableEntries = new List<string>();
for(int i = 0; i < allEntries.Count(); ++i)
{
if ((allEntries[i].AccessStatus() != peak.core.nodes.NodeAccessStatus.NotAvailable)
&& (allEntries[i].AccessStatus() != peak.core.nodes.NodeAccessStatus.NotImplemented))
{
availableEntries.Add(allEntries[i].SymbolicValue());
}
}
// Set PixelFormat to "BayerRG8"
nodeMapRemoteDevice.FindNode<peak.core.nodes.EnumerationNode>("PixelFormat").SetCurrentEntry("BayerRG8");
Python
# Determine the current entry of PixelFormat (str)
value = nodeMapRemoteDevice.FindNode("PixelFormat").CurrentEntry().SymbolicValue()
# Get a list of all available entries of PixelFormat
allEntries = nodeMapRemoteDevice.FindNode("PixelFormat").Entries()
availableEntries = []
for entry in allEntries:
if (entry.AccessStatus() != ids_peak.NodeAccessStatus_NotAvailable
and entry.AccessStatus() != ids_peak.NodeAccessStatus_NotImplemented):
availableEntries.append(entry.SymbolicValue())
# Set PixelFormat to "BayerRG8" (str)
nodeMapRemoteDevice.FindNode("PixelFormat").SetCurrentEntry("BayerRG8")