AMD rocAL - Data Loaders API

AMD rocAL - Data Loaders API#

rocAL: API: AMD rocAL - Data Loaders API
API: AMD rocAL - Data Loaders API

The AMD rocAL data loader functions. More...

Functions

RocalImage ROCAL_API_CALL rocalJpegFileSource (RocalContext context, const char *source_path, RocalImageColor rocal_color_format, unsigned internal_shard_count, bool is_output, bool shuffle=false, bool loop=false, RocalImageSizeEvaluationPolicy decode_size_policy=ROCAL_USE_MOST_FREQUENT_SIZE, unsigned max_width=0, unsigned max_height=0, RocalDecoderType rocal_decoder_type=RocalDecoderType::ROCAL_DECODER_TJPEG)
 Creates JPEG image reader and decoder. It allocates the resources and objects required to read and decode Jpeg images stored on the file systems. It has internal sharding capability to load/decode in parallel is user wants. If images are not Jpeg compressed they will be ignored. More...
 
RocalImage ROCAL_API_CALL rocalJpegFileSourceSingleShard (RocalContext context, const char *source_path, RocalImageColor rocal_color_format, unsigned shard_id, unsigned shard_count, bool is_output, bool shuffle=false, bool loop=false, RocalImageSizeEvaluationPolicy decode_size_policy=ROCAL_USE_MOST_FREQUENT_SIZE, unsigned max_width=0, unsigned max_height=0, RocalDecoderType rocal_decoder_type=RocalDecoderType::ROCAL_DECODER_TJPEG)
 Creates JPEG image reader and decoder. It allocates the resources and objects required to read and decode Jpeg images stored on the file systems. It accepts external sharding information to load a singe shard. only. More...
 
RocalImage ROCAL_API_CALL rocalSequenceReader (RocalContext context, const char *source_path, RocalImageColor rocal_color_format, unsigned internal_shard_count, unsigned sequence_length, bool is_output, bool shuffle=false, bool loop=false, unsigned step=0, unsigned stride=0)
 Creates JPEG image reader and decoder. Reads [Frames] sequences from a directory representing a collection of streams. More...
 
RocalImage ROCAL_API_CALL rocalSequenceReaderSingleShard (RocalContext context, const char *source_path, RocalImageColor rocal_color_format, unsigned shard_id, unsigned shard_count, unsigned sequence_length, bool is_output, bool shuffle=false, bool loop=false, unsigned step=0, unsigned stride=0)
 Creates JPEG image reader and decoder. Reads [Frames] sequences from a directory representing a collection of streams. It accepts external sharding information to load a singe shard only. More...
 
RocalImage ROCAL_API_CALL rocalJpegCOCOFileSource (RocalContext context, const char *source_path, const char *json_path, RocalImageColor color_format, unsigned internal_shard_count, bool is_output, bool shuffle=false, bool loop=false, RocalImageSizeEvaluationPolicy decode_size_policy=ROCAL_USE_MOST_FREQUENT_SIZE, unsigned max_width=0, unsigned max_height=0, RocalDecoderType rocal_decoder_type=RocalDecoderType::ROCAL_DECODER_TJPEG)
 Creates JPEG image reader and decoder. It allocates the resources and objects required to read and decode COCO Jpeg images stored on the file systems. It has internal sharding capability to load/decode in parallel is user wants. If images are not Jpeg compressed they will be ignored. More...
 
RocalImage ROCAL_API_CALL rocalJpegCOCOFileSourcePartial (RocalContext p_context, const char *source_path, const char *json_path, RocalImageColor rocal_color_format, unsigned internal_shard_count, bool is_output, std::vector< float > &area_factor, std::vector< float > &aspect_ratio, unsigned num_attempts, bool shuffle=false, bool loop=false, RocalImageSizeEvaluationPolicy decode_size_policy=ROCAL_USE_MOST_FREQUENT_SIZE, unsigned max_width=0, unsigned max_height=0)
 Creates JPEG image reader and partial decoder. It allocates the resources and objects required to read and decode COCO Jpeg images stored on the file systems. It has internal sharding capability to load/decode in parallel is user wants. If images are not Jpeg compressed they will be ignored. More...
 
RocalImage ROCAL_API_CALL rocalJpegCOCOFileSourcePartialSingleShard (RocalContext p_context, const char *source_path, const char *json_path, RocalImageColor rocal_color_format, unsigned shard_id, unsigned shard_count, bool is_output, std::vector< float > &area_factor, std::vector< float > &aspect_ratio, unsigned num_attempts, bool shuffle=false, bool loop=false, RocalImageSizeEvaluationPolicy decode_size_policy=ROCAL_USE_MOST_FREQUENT_SIZE, unsigned max_width=0, unsigned max_height=0)
 Creates JPEG image reader and partial decoder. It allocates the resources and objects required to read and decode COCO Jpeg images stored on the file systems. It has internal sharding capability to load/decode in parallel is user wants. If images are not Jpeg compressed they will be ignored. More...
 
RocalImage ROCAL_API_CALL rocalJpegCOCOFileSourceSingleShard (RocalContext context, const char *source_path, const char *json_path, RocalImageColor color_format, unsigned shard_id, unsigned shard_count, bool is_output, bool shuffle=false, bool loop=false, RocalImageSizeEvaluationPolicy decode_size_policy=ROCAL_USE_MOST_FREQUENT_SIZE, unsigned max_width=0, unsigned max_height=0, RocalDecoderType rocal_decoder_type=RocalDecoderType::ROCAL_DECODER_TJPEG)
 
RocalImage ROCAL_API_CALL rocalJpegCaffeLMDBRecordSource (RocalContext context, const char *source_path, RocalImageColor rocal_color_format, unsigned internal_shard_count, bool is_output, bool shuffle=false, bool loop=false, RocalImageSizeEvaluationPolicy decode_size_policy=ROCAL_USE_MOST_FREQUENT_SIZE, unsigned max_width=0, unsigned max_height=0, RocalDecoderType rocal_decoder_type=RocalDecoderType::ROCAL_DECODER_TJPEG)
 Creates JPEG image reader and decoder for Caffe LMDB records. It allocates the resources and objects required to read and decode Jpeg images stored in Caffe LMDB Records. It has internal sharding capability to load/decode in parallel is user wants. If images are not Jpeg compressed they will be ignored. More...
 
RocalImage ROCAL_API_CALL rocalJpegCaffeLMDBRecordSourceSingleShard (RocalContext p_context, const char *source_path, RocalImageColor rocal_color_format, unsigned shard_id, unsigned shard_count, bool is_output, bool shuffle=false, bool loop=false, RocalImageSizeEvaluationPolicy decode_size_policy=ROCAL_USE_MOST_FREQUENT_SIZE, unsigned max_width=0, unsigned max_height=0, RocalDecoderType rocal_decoder_type=RocalDecoderType::ROCAL_DECODER_TJPEG)
 Creates JPEG image reader and decoder for Caffe LMDB records. It allocates the resources and objects required to read and decode Jpeg images stored in Caffe2 LMDB Records. It has internal sharding capability to load/decode in parallel is user wants. More...
 
RocalImage ROCAL_API_CALL rocalJpegCaffe2LMDBRecordSource (RocalContext context, const char *source_path, RocalImageColor rocal_color_format, unsigned internal_shard_count, bool is_output, bool shuffle=false, bool loop=false, RocalImageSizeEvaluationPolicy decode_size_policy=ROCAL_USE_MOST_FREQUENT_SIZE, unsigned max_width=0, unsigned max_height=0, RocalDecoderType rocal_decoder_type=RocalDecoderType::ROCAL_DECODER_TJPEG)
 Creates JPEG image reader and decoder for Caffe2 LMDB records. It allocates the resources and objects required to read and decode Jpeg images stored in Caffe2 LMDB Records. It has internal sharding capability to load/decode in parallel is user wants. If images are not Jpeg compressed they will be ignored. More...
 
RocalImage ROCAL_API_CALL rocalJpegCaffe2LMDBRecordSourceSingleShard (RocalContext p_context, const char *source_path, RocalImageColor rocal_color_format, unsigned shard_id, unsigned shard_count, bool is_output, bool shuffle=false, bool loop=false, RocalImageSizeEvaluationPolicy decode_size_policy=ROCAL_USE_MOST_FREQUENT_SIZE, unsigned max_width=0, unsigned max_height=0, RocalDecoderType rocal_decoder_type=RocalDecoderType::ROCAL_DECODER_TJPEG)
 Creates JPEG image reader and decoder for Caffe2 LMDB records. It allocates the resources and objects required to read and decode Jpeg images stored on the Caffe2 LMDB Records. It accepts external sharding information to load a singe shard. only. More...
 
RocalImage ROCAL_API_CALL rocalMXNetRecordSource (RocalContext context, const char *source_path, RocalImageColor rocal_color_format, unsigned internal_shard_count, bool is_output, bool shuffle=false, bool loop=false, RocalImageSizeEvaluationPolicy decode_size_policy=ROCAL_USE_MOST_FREQUENT_SIZE, unsigned max_width=0, unsigned max_height=0, RocalDecoderType rocal_decoder_type=RocalDecoderType::ROCAL_DECODER_TJPEG)
 Creates JPEG image reader and decoder for MXNet records. It allocates the resources and objects required to read and decode Jpeg images stored in MXNet Records. It has internal sharding capability to load/decode in parallel is user wants. If images are not Jpeg compressed they will be ignored. More...
 
RocalImage ROCAL_API_CALL rocalMXNetRecordSourceSingleShard (RocalContext p_context, const char *source_path, RocalImageColor rocal_color_format, unsigned shard_id, unsigned shard_count, bool is_output, bool shuffle=false, bool loop=false, RocalImageSizeEvaluationPolicy decode_size_policy=ROCAL_USE_MOST_FREQUENT_SIZE, unsigned max_width=0, unsigned max_height=0, RocalDecoderType rocal_decoder_type=RocalDecoderType::ROCAL_DECODER_TJPEG)
 Creates JPEG image reader and decoder for MXNet records. It allocates the resources and objects required to read and decode Jpeg images stored on the MXNet records. It accepts external sharding information to load a singe shard. only. More...
 
RocalImage ROCAL_API_CALL rocalFusedJpegCrop (RocalContext context, const char *source_path, RocalImageColor rocal_color_format, unsigned num_threads, bool is_output, std::vector< float > &area_factor, std::vector< float > &aspect_ratio, unsigned num_attempts, bool shuffle=false, bool loop=false, RocalImageSizeEvaluationPolicy decode_size_policy=ROCAL_USE_MOST_FREQUENT_SIZE, unsigned max_width=0, unsigned max_height=0)
 Creates JPEG image reader and partial decoder. It allocates the resources and objects required to read and decode Jpeg images stored on the file systems. It has internal sharding capability to load/decode in parallel is user wants. If images are not Jpeg compressed they will be ignored and Crops t. More...
 
RocalImage ROCAL_API_CALL rocalFusedJpegCropSingleShard (RocalContext context, const char *source_path, RocalImageColor color_format, unsigned shard_id, unsigned shard_count, bool is_output, std::vector< float > &area_factor, std::vector< float > &aspect_ratio, unsigned num_attempts, bool shuffle=false, bool loop=false, RocalImageSizeEvaluationPolicy decode_size_policy=ROCAL_USE_MOST_FREQUENT_SIZE, unsigned max_width=0, unsigned max_height=0)
 Creates JPEG image reader and partial decoder. It allocates the resources and objects required to read and decode Jpeg images stored on the file systems. It accepts external sharding information to load a singe shard. only. More...
 
RocalImage ROCAL_API_CALL rocalJpegTFRecordSource (RocalContext context, const char *source_path, RocalImageColor rocal_color_format, unsigned internal_shard_count, bool is_output, const char *user_key_for_encoded, const char *user_key_for_filename, bool shuffle=false, bool loop=false, RocalImageSizeEvaluationPolicy decode_size_policy=ROCAL_USE_MOST_FREQUENT_SIZE, unsigned max_width=0, unsigned max_height=0, RocalDecoderType rocal_decoder_type=RocalDecoderType::ROCAL_DECODER_TJPEG)
 Creates TensorFlow records JPEG image reader and decoder. It allocates the resources and objects required to read and decode Jpeg images stored on the file systems. It has internal sharding capability to load/decode in parallel is user wants. If images are not Jpeg compressed they will be ignored. More...
 
RocalImage ROCAL_API_CALL rocalJpegTFRecordSourceSingleShard (RocalContext context, const char *source_path, RocalImageColor rocal_color_format, unsigned shard_id, unsigned shard_count, bool is_output, bool shuffle=false, bool loop=false, RocalImageSizeEvaluationPolicy decode_size_policy=ROCAL_USE_MOST_FREQUENT_SIZE, unsigned max_width=0, unsigned max_height=0, RocalDecoderType rocal_decoder_type=RocalDecoderType::ROCAL_DECODER_TJPEG)
 Creates TensorFlow records JPEG image reader and decoder. It allocates the resources and objects required to read and decode Jpeg images stored on the file systems. It accepts external sharding information to load a singe shard. only. More...
 
RocalImage ROCAL_API_CALL rocalRawTFRecordSource (RocalContext p_context, const char *source_path, const char *user_key_for_raw, const char *user_key_for_filename, RocalImageColor rocal_color_format, bool is_output, bool shuffle=false, bool loop=false, unsigned out_width=0, unsigned out_height=0, const char *record_name_prefix="")
 Creates Raw image loader. It allocates the resources and objects required to load images stored on the file systems. More...
 
RocalImage ROCAL_API_CALL rocalRawTFRecordSourceSingleShard (RocalContext p_context, const char *source_path, RocalImageColor rocal_color_format, unsigned shard_id, unsigned shard_count, bool is_output, bool shuffle=false, bool loop=false, unsigned out_width=0, unsigned out_height=0, const char *record_name_prefix="")
 Creates Raw image loader. It allocates the resources and objects required to load images stored on the file systems. More...
 
RocalImage ROCAL_API_CALL rocalVideoFileSource (RocalContext context, const char *source_path, RocalImageColor color_format, RocalDecodeDevice rocal_decode_device, unsigned internal_shard_count, unsigned sequence_length, const std::vector< std::string > &file_names_list, bool is_output=false, bool shuffle=false, bool loop=false, unsigned step=0, unsigned stride=0, bool file_list_frame_num=true)
 Creates a video reader and decoder as a source. It allocates the resources and objects required to read and decode mp4 videos stored on the file systems. More...
 
RocalImage ROCAL_API_CALL rocalVideoFileSourceSingleShard (RocalContext context, const char *source_path, RocalImageColor color_format, RocalDecodeDevice rocal_decode_device, unsigned shard_id, unsigned shard_count, unsigned sequence_length, const std::vector< std::string > &file_names_list, bool shuffle=false, bool is_output=false, bool loop=false, unsigned step=0, unsigned stride=0, bool file_list_frame_num=true)
 Creates a video reader and decoder as a source. It allocates the resources and objects required to read and decode mp4 videos stored on the file systems. It accepts external sharding information to load a singe shard only. More...
 
RocalImage ROCAL_API_CALL rocalVideoFileResize (RocalContext context, const char *source_path, RocalImageColor color_format, RocalDecodeDevice rocal_decode_device, unsigned internal_shard_count, unsigned sequence_length, unsigned dest_width, unsigned dest_height, const std::vector< std::string > &file_names_list, bool shuffle=false, bool is_output=false, bool loop=false, unsigned step=0, unsigned stride=0, bool file_list_frame_num=true, RocalResizeScalingMode scaling_mode=ROCAL_SCALING_MODE_DEFAULT, std::vector< unsigned > max_size={}, unsigned resize_shorter=0, unsigned resize_longer=0, RocalResizeInterpolationType interpolation_type=ROCAL_LINEAR_INTERPOLATION)
 Creates a video reader and decoder as a source. It allocates the resources and objects required to read and decode mp4 videos stored on the file systems. Resizes the decoded frames to the dest width and height. More...
 
RocalImage ROCAL_API_CALL rocalVideoFileResizeSingleShard (RocalContext context, const char *source_path, RocalImageColor color_format, RocalDecodeDevice rocal_decode_device, unsigned shard_id, unsigned shard_count, unsigned sequence_length, unsigned dest_width, unsigned dest_height, const std::vector< std::string > &file_names_list, bool shuffle=false, bool is_output=false, bool loop=false, unsigned step=0, unsigned stride=0, bool file_list_frame_num=true, RocalResizeScalingMode scaling_mode=ROCAL_SCALING_MODE_DEFAULT, std::vector< unsigned > max_size={}, unsigned resize_shorter=0, unsigned resize_longer=0, RocalResizeInterpolationType interpolation_type=ROCAL_LINEAR_INTERPOLATION)
 Creates a video reader and decoder as a source. It allocates the resources and objects required to read and decode mp4 videos stored on the file systems. Resizes the decoded frames to the dest width and height. It accepts external sharding information to load a singe shard only. More...
 
RocalImage ROCAL_API_CALL rocalRawCIFAR10Source (RocalContext context, const char *source_path, RocalImageColor color_format, bool is_output, unsigned out_width, unsigned out_height, const char *filename_prefix="", bool loop=false)
 Creates CIFAR10 raw data reader and loader. It allocates the resources and objects required to read raw data stored on the file systems. More...
 
RocalStatus ROCAL_API_CALL rocalResetLoaders (RocalContext context)
 
RocalImage ROCAL_API_CALL rocalJpegCaffeLMDBRecordSourcePartialSingleShard (RocalContext p_context, const char *source_path, RocalImageColor rocal_color_format, unsigned shard_id, unsigned shard_count, bool is_output, std::vector< float > &area_factor, std::vector< float > &aspect_ratio, unsigned num_attempts, bool shuffle=false, bool loop=false, RocalImageSizeEvaluationPolicy decode_size_policy=ROCAL_USE_MOST_FREQUENT_SIZE, unsigned max_width=0, unsigned max_height=0)
 Creates JPEG image reader and partial decoder for Caffe LMDB records. It allocates the resources and objects required to read and decode Jpeg images stored in Caffe2 LMDB Records. It has internal sharding capability to load/decode in parallel is user wants. More...
 
RocalImage ROCAL_API_CALL rocalJpegCaffe2LMDBRecordSourcePartialSingleShard (RocalContext p_context, const char *source_path, RocalImageColor rocal_color_format, unsigned shard_id, unsigned shard_count, bool is_output, std::vector< float > &area_factor, std::vector< float > &aspect_ratio, unsigned num_attempts, bool shuffle=false, bool loop=false, RocalImageSizeEvaluationPolicy decode_size_policy=ROCAL_USE_MOST_FREQUENT_SIZE, unsigned max_width=0, unsigned max_height=0)
 Creates JPEG image reader and partial decoder for Caffe2 LMDB records. It allocates the resources and objects required to read and decode Jpeg images stored in Caffe22 LMDB Records. It has internal sharding capability to load/decode in parallel is user wants. More...
 

Detailed Description

The AMD rocAL data loader functions.

Function Documentation

◆ rocalFusedJpegCrop()

RocalImage ROCAL_API_CALL rocalFusedJpegCrop ( RocalContext  context,
const char *  source_path,
RocalImageColor  rocal_color_format,
unsigned  num_threads,
bool  is_output,
std::vector< float > &  area_factor,
std::vector< float > &  aspect_ratio,
unsigned  num_attempts,
bool  shuffle = false,
bool  loop = false,
RocalImageSizeEvaluationPolicy  decode_size_policy = ROCAL_USE_MOST_FREQUENT_SIZE,
unsigned  max_width = 0,
unsigned  max_height = 0 
)

Creates JPEG image reader and partial decoder. It allocates the resources and objects required to read and decode Jpeg images stored on the file systems. It has internal sharding capability to load/decode in parallel is user wants. If images are not Jpeg compressed they will be ignored and Crops t.

Parameters
contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
rocal_color_formatThe color format the images will be decoded to.
num_threadsDefines the parallelism level by internally sharding the input dataset and load/decode using multiple decoder/loader instances. Using shard counts bigger than 1 improves the load/decode performance if compute resources (CPU cores) are available.
is_outputDetermines if the user wants the loaded images to be part of the output or not.
area_factorDetermines how much area to be cropped. Ranges from from 0.08 - 1.
aspect_ratioDetermines the aspect ration of crop. Ranges from 0.75 to 1.33.
num_attemptsMaximum number of attempts to generate crop. Default 10
shuffleDetermines if the user wants to shuffle the dataset or not.
loopDetermines if the user wants to indefinitely loops through images or not.
decode_size_policy
max_widthThe maximum width of the decoded images, larger or smaller will be resized to closest
max_heightThe maximum height of the decoded images, larger or smaller will be resized to closest
Returns
Reference to the output image

◆ rocalFusedJpegCropSingleShard()

RocalImage ROCAL_API_CALL rocalFusedJpegCropSingleShard ( RocalContext  context,
const char *  source_path,
RocalImageColor  color_format,
unsigned  shard_id,
unsigned  shard_count,
bool  is_output,
std::vector< float > &  area_factor,
std::vector< float > &  aspect_ratio,
unsigned  num_attempts,
bool  shuffle = false,
bool  loop = false,
RocalImageSizeEvaluationPolicy  decode_size_policy = ROCAL_USE_MOST_FREQUENT_SIZE,
unsigned  max_width = 0,
unsigned  max_height = 0 
)

Creates JPEG image reader and partial decoder. It allocates the resources and objects required to read and decode Jpeg images stored on the file systems. It accepts external sharding information to load a singe shard. only.

Parameters
contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
rocal_color_formatThe color format the images will be decoded to.
shard_idShard id for this loader
shard_countTotal shard count
is_outputDetermines if the user wants the loaded images to be part of the output or not.
area_factorDetermines how much area to be cropped. Ranges from from 0.08 - 1.
aspect_ratioDetermines the aspect ration of crop. Ranges from 0.75 to 1.33.
num_attemptsMaximum number of attempts to generate crop. Default 10
decode_size_policy
max_widthThe maximum width of the decoded images, larger or smaller will be resized to closest
max_heightThe maximum height of the decoded images, larger or smaller will be resized to closest
Returns

◆ rocalJpegCaffe2LMDBRecordSource()

RocalImage ROCAL_API_CALL rocalJpegCaffe2LMDBRecordSource ( RocalContext  context,
const char *  source_path,
RocalImageColor  rocal_color_format,
unsigned  internal_shard_count,
bool  is_output,
bool  shuffle = false,
bool  loop = false,
RocalImageSizeEvaluationPolicy  decode_size_policy = ROCAL_USE_MOST_FREQUENT_SIZE,
unsigned  max_width = 0,
unsigned  max_height = 0,
RocalDecoderType  rocal_decoder_type = RocalDecoderType::ROCAL_DECODER_TJPEG 
)

Creates JPEG image reader and decoder for Caffe2 LMDB records. It allocates the resources and objects required to read and decode Jpeg images stored in Caffe2 LMDB Records. It has internal sharding capability to load/decode in parallel is user wants. If images are not Jpeg compressed they will be ignored.

Parameters
contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
rocal_color_formatThe color format the images will be decoded to.
internal_shard_countDefines the parallelism level by internally sharding the input dataset and load/decode using multiple decoder/loader instances. Using shard counts bigger than 1 improves the load/decode performance if compute resources (CPU cores) are available.
is_outputDetermines if the user wants the loaded images to be part of the output or not.
shuffleDetermines if the user wants to shuffle the dataset or not.
loopDetermines if the user wants to indefinitely loops through images or not.
decode_size_policy
max_widthThe maximum width of the decoded images, larger or smaller will be resized to closest
max_heightThe maximum height of the decoded images, larger or smaller will be resized to closest
rocal_decoder_typeDetermines the decoder_type, tjpeg or hwdec
Returns
Reference to the output image

◆ rocalJpegCaffe2LMDBRecordSourcePartialSingleShard()

RocalImage ROCAL_API_CALL rocalJpegCaffe2LMDBRecordSourcePartialSingleShard ( RocalContext  p_context,
const char *  source_path,
RocalImageColor  rocal_color_format,
unsigned  shard_id,
unsigned  shard_count,
bool  is_output,
std::vector< float > &  area_factor,
std::vector< float > &  aspect_ratio,
unsigned  num_attempts,
bool  shuffle = false,
bool  loop = false,
RocalImageSizeEvaluationPolicy  decode_size_policy = ROCAL_USE_MOST_FREQUENT_SIZE,
unsigned  max_width = 0,
unsigned  max_height = 0 
)

Creates JPEG image reader and partial decoder for Caffe2 LMDB records. It allocates the resources and objects required to read and decode Jpeg images stored in Caffe22 LMDB Records. It has internal sharding capability to load/decode in parallel is user wants.

Parameters
rocal_contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
rocal_color_formatThe color format the images will be decoded to.
shard_idShard id for this loader
shard_countTotal shard count
is_outputDetermines if the user wants the loaded images to be part of the output or not.
shuffleDetermines if the user wants to shuffle the dataset or not.
loopDetermines if the user wants to indefinitely loops through images or not.
decode_size_policy
max_widthThe maximum width of the decoded images, larger or smaller will be resized to closest
max_heightThe maximum height of the decoded images, larger or smaller will be resized to closest
Returns
Reference to the output image

◆ rocalJpegCaffe2LMDBRecordSourceSingleShard()

RocalImage ROCAL_API_CALL rocalJpegCaffe2LMDBRecordSourceSingleShard ( RocalContext  p_context,
const char *  source_path,
RocalImageColor  rocal_color_format,
unsigned  shard_id,
unsigned  shard_count,
bool  is_output,
bool  shuffle = false,
bool  loop = false,
RocalImageSizeEvaluationPolicy  decode_size_policy = ROCAL_USE_MOST_FREQUENT_SIZE,
unsigned  max_width = 0,
unsigned  max_height = 0,
RocalDecoderType  rocal_decoder_type = RocalDecoderType::ROCAL_DECODER_TJPEG 
)

Creates JPEG image reader and decoder for Caffe2 LMDB records. It allocates the resources and objects required to read and decode Jpeg images stored on the Caffe2 LMDB Records. It accepts external sharding information to load a singe shard. only.

Parameters
p_contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
rocal_color_formatThe color format the images will be decoded to.
shard_idShard id for this loader
shard_countTotal shard count
is_outputDetermines if the user wants the loaded images to be part of the output or not.
shuffleDetermines if the user wants to shuffle the dataset or not.
loopDetermines if the user wants to indefinitely loops through images or not.
decode_size_policy
max_widthThe maximum width of the decoded images, larger or smaller will be resized to closest
max_heightThe maximum height of the decoded images, larger or smaller will be resized to closest
rocal_decoder_typeDetermines the decoder_type, tjpeg or hwdec
Returns
Reference to the output image

◆ rocalJpegCaffeLMDBRecordSource()

RocalImage ROCAL_API_CALL rocalJpegCaffeLMDBRecordSource ( RocalContext  context,
const char *  source_path,
RocalImageColor  rocal_color_format,
unsigned  internal_shard_count,
bool  is_output,
bool  shuffle = false,
bool  loop = false,
RocalImageSizeEvaluationPolicy  decode_size_policy = ROCAL_USE_MOST_FREQUENT_SIZE,
unsigned  max_width = 0,
unsigned  max_height = 0,
RocalDecoderType  rocal_decoder_type = RocalDecoderType::ROCAL_DECODER_TJPEG 
)

Creates JPEG image reader and decoder for Caffe LMDB records. It allocates the resources and objects required to read and decode Jpeg images stored in Caffe LMDB Records. It has internal sharding capability to load/decode in parallel is user wants. If images are not Jpeg compressed they will be ignored.

Parameters
contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
rocal_color_formatThe color format the images will be decoded to.
internal_shard_countDefines the parallelism level by internally sharding the input dataset and load/decode using multiple decoder/loader instances. Using shard counts bigger than 1 improves the load/decode performance if compute resources (CPU cores) are available.
is_outputDetermines if the user wants the loaded images to be part of the output or not.
shuffleDetermines if the user wants to shuffle the dataset or not.
loopDetermines if the user wants to indefinitely loops through images or not.
decode_size_policy
max_widthThe maximum width of the decoded images, larger or smaller will be resized to closest
max_heightThe maximum height of the decoded images, larger or smaller will be resized to closest
Returns
Reference to the output image

◆ rocalJpegCaffeLMDBRecordSourcePartialSingleShard()

RocalImage ROCAL_API_CALL rocalJpegCaffeLMDBRecordSourcePartialSingleShard ( RocalContext  p_context,
const char *  source_path,
RocalImageColor  rocal_color_format,
unsigned  shard_id,
unsigned  shard_count,
bool  is_output,
std::vector< float > &  area_factor,
std::vector< float > &  aspect_ratio,
unsigned  num_attempts,
bool  shuffle = false,
bool  loop = false,
RocalImageSizeEvaluationPolicy  decode_size_policy = ROCAL_USE_MOST_FREQUENT_SIZE,
unsigned  max_width = 0,
unsigned  max_height = 0 
)

Creates JPEG image reader and partial decoder for Caffe LMDB records. It allocates the resources and objects required to read and decode Jpeg images stored in Caffe2 LMDB Records. It has internal sharding capability to load/decode in parallel is user wants.

Parameters
rocal_contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
rocal_color_formatThe color format the images will be decoded to.
shard_idShard id for this loader
shard_countTotal shard count
is_outputDetermines if the user wants the loaded images to be part of the output or not.
area_factorDetermines how much area to be cropped. Ranges from from 0.08 - 1.
aspect_ratioDetermines the aspect ration of crop. Ranges from 0.75 to 1.33.
num_attemptsMaximum number of attempts to generate crop. Default 10
shuffleDetermines if the user wants to shuffle the dataset or not.
loopDetermines if the user wants to indefinitely loops through images or not.
decode_size_policy
max_widthThe maximum width of the decoded images, larger or smaller will be resized to closest
max_heightThe maximum height of the decoded images, larger or smaller will be resized to closest
Returns
Reference to the output image

◆ rocalJpegCaffeLMDBRecordSourceSingleShard()

RocalImage ROCAL_API_CALL rocalJpegCaffeLMDBRecordSourceSingleShard ( RocalContext  p_context,
const char *  source_path,
RocalImageColor  rocal_color_format,
unsigned  shard_id,
unsigned  shard_count,
bool  is_output,
bool  shuffle = false,
bool  loop = false,
RocalImageSizeEvaluationPolicy  decode_size_policy = ROCAL_USE_MOST_FREQUENT_SIZE,
unsigned  max_width = 0,
unsigned  max_height = 0,
RocalDecoderType  rocal_decoder_type = RocalDecoderType::ROCAL_DECODER_TJPEG 
)

Creates JPEG image reader and decoder for Caffe LMDB records. It allocates the resources and objects required to read and decode Jpeg images stored in Caffe2 LMDB Records. It has internal sharding capability to load/decode in parallel is user wants.

Parameters
rocal_contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
rocal_color_formatThe color format the images will be decoded to.
shard_idShard id for this loader
shard_countTotal shard count
is_outputDetermines if the user wants the loaded images to be part of the output or not.
shuffleDetermines if the user wants to shuffle the dataset or not.
loopDetermines if the user wants to indefinitely loops through images or not.
decode_size_policy
max_widthThe maximum width of the decoded images, larger or smaller will be resized to closest
max_heightThe maximum height of the decoded images, larger or smaller will be resized to closest
rocal_decoder_typeDetermines the decoder_type, tjpeg or hwdec
Returns
Reference to the output image

◆ rocalJpegCOCOFileSource()

RocalImage ROCAL_API_CALL rocalJpegCOCOFileSource ( RocalContext  context,
const char *  source_path,
const char *  json_path,
RocalImageColor  color_format,
unsigned  internal_shard_count,
bool  is_output,
bool  shuffle = false,
bool  loop = false,
RocalImageSizeEvaluationPolicy  decode_size_policy = ROCAL_USE_MOST_FREQUENT_SIZE,
unsigned  max_width = 0,
unsigned  max_height = 0,
RocalDecoderType  rocal_decoder_type = RocalDecoderType::ROCAL_DECODER_TJPEG 
)

Creates JPEG image reader and decoder. It allocates the resources and objects required to read and decode COCO Jpeg images stored on the file systems. It has internal sharding capability to load/decode in parallel is user wants. If images are not Jpeg compressed they will be ignored.

Parameters
rocal_contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
json_pathPath to the COCO Json File
rocal_color_formatThe color format the images will be decoded to.
shard_countDefines the parallelism level by internally sharding the input dataset and load/decode using multiple decoder/loader instances. Using shard counts bigger than 1 improves the load/decode performance if compute resources (CPU cores) are available.
is_outputDetermines if the user wants the loaded images to be part of the output or not.
decode_size_policy
max_widthThe maximum width of the decoded images, larger or smaller will be resized to closest
max_heightThe maximum height of the decoded images, larger or smaller will be resized to closest
rocal_decoder_typeDetermines the decoder_type, tjpeg or hwdec
Returns
Reference to the output image

◆ rocalJpegCOCOFileSourcePartial()

RocalImage ROCAL_API_CALL rocalJpegCOCOFileSourcePartial ( RocalContext  p_context,
const char *  source_path,
const char *  json_path,
RocalImageColor  rocal_color_format,
unsigned  internal_shard_count,
bool  is_output,
std::vector< float > &  area_factor,
std::vector< float > &  aspect_ratio,
unsigned  num_attempts,
bool  shuffle = false,
bool  loop = false,
RocalImageSizeEvaluationPolicy  decode_size_policy = ROCAL_USE_MOST_FREQUENT_SIZE,
unsigned  max_width = 0,
unsigned  max_height = 0 
)

Creates JPEG image reader and partial decoder. It allocates the resources and objects required to read and decode COCO Jpeg images stored on the file systems. It has internal sharding capability to load/decode in parallel is user wants. If images are not Jpeg compressed they will be ignored.

Parameters
rocal_contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
json_pathPath to the COCO Json File
rocal_color_formatThe color format the images will be decoded to.
shard_countDefines the parallelism level by internally sharding the input dataset and load/decode using multiple decoder/loader instances. Using shard counts bigger than 1 improves the load/decode performance if compute resources (CPU cores) are available.
is_outputDetermines if the user wants the loaded images to be part of the output or not.
area_factorDetermines how much area to be cropped. Ranges from from 0.08 - 1.
aspect_ratioDetermines the aspect ration of crop. Ranges from 0.75 to 1.33.
num_attemptsMaximum number of attempts to generate crop. Default 10
decode_size_policy
max_widthThe maximum width of the decoded images, larger or smaller will be resized to closest
max_heightThe maximum height of the decoded images, larger or smaller will be resized to closest
Returns
Reference to the output image

◆ rocalJpegCOCOFileSourcePartialSingleShard()

RocalImage ROCAL_API_CALL rocalJpegCOCOFileSourcePartialSingleShard ( RocalContext  p_context,
const char *  source_path,
const char *  json_path,
RocalImageColor  rocal_color_format,
unsigned  shard_id,
unsigned  shard_count,
bool  is_output,
std::vector< float > &  area_factor,
std::vector< float > &  aspect_ratio,
unsigned  num_attempts,
bool  shuffle = false,
bool  loop = false,
RocalImageSizeEvaluationPolicy  decode_size_policy = ROCAL_USE_MOST_FREQUENT_SIZE,
unsigned  max_width = 0,
unsigned  max_height = 0 
)

Creates JPEG image reader and partial decoder. It allocates the resources and objects required to read and decode COCO Jpeg images stored on the file systems. It has internal sharding capability to load/decode in parallel is user wants. If images are not Jpeg compressed they will be ignored.

Parameters
rocal_contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
json_pathPath to the COCO Json File
rocal_color_formatThe color format the images will be decoded to.
shard_idShard id for this loader
shard_countDefines the parallelism level by internally sharding the input dataset and load/decode using multiple decoder/loader instances. Using shard counts bigger than 1 improves the load/decode performance if compute resources (CPU cores) are available.
is_outputDetermines if the user wants the loaded images to be part of the output or not.
decode_size_policy
max_widthThe maximum width of the decoded images, larger or smaller will be resized to closest
max_heightThe maximum height of the decoded images, larger or smaller will be resized to closest
area_factorDetermines how much area to be cropped. Ranges from from 0.08 - 1.
aspect_ratioDetermines the aspect ration of crop. Ranges from 0.75 to 1.33.
Returns
Reference to the output image

◆ rocalJpegCOCOFileSourceSingleShard()

RocalImage ROCAL_API_CALL rocalJpegCOCOFileSourceSingleShard ( RocalContext  context,
const char *  source_path,
const char *  json_path,
RocalImageColor  color_format,
unsigned  shard_id,
unsigned  shard_count,
bool  is_output,
bool  shuffle = false,
bool  loop = false,
RocalImageSizeEvaluationPolicy  decode_size_policy = ROCAL_USE_MOST_FREQUENT_SIZE,
unsigned  max_width = 0,
unsigned  max_height = 0,
RocalDecoderType  rocal_decoder_type = RocalDecoderType::ROCAL_DECODER_TJPEG 
)
Parameters
rocal_contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
json_pathPath to the COCO Json File
rocal_color_formatThe color format the images will be decoded to.
shard_idShard id for this loader
shard_countTotal shard count
is_outputDetermines if the user wants the loaded images to be part of the output or not.
decode_size_policy
max_widthThe maximum width of the decoded images, larger or smaller will be resized to closest
max_heightThe maximum height of the decoded images, larger or smaller will be resized to closest
rocal_decoder_typeDetermines the decoder_type, tjpeg or hwdec
Returns
Reference to the output image

◆ rocalJpegFileSource()

RocalImage ROCAL_API_CALL rocalJpegFileSource ( RocalContext  context,
const char *  source_path,
RocalImageColor  rocal_color_format,
unsigned  internal_shard_count,
bool  is_output,
bool  shuffle = false,
bool  loop = false,
RocalImageSizeEvaluationPolicy  decode_size_policy = ROCAL_USE_MOST_FREQUENT_SIZE,
unsigned  max_width = 0,
unsigned  max_height = 0,
RocalDecoderType  rocal_decoder_type = RocalDecoderType::ROCAL_DECODER_TJPEG 
)

Creates JPEG image reader and decoder. It allocates the resources and objects required to read and decode Jpeg images stored on the file systems. It has internal sharding capability to load/decode in parallel is user wants. If images are not Jpeg compressed they will be ignored.

Parameters
contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
rocal_color_formatThe color format the images will be decoded to.
shard_countDefines the parallelism level by internally sharding the input dataset and load/decode using multiple decoder/loader instances. Using shard counts bigger than 1 improves the load/decode performance if compute resources (CPU cores) are available.
is_outputDetermines if the user wants the loaded images to be part of the output or not.
shuffleDetermines if the user wants to shuffle the dataset or not.
loopDetermines if the user wants to indefinitely loops through images or not.
decode_size_policy
max_widthThe maximum width of the decoded images, larger or smaller will be resized to closest
max_heightThe maximum height of the decoded images, larger or smaller will be resized to closest
rocal_decoder_typeDetermines the decoder_type, tjpeg or hwdec
Returns
Reference to the output image

◆ rocalJpegFileSourceSingleShard()

RocalImage ROCAL_API_CALL rocalJpegFileSourceSingleShard ( RocalContext  context,
const char *  source_path,
RocalImageColor  rocal_color_format,
unsigned  shard_id,
unsigned  shard_count,
bool  is_output,
bool  shuffle = false,
bool  loop = false,
RocalImageSizeEvaluationPolicy  decode_size_policy = ROCAL_USE_MOST_FREQUENT_SIZE,
unsigned  max_width = 0,
unsigned  max_height = 0,
RocalDecoderType  rocal_decoder_type = RocalDecoderType::ROCAL_DECODER_TJPEG 
)

Creates JPEG image reader and decoder. It allocates the resources and objects required to read and decode Jpeg images stored on the file systems. It accepts external sharding information to load a singe shard. only.

Parameters
contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
rocal_color_formatThe color format the images will be decoded to.
shard_idShard id for this loader
shard_countTotal shard count
is_outputDetermines if the user wants the loaded images to be part of the output or not.
shuffleDetermines if the user wants to shuffle the dataset or not.
loopDetermines if the user wants to indefinitely loops through images or not.
decode_size_policy
max_widthThe maximum width of the decoded images, larger or smaller will be resized to closest
max_heightThe maximum height of the decoded images, larger or smaller will be resized to closest
rocal_decoder_typeDetermines the decoder_type, tjpeg or hwdec
Returns
Reference to the output image

◆ rocalJpegTFRecordSource()

RocalImage ROCAL_API_CALL rocalJpegTFRecordSource ( RocalContext  context,
const char *  source_path,
RocalImageColor  rocal_color_format,
unsigned  internal_shard_count,
bool  is_output,
const char *  user_key_for_encoded,
const char *  user_key_for_filename,
bool  shuffle = false,
bool  loop = false,
RocalImageSizeEvaluationPolicy  decode_size_policy = ROCAL_USE_MOST_FREQUENT_SIZE,
unsigned  max_width = 0,
unsigned  max_height = 0,
RocalDecoderType  rocal_decoder_type = RocalDecoderType::ROCAL_DECODER_TJPEG 
)

Creates TensorFlow records JPEG image reader and decoder. It allocates the resources and objects required to read and decode Jpeg images stored on the file systems. It has internal sharding capability to load/decode in parallel is user wants. If images are not Jpeg compressed they will be ignored.

Parameters
contextRocal context
source_pathA NULL terminated char string pointing to the location of the TF records on the disk
rocal_color_formatThe color format the images will be decoded to.
internal_shard_countDefines the parallelism level by internally sharding the input dataset and load/decode using multiple decoder/loader instances. Using shard counts bigger than 1 improves the load/decode performance if compute resources (CPU cores) are available.
is_outputDetermines if the user wants the loaded images to be part of the output or not.
shuffleDetermines if the user wants to shuffle the dataset or not.
loopDetermines if the user wants to indefinitely loops through images or not.
decode_size_policy
max_widthThe maximum width of the decoded images, larger or smaller will be resized to closest
max_heightThe maximum height of the decoded images, larger or smaller will be resized to closest
rocal_decoder_typeDetermines the decoder_type, tjpeg or hwdec
Returns
Reference to the output image

◆ rocalJpegTFRecordSourceSingleShard()

RocalImage ROCAL_API_CALL rocalJpegTFRecordSourceSingleShard ( RocalContext  context,
const char *  source_path,
RocalImageColor  rocal_color_format,
unsigned  shard_id,
unsigned  shard_count,
bool  is_output,
bool  shuffle = false,
bool  loop = false,
RocalImageSizeEvaluationPolicy  decode_size_policy = ROCAL_USE_MOST_FREQUENT_SIZE,
unsigned  max_width = 0,
unsigned  max_height = 0,
RocalDecoderType  rocal_decoder_type = RocalDecoderType::ROCAL_DECODER_TJPEG 
)

Creates TensorFlow records JPEG image reader and decoder. It allocates the resources and objects required to read and decode Jpeg images stored on the file systems. It accepts external sharding information to load a singe shard. only.

Parameters
contextRocal context
source_pathA NULL terminated char string pointing to the location of the TF records on the disk
rocal_color_formatThe color format the images will be decoded to.
shard_idShard id for this loader
shard_countTotal shard count
is_outputDetermines if the user wants the loaded images to be part of the output or not.
shuffleDetermines if the user wants to shuffle the dataset or not.
loopDetermines if the user wants to indefinitely loops through images or not.
decode_size_policy
max_widthThe maximum width of the decoded images, larger or smaller will be resized to closest
max_heightThe maximum height of the decoded images, larger or smaller will be resized to closest
rocal_decoder_typeDetermines the decoder_type, tjpeg or hwdec
Returns
Reference to the output image

◆ rocalMXNetRecordSource()

RocalImage ROCAL_API_CALL rocalMXNetRecordSource ( RocalContext  context,
const char *  source_path,
RocalImageColor  rocal_color_format,
unsigned  internal_shard_count,
bool  is_output,
bool  shuffle = false,
bool  loop = false,
RocalImageSizeEvaluationPolicy  decode_size_policy = ROCAL_USE_MOST_FREQUENT_SIZE,
unsigned  max_width = 0,
unsigned  max_height = 0,
RocalDecoderType  rocal_decoder_type = RocalDecoderType::ROCAL_DECODER_TJPEG 
)

Creates JPEG image reader and decoder for MXNet records. It allocates the resources and objects required to read and decode Jpeg images stored in MXNet Records. It has internal sharding capability to load/decode in parallel is user wants. If images are not Jpeg compressed they will be ignored.

Parameters
contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
rocal_color_formatThe color format the images will be decoded to.
internal_shard_countDefines the parallelism level by internally sharding the input dataset and load/decode using multiple decoder/loader instances. Using shard counts bigger than 1 improves the load/decode performance if compute resources (CPU cores) are available.
is_outputDetermines if the user wants the loaded images to be part of the output or not.
shuffleDetermines if the user wants to shuffle the dataset or not.
loopDetermines if the user wants to indefinitely loops through images or not.
decode_size_policy
max_widthThe maximum width of the decoded images, larger or smaller will be resized to closest
max_heightThe maximum height of the decoded images, larger or smaller will be resized to closest
rocal_decoder_typeDetermines the decoder_type, tjpeg or hwdec
Returns
Reference to the output image

◆ rocalMXNetRecordSourceSingleShard()

RocalImage ROCAL_API_CALL rocalMXNetRecordSourceSingleShard ( RocalContext  p_context,
const char *  source_path,
RocalImageColor  rocal_color_format,
unsigned  shard_id,
unsigned  shard_count,
bool  is_output,
bool  shuffle = false,
bool  loop = false,
RocalImageSizeEvaluationPolicy  decode_size_policy = ROCAL_USE_MOST_FREQUENT_SIZE,
unsigned  max_width = 0,
unsigned  max_height = 0,
RocalDecoderType  rocal_decoder_type = RocalDecoderType::ROCAL_DECODER_TJPEG 
)

Creates JPEG image reader and decoder for MXNet records. It allocates the resources and objects required to read and decode Jpeg images stored on the MXNet records. It accepts external sharding information to load a singe shard. only.

Parameters
p_contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
rocal_color_formatThe color format the images will be decoded to.
shard_idShard id for this loader
shard_countTotal shard count
is_outputDetermines if the user wants the loaded images to be part of the output or not.
shuffleDetermines if the user wants to shuffle the dataset or not.
loopDetermines if the user wants to indefinitely loops through images or not.
decode_size_policy
max_widthThe maximum width of the decoded images, larger or smaller will be resized to closest
max_heightThe maximum height of the decoded images, larger or smaller will be resized to closest
rocal_decoder_typeDetermines the decoder_type, tjpeg or hwdec
Returns
Reference to the output image

◆ rocalRawCIFAR10Source()

RocalImage ROCAL_API_CALL rocalRawCIFAR10Source ( RocalContext  context,
const char *  source_path,
RocalImageColor  color_format,
bool  is_output,
unsigned  out_width,
unsigned  out_height,
const char *  filename_prefix = "",
bool  loop = false 
)

Creates CIFAR10 raw data reader and loader. It allocates the resources and objects required to read raw data stored on the file systems.

Parameters
contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
rocal_color_formatThe color format the images will be decoded to.
is_outputDetermines if the user wants the loaded images to be part of the output or not.
out_width; output width
out_height; output_height
filename_prefix; if set loader will only load files with the given prefix name
Returns
Reference to the output image

◆ rocalRawTFRecordSource()

RocalImage ROCAL_API_CALL rocalRawTFRecordSource ( RocalContext  p_context,
const char *  source_path,
const char *  user_key_for_raw,
const char *  user_key_for_filename,
RocalImageColor  rocal_color_format,
bool  is_output,
bool  shuffle = false,
bool  loop = false,
unsigned  out_width = 0,
unsigned  out_height = 0,
const char *  record_name_prefix = "" 
)

Creates Raw image loader. It allocates the resources and objects required to load images stored on the file systems.

Parameters
rocal_contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
rocal_color_formatThe color format the images will be decoded to.
is_outputDetermines if the user wants the loaded images to be part of the output or not.
shuffleto shuffle dataset
looprepeat data loading
out_widthThe output_width of raw image
out_heightThe output height of raw image
Returns

◆ rocalRawTFRecordSourceSingleShard()

RocalImage ROCAL_API_CALL rocalRawTFRecordSourceSingleShard ( RocalContext  p_context,
const char *  source_path,
RocalImageColor  rocal_color_format,
unsigned  shard_id,
unsigned  shard_count,
bool  is_output,
bool  shuffle = false,
bool  loop = false,
unsigned  out_width = 0,
unsigned  out_height = 0,
const char *  record_name_prefix = "" 
)

Creates Raw image loader. It allocates the resources and objects required to load images stored on the file systems.

Parameters
rocal_contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
rocal_color_formatThe color format the images will be decoded to.
shard_idShard id for this loader
shard_countTotal shard count
shuffleto shuffle dataset
looprepeat data loading
out_widthThe output_width of raw image
out_heightThe output height of raw image
record_name_prefix: if nonempty reader will only read records with certain prefix
Returns

◆ rocalResetLoaders()

RocalStatus ROCAL_API_CALL rocalResetLoaders ( RocalContext  context)
Parameters
context
Returns

◆ rocalSequenceReader()

RocalImage ROCAL_API_CALL rocalSequenceReader ( RocalContext  context,
const char *  source_path,
RocalImageColor  rocal_color_format,
unsigned  internal_shard_count,
unsigned  sequence_length,
bool  is_output,
bool  shuffle = false,
bool  loop = false,
unsigned  step = 0,
unsigned  stride = 0 
)

Creates JPEG image reader and decoder. Reads [Frames] sequences from a directory representing a collection of streams.

Parameters
contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
rocal_color_formatThe color format the images in a sequence will be decoded to.
internal_shard_countDefines the parallelism level by internally sharding the input dataset and load/decode using multiple decoder/loader instances.
sequence_lengthThe number of frames in a sequence.
is_outputDetermines if the user wants the loaded sequences to be part of the output or not.
shuffleDetermines if the user wants to shuffle the sequences or not.
loopDetermines if the user wants to indefinitely loops through images or not.
stepFrame interval between each sequence.
strideFrame interval between frames in a sequence.
Returns
Reference to the output image.

◆ rocalSequenceReaderSingleShard()

RocalImage ROCAL_API_CALL rocalSequenceReaderSingleShard ( RocalContext  context,
const char *  source_path,
RocalImageColor  rocal_color_format,
unsigned  shard_id,
unsigned  shard_count,
unsigned  sequence_length,
bool  is_output,
bool  shuffle = false,
bool  loop = false,
unsigned  step = 0,
unsigned  stride = 0 
)

Creates JPEG image reader and decoder. Reads [Frames] sequences from a directory representing a collection of streams. It accepts external sharding information to load a singe shard only.

Parameters
contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk
rocal_color_formatThe color format the images in a sequence will be decoded to.
shard_idShard id for this loader
shard_countTotal shard count
sequence_lengthThe number of frames in a sequence.
is_outputDetermines if the user wants the loaded sequences to be part of the output or not.
shuffleDetermines if the user wants to shuffle the dataset or not.
loopDetermines if the user wants to indefinitely loops through images or not.
stepFrame interval between each sequence.
strideFrame interval between frames in a sequence.
Returns
Reference to the output image

◆ rocalVideoFileResize()

RocalImage ROCAL_API_CALL rocalVideoFileResize ( RocalContext  context,
const char *  source_path,
RocalImageColor  color_format,
RocalDecodeDevice  rocal_decode_device,
unsigned  internal_shard_count,
unsigned  sequence_length,
unsigned  dest_width,
unsigned  dest_height,
const std::vector< std::string > &  file_names_list,
bool  shuffle = false,
bool  is_output = false,
bool  loop = false,
unsigned  step = 0,
unsigned  stride = 0,
bool  file_list_frame_num = true,
RocalResizeScalingMode  scaling_mode = ROCAL_SCALING_MODE_DEFAULT,
std::vector< unsigned >  max_size = {},
unsigned  resize_shorter = 0,
unsigned  resize_longer = 0,
RocalResizeInterpolationType  interpolation_type = ROCAL_LINEAR_INTERPOLATION 
)

Creates a video reader and decoder as a source. It allocates the resources and objects required to read and decode mp4 videos stored on the file systems. Resizes the decoded frames to the dest width and height.

Parameters
contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk. source_path can be a video file, folder containing videos or a text file
color_formatThe color format the frames will be decoded to.
rocal_decode_deviceEnables software or hardware decoding. Currently only software decoding is supported.
internal_shard_countDefines the parallelism level by internally sharding the input dataset and load/decode using multiple decoder/loader instances.
sequence_lengthThe number of frames in a sequence.
dest_widthThe output width of frames.
dest_heightThe output height of frames.
file_names_listList of input video filenames
shuffleto shuffle sequences.
is_outputDetermines if the user wants the loaded sequence of frames to be part of the output or not.
looprepeat data loading.
stepFrame interval between each sequence.
strideFrame interval between frames in a sequence.
file_list_frame_numDetermines if the user wants to read frame number or timestamps if a text file is passed in the source_path.
Returns

◆ rocalVideoFileResizeSingleShard()

RocalImage ROCAL_API_CALL rocalVideoFileResizeSingleShard ( RocalContext  context,
const char *  source_path,
RocalImageColor  color_format,
RocalDecodeDevice  rocal_decode_device,
unsigned  shard_id,
unsigned  shard_count,
unsigned  sequence_length,
unsigned  dest_width,
unsigned  dest_height,
const std::vector< std::string > &  file_names_list,
bool  shuffle = false,
bool  is_output = false,
bool  loop = false,
unsigned  step = 0,
unsigned  stride = 0,
bool  file_list_frame_num = true,
RocalResizeScalingMode  scaling_mode = ROCAL_SCALING_MODE_DEFAULT,
std::vector< unsigned >  max_size = {},
unsigned  resize_shorter = 0,
unsigned  resize_longer = 0,
RocalResizeInterpolationType  interpolation_type = ROCAL_LINEAR_INTERPOLATION 
)

Creates a video reader and decoder as a source. It allocates the resources and objects required to read and decode mp4 videos stored on the file systems. Resizes the decoded frames to the dest width and height. It accepts external sharding information to load a singe shard only.

Parameters
contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk. source_path can be a video file, folder containing videos or a text file
color_formatThe color format the frames will be decoded to.
rocal_decode_deviceEnables software or hardware decoding. Currently only software decoding is supported.
shard_idShard id for this loader.
shard_countTotal shard count.
sequence_lengthThe number of frames in a sequence.
dest_widthThe output width of frames.
dest_heightThe output height of frames.
file_names_listList of input video filenames
shuffleto shuffle sequences.
is_outputDetermines if the user wants the loaded sequence of frames to be part of the output or not.
looprepeat data loading.
stepFrame interval between each sequence.
strideFrame interval between frames in a sequence.
file_list_frame_numDetermines if the user wants to read frame number or timestamps if a text file is passed in the source_path.
Returns

◆ rocalVideoFileSource()

RocalImage ROCAL_API_CALL rocalVideoFileSource ( RocalContext  context,
const char *  source_path,
RocalImageColor  color_format,
RocalDecodeDevice  rocal_decode_device,
unsigned  internal_shard_count,
unsigned  sequence_length,
const std::vector< std::string > &  file_names_list,
bool  is_output = false,
bool  shuffle = false,
bool  loop = false,
unsigned  step = 0,
unsigned  stride = 0,
bool  file_list_frame_num = true 
)

Creates a video reader and decoder as a source. It allocates the resources and objects required to read and decode mp4 videos stored on the file systems.

Parameters
contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk. source_path can be a video file, folder containing videos or a text file
color_formatThe color format the frames will be decoded to.
rocal_decode_deviceEnables software or hardware decoding. Currently only software decoding is supported.
internal_shard_countDefines the parallelism level by internally sharding the input dataset and load/decode using multiple decoder/loader instances.
sequence_lengthThe number of frames in a sequence.
file_names_listList of input video filenames
shuffleto shuffle sequences.
is_outputDetermines if the user wants the loaded sequence of frames to be part of the output or not.
looprepeat data loading.
stepFrame interval between each sequence.
strideFrame interval between frames in a sequence.
file_list_frame_numDetermines if the user wants to read frame number or timestamps if a text file is passed in the source_path.
Returns

◆ rocalVideoFileSourceSingleShard()

RocalImage ROCAL_API_CALL rocalVideoFileSourceSingleShard ( RocalContext  context,
const char *  source_path,
RocalImageColor  color_format,
RocalDecodeDevice  rocal_decode_device,
unsigned  shard_id,
unsigned  shard_count,
unsigned  sequence_length,
const std::vector< std::string > &  file_names_list,
bool  shuffle = false,
bool  is_output = false,
bool  loop = false,
unsigned  step = 0,
unsigned  stride = 0,
bool  file_list_frame_num = true 
)

Creates a video reader and decoder as a source. It allocates the resources and objects required to read and decode mp4 videos stored on the file systems. It accepts external sharding information to load a singe shard only.

Parameters
contextRocal context
source_pathA NULL terminated char string pointing to the location on the disk. source_path can be a video file, folder containing videos or a text file
color_formatThe color format the frames will be decoded to.
rocal_decode_deviceEnables software or hardware decoding. Currently only software decoding is supported.
shard_idShard id for this loader.
shard_countTotal shard count.
sequence_lengthThe number of frames in a sequence.
file_names_listList of input video filenames
shuffleto shuffle sequences.
is_outputDetermines if the user wants the loaded sequence of frames to be part of the output or not.
looprepeat data loading.
stepFrame interval between each sequence.
strideFrame interval between frames in a sequence.
file_list_frame_numDetermines if the user wants to read frame number or timestamps if a text file is passed in the source_path.
Returns