ai.djl.basicdataset.cv

Class PikachuDetection

java.lang.Object

ai.djl.training.dataset.RandomAccessDataset

ai.djl.basicdataset.cv.ImageDataset

ai.djl.basicdataset.cv.ObjectDetectionDataset

ai.djl.basicdataset.cv.PikachuDetection

All Implemented Interfaces:

ai.djl.training.dataset.Dataset

public class PikachuDetection
extends ObjectDetectionDataset

Pikachu image detection dataset that contains multiple Pikachus in each image.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PikachuDetection.Builder A builder for a PikachuDetection.

Nested classes/interfaces inherited from class ai.djl.basicdataset.cv.ImageDataset

ImageDataset.BaseBuilder<T extends ImageDataset.BaseBuilder<T>>

Nested classes/interfaces inherited from interface ai.djl.training.dataset.Dataset

ai.djl.training.dataset.Dataset.Usage

Field Summary

Fields inherited from class ai.djl.basicdataset.cv.ImageDataset

flag

Fields inherited from class ai.djl.training.dataset.RandomAccessDataset

dataBatchifier, device, labelBatchifier, limit, pipeline, prefetchNumber, sampler, targetPipeline

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PikachuDetection(PikachuDetection.Builder builder)

Method Summary

Modifier and Type	Method and Description
protected long	availableSize()
static PikachuDetection.Builder	builder() Creates a new builder to build a PikachuDetection.
protected ai.djl.modality.cv.Image	getImage(long index) Returns the image at the given index in the dataset.
java.util.Optional<java.lang.Integer>	getImageHeight() Returns the height of the images in the dataset.
java.util.Optional<java.lang.Integer>	getImageWidth() Returns the width of the images in the dataset.
ai.djl.util.PairList<java.lang.Long,ai.djl.modality.cv.output.Rectangle>	getObjects(long index) Returns the list of objects in the image at the given index.
void	prepare(ai.djl.util.Progress progress)

Methods inherited from class ai.djl.basicdataset.cv.ObjectDetectionDataset

get

Methods inherited from class ai.djl.basicdataset.cv.ImageDataset

getImageChannels, getRecordImage

Methods inherited from class ai.djl.training.dataset.RandomAccessDataset

getData, getData, getData, getData, randomSplit, size, subDataset, toArray

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ai.djl.training.dataset.Dataset

prepare

Constructor Detail

PikachuDetection

protected PikachuDetection(PikachuDetection.Builder builder)

Method Detail

builder

public static PikachuDetection.Builder builder()

Creates a new builder to build a PikachuDetection.

Returns:

a new builder

prepare

public void prepare(ai.djl.util.Progress progress)
             throws java.io.IOException

Throws:

java.io.IOException

getObjects

public ai.djl.util.PairList<java.lang.Long,ai.djl.modality.cv.output.Rectangle> getObjects(long index)

Description copied from class: ObjectDetectionDataset

Returns the list of objects in the image at the given index.

Specified by:

getObjects in class ObjectDetectionDataset

Parameters:

index - the index (if the dataset is a list of data items)

Returns:

the list of objects in the image. The long is the class number of the index into the list of classes of the desired class name. The rectangle is the location of the object inside the image.

availableSize

protected long availableSize()

Specified by:

availableSize in class ai.djl.training.dataset.RandomAccessDataset

getImage

protected ai.djl.modality.cv.Image getImage(long index)
                                     throws java.io.IOException

Description copied from class: ImageDataset

Returns the image at the given index in the dataset.

Specified by:

getImage in class ImageDataset

Parameters:

index - the index (if the dataset is a list of data items)

Returns:

the image

Throws:

java.io.IOException - if the image could not be loaded

getImageWidth

public java.util.Optional<java.lang.Integer> getImageWidth()

Description copied from class: ImageDataset

Returns the width of the images in the dataset.

Specified by:

getImageWidth in class ImageDataset

Returns:

the width of the images in the dataset

getImageHeight

public java.util.Optional<java.lang.Integer> getImageHeight()

Description copied from class: ImageDataset

Returns the height of the images in the dataset.

Specified by:

getImageHeight in class ImageDataset

Returns:

the height of the images in the dataset