org.openimaj.image.dataset

Class BingImageDataset<IMAGE extends Image<?,IMAGE>>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<INSTANCE>

org.openimaj.data.dataset.ReadableListDataset<IMAGE,InputStream>

org.openimaj.image.dataset.BingImageDataset<IMAGE>

Type Parameters:

IMAGE - The type of Image instance held by the dataset.

All Implemented Interfaces:

Iterable<IMAGE>, Collection<IMAGE>, List<IMAGE>, Dataset<IMAGE>, ListDataset<IMAGE>, Identifiable

public class BingImageDataset<IMAGE extends Image<?,IMAGE>>
extends ReadableListDataset<IMAGE,InputStream>
implements Identifiable

Image datasets dynamically created from the Bing search API.

WARNING

Some of the images inside this dataset may be set to nullif they could not be loaded.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BingImageDataset.ImageDataSourceQuery
static class	BingImageDataset.ImageDataSourceResponse

Field Summary

Fields inherited from class org.openimaj.data.dataset.ReadableListDataset

reader

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BingImageDataset(InputStreamObjectReader<IMAGE> reader, List<BingImageDataset.ImageDataSourceResponse> results, BingImageDataset.ImageDataSourceQuery query)

Method Summary

Modifier and Type	Method and Description
static <IMAGE extends Image<?,IMAGE>> BingImageDataset<IMAGE>	create(InputStreamObjectReader<IMAGE> reader, BingAPIToken token, BingImageDataset.ImageDataSourceQuery query, int number) Perform a search with the given query.
static <IMAGE extends Image<?,IMAGE>> BingImageDataset<IMAGE>	create(InputStreamObjectReader<IMAGE> reader, BingAPIToken token, String query, int number) Perform a search with the given query string.
static <IMAGE extends Image<?,IMAGE>> BingImageDataset<IMAGE>	create(InputStreamObjectReader<IMAGE> reader, BingImageDataset.ImageDataSourceQuery query, int number) Perform a search with the given query.
String	getID()
BingImageDataset.ImageDataSourceResponse	getImage(int index) Get the specific underlying BingImageDataset.ImageDataSourceResponse for the given index.
List<BingImageDataset.ImageDataSourceResponse>	getImages() Get the underlying BingImageDataset.ImageDataSourceResponse objects that back the dataset.
IMAGE	getInstance(int index) Returns the instance at the specified position in this dataset.
static void	main(String[] args)
int	numInstances() Returns the number of instances in this dataset.

Methods inherited from class org.openimaj.data.dataset.ReadableListDataset

get, getID, getRandomInstance, indexOfID, size, toIdentifiable

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openimaj.data.identity.Identifiable

equals

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, sort, spliterator, subList, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

BingImageDataset

protected BingImageDataset(InputStreamObjectReader<IMAGE> reader,
                           List<BingImageDataset.ImageDataSourceResponse> results,
                           BingImageDataset.ImageDataSourceQuery query)

Method Detail

getInstance

public IMAGE getInstance(int index)

Description copied from interface: ListDataset

Returns the instance at the specified position in this dataset.

Specified by:

getInstance in interface ListDataset<IMAGE extends Image<?,IMAGE>>

Parameters:

index - index of the instance to return

Returns:

the element at the specified position in this list

numInstances

public int numInstances()

Description copied from interface: Dataset

Returns the number of instances in this dataset.

Specified by:

numInstances in interface Dataset<IMAGE extends Image<?,IMAGE>>

Returns:

the number of instances in this list

getImages

public List<BingImageDataset.ImageDataSourceResponse> getImages()

Get the underlying BingImageDataset.ImageDataSourceResponse objects that back the dataset.

Returns:

the underlying BingImageDataset.ImageDataSourceResponse objects

getImage

public BingImageDataset.ImageDataSourceResponse getImage(int index)

Get the specific underlying BingImageDataset.ImageDataSourceResponse for the given index.

Parameters:

index - the index

Returns:

the specific BingImageDataset.ImageDataSourceResponse for the given index.

create

public static <IMAGE extends Image<?,IMAGE>> BingImageDataset<IMAGE> create(InputStreamObjectReader<IMAGE> reader,
                                                                            BingImageDataset.ImageDataSourceQuery query,
                                                                            int number)

Perform a search with the given query. The appid must have been set externally.

Parameters:

reader - the reader with which to load the images

query - the query

number - the target number of results; the resultant dataset may contain fewer images than specified.

Returns:

a new BingImageDataset created from the query.

create

public static <IMAGE extends Image<?,IMAGE>> BingImageDataset<IMAGE> create(InputStreamObjectReader<IMAGE> reader,
                                                                            BingAPIToken token,
                                                                            BingImageDataset.ImageDataSourceQuery query,
                                                                            int number)

Perform a search with the given query. The given api token will be used to set the appid in the query object.

Parameters:

reader - the reader with which to load the images

token - the api authentication token

query - the query

number - the target number of results; the resultant dataset may contain fewer images than specified.

Returns:

a new BingImageDataset created from the query.

create

public static <IMAGE extends Image<?,IMAGE>> BingImageDataset<IMAGE> create(InputStreamObjectReader<IMAGE> reader,
                                                                            BingAPIToken token,
                                                                            String query,
                                                                            int number)

Perform a search with the given query string.

Parameters:

reader - the reader with which to load the images

token - the api authentication token

query - the query

number - the target number of results; the resultant dataset may contain fewer images than specified.

Returns:

a new BingImageDataset created from the query.

getID

public String getID()

Specified by:

getID in interface Identifiable

Returns:

the identifier of this object

main

public static void main(String[] args)
                 throws BackingStoreException

Throws:

BackingStoreException