Jetson Inference: imageLoader Class Reference - Jetson Inference

| | Jetson Inference

DNN Vision Library |

imageLoader Class Reference Utilities Library (jetson-utils) » Image I/O

Load an image or set of images from disk into GPU memory. More...

#include <imageLoader.h>

Inheritance diagram for imageLoader:

Public Member Functions

Static Public Member Functions

| | static imageLoader * | Create (const char *path, const videoOptions &options=videoOptions()) | | | Create an imageLoader instance from a path and optional videoOptions. More...
| | | | static imageLoader * | Create (const videoOptions &options) | | | Create an imageLoader instance from the provided video options. More...
| | | | static bool | IsSupportedExtension (const char *ext) | | | Return true if the extension is in the list of SupportedExtensions. More...
| | | | Static Public Member Functions inherited from videoSource | | static videoSource * | Create (const videoOptions &options) | | | Create videoSource interface from a videoOptions struct that's already been filled out. More...
| | | | static videoSource * | Create (const char *URI, const videoOptions &options=videoOptions()) | | | Create videoSource interface from a resource URI string and optional videoOptions. More...
| | | | static videoSource * | Create (const char *URI, const commandLine &cmdLine) | | | Create videoSource interface from a resource URI string and parsing command line arguments. More...
| | | | static videoSource * | Create (const char *URI, const int argc, char **argv) | | | Create videoSource interface from a resource URI string and parsing command line arguments. More...
| | | | static videoSource * | Create (const int argc, char **argv, int positionArg=-1) | | | Create videoSource interface by parsing command line arguments, including the resource URI. More...
| | | | static videoSource * | Create (const commandLine &cmdLine, int positionArg=-1) | | | Create videoSource interface by parsing command line arguments, including the resource URI. More...
| | | | static const char * | Usage () | | | Usage string for command line arguments to Create()More...
| | | | static const char * | TypeToStr (uint32_t type) | | | Convert a class type to a string. More...
| | |

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

| | Public Types inherited from videoSource | | enum | Status { ERROR = -2, EOS = -1, TIMEOUT = 0, OK = 1 } | | | Stream status codes that are optionally returned from Capture()More...
| | |

Detailed Description

Load an image or set of images from disk into GPU memory.

Supported image formats for loading are JPG, PNG, TGA, BMP, GIF, PSD, HDR, PIC, and PNM (PPM/PGM binary). Internally, imageLoader uses the loadImage() function to load the images, so the supported formats are the same.

imageLoader has the ability to load an sequence of images from a directory, including wildcard characters (e.g. images/*.jpg), or just a single image. When given just the path to a directory, it will load all valid images from that directory.

NoteimageLoader implements the videoSource interface and is intended to be used through that as opposed to directly. videoSource implements additional command-line parsing of videoOptions to construct instances.See alsovideoSource

Constructor & Destructor Documentation

◆~imageLoader()

| virtual imageLoader::~imageLoader | ( | | ) | |

| virtual |

Destructor.

◆imageLoader()

| protected |

Member Function Documentation

◆Capture()

| virtual |

Load the next frame.

◆Close()

| virtual void imageLoader::Close | ( | | ) | |

| virtual |

Close the stream.

◆Create() [1/2]

| static |

Create an imageLoader instance from a path and optional videoOptions.

◆Create() [2/2]

| static |

Create an imageLoader instance from the provided video options.

◆GetType()

| virtual uint32_t imageLoader::GetType | ( | | ) | const |

| inlinevirtual |

Return the interface type (imageLoader::Type)

Reimplemented from videoSource.

◆IsEOS()

| bool imageLoader::IsEOS | ( | | ) | const |

| inline |

Return true if End Of Stream (EOS) has been reached.

In the context of imageLoader, EOS means that all images in the sequence have been loaded, and looping is either disabled or all loops have already been run.

◆isLooping()

| bool imageLoader::isLooping | ( | | ) | const |

| inlineprotected |

◆IsSupportedExtension()

| static bool imageLoader::IsSupportedExtension | ( | const char * | ext | ) | |

| static |

Return true if the extension is in the list of SupportedExtensions.

Parameters

| ext | string containing the extension to be checked (should not contain leading dot) |

See alsoSupportedExtensions for the list of supported Video Streaming file extensions.

◆Open()

| virtual bool imageLoader::Open | ( | | ) | |

| virtual |

Open the stream.

Member Data Documentation

◆mBuffers

| std::vector<void*> imageLoader::mBuffers |

| protected |

◆mEOS

| bool imageLoader::mEOS |

| protected |

◆mFiles

| std::vector<std::string> imageLoader::mFiles |

| protected |

◆mLoopCount

| size_t imageLoader::mLoopCount |

| protected |

◆mNextFile

| size_t imageLoader::mNextFile |

| protected |

◆SupportedExtensions

| const char* imageLoader::SupportedExtensions[] |

| static |

String array of supported image file extensions, terminated with a NULL sentinel value.

The supported extension are:

JPG / JPEG
PNG
TGA / TARGA
BMP
GIF
- PSD
HDR
PIC
PNM / PBM / PPM / PGM

See alsoIsSupportedExtension() to check a string against this list.

◆Type

| const uint32_t imageLoader::Type = (1 << 4) |

| static |

Unique type identifier of imageLoader class.

The documentation for this class was generated from the following file:

jetson-utils/imageLoader.h
imageLoader
Generated on Fri Mar 17 2023 14:29:30 for Jetson Inference by 1.8.17