org.openimaj.image.dataset

Class FlickrImageDataset<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.FlickrImageDataset<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>

public class FlickrImageDataset<IMAGE extends Image<?,IMAGE>>
extends ReadableListDataset<IMAGE,InputStream>

Class to dynamically create image datasets from flickr through various api calls.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlickrImageDataset.Size Possible sizes of image from flickr.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.aetrion.flickr.photos.Photo>	photos
protected FlickrImageDataset.Size	targetSize

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	FlickrImageDataset(InputStreamObjectReader<IMAGE> reader, List<com.aetrion.flickr.photos.Photo> photos)

Method Summary

Methods

Modifier and Type	Method and Description
static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE>	create(InputStreamObjectReader<IMAGE> reader, FlickrAPIToken token, String searchTerms) Create an image dataset by searching flickr with the given search terms.
static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE>	create(InputStreamObjectReader<IMAGE> reader, FlickrAPIToken token, String searchTerms, int number) Create an image dataset by searching flickr with the given search terms.
static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE>	create(InputStreamObjectReader<IMAGE> reader, FlickrAPIToken token, URL url) Create an image dataset from the flickr gallery, photoset or collection at the given url.
static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE>	create(InputStreamObjectReader<IMAGE> reader, FlickrAPIToken token, URL url, int number) Create an image dataset from the flickr gallery, photoset or collection at the given url.
static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE>	createFromCollection(InputStreamObjectReader<IMAGE> reader, FlickrAPIToken token, com.aetrion.flickr.collections.CollectionsSearchParameters params) Create an image dataset from a flickr collection with the specified parameters.
static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE>	createFromCollection(InputStreamObjectReader<IMAGE> reader, FlickrAPIToken token, com.aetrion.flickr.collections.CollectionsSearchParameters params, int number) Create an image dataset from a flickr collection with the specified parameters.
static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE>	createFromGallery(InputStreamObjectReader<IMAGE> reader, FlickrAPIToken token, com.aetrion.flickr.galleries.SearchParameters params) Create an image dataset from a flickr gallery with the specified parameters.
static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE>	createFromGallery(InputStreamObjectReader<IMAGE> reader, FlickrAPIToken token, com.aetrion.flickr.galleries.SearchParameters params, int number) Create an image dataset from a flickr gallery with the specified parameters.
static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE>	createFromPhotoset(InputStreamObjectReader<IMAGE> reader, FlickrAPIToken token, String setId) Create an image dataset from a flickr photoset.
static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE>	createFromPhotoset(InputStreamObjectReader<IMAGE> reader, FlickrAPIToken token, String setId, int number) Create an image dataset from a flickr photoset.
static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE>	createFromSearch(InputStreamObjectReader<IMAGE> reader, FlickrAPIToken token, com.aetrion.flickr.photos.SearchParameters params) Create an image dataset from a flickr search with the specified parameters.
static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE>	createFromSearch(InputStreamObjectReader<IMAGE> reader, FlickrAPIToken token, com.aetrion.flickr.photos.SearchParameters params, int number) Create an image dataset from a flickr search with the specified parameters.
String	getID(int index) Get an identifier for the instance at the given index.
FlickrImageDataset.Size	getImageSize() Get the size of the images that this dataset produces.
IMAGE	getInstance(int index) Returns the instance at the specified position in this dataset.
com.aetrion.flickr.photos.Photo	getPhoto(int index) Get the a specific underlying flickr Photo object corresponding to a particular image instance.
List<com.aetrion.flickr.photos.Photo>	getPhotos() Get the underlying flickr Photo objects.
Iterator<IMAGE>	iterator()
int	numInstances() Returns the number of instances in this dataset.
void	setImageSize(FlickrImageDataset.Size size) Set the size of the images that this dataset produces.
String	toString()

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

get, getRandomInstance, indexOfID, size, toIdentifiable

Methods inherited from class java.util.AbstractList

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

Methods inherited from class java.util.AbstractCollection

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

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

Field Detail

photos

protected List<com.aetrion.flickr.photos.Photo> photos

targetSize

protected FlickrImageDataset.Size targetSize

Constructor Detail

FlickrImageDataset

protected FlickrImageDataset(InputStreamObjectReader<IMAGE> reader,
                  List<com.aetrion.flickr.photos.Photo> photos)

Method Detail

setImageSize

public void setImageSize(FlickrImageDataset.Size size)

Set the size of the images that this dataset produces.

Parameters:

size - the size

getImageSize

public FlickrImageDataset.Size getImageSize()

Get the size of the images that this dataset produces.

Returns:

the size of the returned images

getPhotos

public List<com.aetrion.flickr.photos.Photo> getPhotos()

Get the underlying flickr Photo objects.

Returns:

the underlying list of Photos.

getPhoto

public com.aetrion.flickr.photos.Photo getPhoto(int index)

Get the a specific underlying flickr Photo object corresponding to a particular image instance.

Parameters:

index - the index of the instance

Returns:

the underlying Photo corresponding to the given instance index.

getInstance

public IMAGE getInstance(int index)

Description copied from interface: ListDataset

Returns the instance at the specified position in this dataset.

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.

Returns:

the number of instances in this list

getID

public String getID(int index)

Description copied from class: ReadableListDataset

Get an identifier for the instance at the given index. By default this just returns the index converted to a String, but sub-classes should override to to something more sensible if possible.

Overrides:

getID in class ReadableListDataset<IMAGE extends Image<?,IMAGE>,InputStream>

Parameters:

index - the index

Returns:

the identifier of the instance at the given index

iterator

public Iterator<IMAGE> iterator()

Specified by:

iterator in interface Iterable<IMAGE extends Image<?,IMAGE>>

Specified by:

iterator in interface Collection<IMAGE extends Image<?,IMAGE>>

Specified by:

iterator in interface List<IMAGE extends Image<?,IMAGE>>

Overrides:

iterator in class AbstractList<IMAGE extends Image<?,IMAGE>>

toString

public String toString()

Overrides:

toString in class AbstractCollection<IMAGE extends Image<?,IMAGE>>

create

public static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE> create(InputStreamObjectReader<IMAGE> reader,
                                                              FlickrAPIToken token,
                                                              URL url)
                                                               throws Exception

Create an image dataset from the flickr gallery, photoset or collection at the given url.

Parameters:

reader - the reader with which to load the images

token - the flickr api authentication token

url - the url of the collection/gallery/photo-set

Returns:

a FlickrImageDataset created from the given url

Throws:

Exception - if an error occurs

create

public static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE> create(InputStreamObjectReader<IMAGE> reader,
                                                              FlickrAPIToken token,
                                                              String searchTerms)
                                                               throws Exception

Create an image dataset by searching flickr with the given search terms.

Parameters:

reader - the reader with which to load the images

token - the flickr api authentication token

searchTerms - the search terms; space separated. Prepending a term with a "-" means that the term should not appear.

Returns:

a FlickrImageDataset created from the given url

Throws:

Exception - if an error occurs

create

public static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE> create(InputStreamObjectReader<IMAGE> reader,
                                                              FlickrAPIToken token,
                                                              String searchTerms,
                                                              int number)
                                                               throws Exception

Create an image dataset by searching flickr with the given search terms. The number of images can be limited to a subset.

Parameters:

reader - the reader with which to load the images

token - the flickr api authentication token

searchTerms - the search terms; space separated. Prepending a term with a "-" means that the term should not appear.

number - the maximum number of images to add to the dataset. Setting to 0 or less will attempt to use all the images.

Returns:

a FlickrImageDataset created from the given url

Throws:

Exception - if an error occurs

create

public static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE> create(InputStreamObjectReader<IMAGE> reader,
                                                              FlickrAPIToken token,
                                                              URL url,
                                                              int number)
                                                               throws Exception

Create an image dataset from the flickr gallery, photoset or collection at the given url. The number of images can be limited to a subset.

Parameters:

reader - the reader with which to load the images

token - the flickr api authentication token

url - the url of the collection/gallery/photo-set

number - the maximum number of images to add to the dataset. Setting to 0 or less will attempt to use all the images.

Returns:

a FlickrImageDataset created from the given url

Throws:

Exception - if an error occurs

createFromGallery

public static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE> createFromGallery(InputStreamObjectReader<IMAGE> reader,
                                                                         FlickrAPIToken token,
                                                                         com.aetrion.flickr.galleries.SearchParameters params)
                                                                          throws Exception

Create an image dataset from a flickr gallery with the specified parameters.

Parameters:

reader - the reader with which to load the images

token - the flickr api authentication token

params - the parameters describing the gallery and any additional constraints.

Returns:

a FlickrImageDataset created from the gallery described by the given parameters

Throws:

Exception - if an error occurs

createFromGallery

public static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE> createFromGallery(InputStreamObjectReader<IMAGE> reader,
                                                                         FlickrAPIToken token,
                                                                         com.aetrion.flickr.galleries.SearchParameters params,
                                                                         int number)
                                                                          throws Exception

Create an image dataset from a flickr gallery with the specified parameters. The number of images can be limited to a subset.

Parameters:

reader - the reader with which to load the images

token - the flickr api authentication token

params - the parameters describing the gallery and any additional constraints.

number - the maximum number of images to add to the dataset. Setting to 0 or less will attempt to use all the images.

Returns:

a FlickrImageDataset created from the gallery described by the given parameters

Throws:

Exception - if an error occurs

createFromPhotoset

public static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE> createFromPhotoset(InputStreamObjectReader<IMAGE> reader,
                                                                          FlickrAPIToken token,
                                                                          String setId)
                                                                           throws Exception

Create an image dataset from a flickr photoset.

Parameters:

reader - the reader with which to load the images

token - the flickr api authentication token

setId - the photoset identifier

Returns:

a FlickrImageDataset created from the gallery described by the given parameters

Throws:

Exception - if an error occurs

createFromPhotoset

public static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE> createFromPhotoset(InputStreamObjectReader<IMAGE> reader,
                                                                          FlickrAPIToken token,
                                                                          String setId,
                                                                          int number)
                                                                           throws Exception

Create an image dataset from a flickr photoset. The number of images can be limited to a subset.

Parameters:

reader - the reader with which to load the images

token - the flickr api authentication token

setId - the photoset identifier

number - the maximum number of images to add to the dataset. Setting to 0 or less will attempt to use all the images.

Returns:

a FlickrImageDataset created from the gallery described by the given parameters

Throws:

Exception - if an error occurs

createFromCollection

public static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE> createFromCollection(InputStreamObjectReader<IMAGE> reader,
                                                                            FlickrAPIToken token,
                                                                            com.aetrion.flickr.collections.CollectionsSearchParameters params)
                                                                             throws Exception

Create an image dataset from a flickr collection with the specified parameters.

Parameters:

reader - the reader with which to load the images

token - the flickr api authentication token

params - the parameters describing the gallery and any additional constraints.

Returns:

a FlickrImageDataset created from the gallery described by the given parameters

Throws:

Exception - if an error occurs

createFromCollection

public static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE> createFromCollection(InputStreamObjectReader<IMAGE> reader,
                                                                            FlickrAPIToken token,
                                                                            com.aetrion.flickr.collections.CollectionsSearchParameters params,
                                                                            int number)
                                                                             throws Exception

Create an image dataset from a flickr collection with the specified parameters. The number of images can be limited to a subset.

Parameters:

reader - the reader with which to load the images

token - the flickr api authentication token

params - the parameters describing the gallery and any additional constraints.

number - the maximum number of images to add to the dataset. Setting to 0 or less will attempt to use all the images.

Returns:

a FlickrImageDataset created from the gallery described by the given parameters

Throws:

Exception - if an error occurs

createFromSearch

public static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE> createFromSearch(InputStreamObjectReader<IMAGE> reader,
                                                                        FlickrAPIToken token,
                                                                        com.aetrion.flickr.photos.SearchParameters params)
                                                                         throws Exception

Create an image dataset from a flickr search with the specified parameters.

Parameters:

reader - the reader with which to load the images

token - the flickr api authentication token

params - the parameters describing the gallery and any additional constraints.

Returns:

a FlickrImageDataset created from the gallery described by the given parameters

Throws:

Exception - if an error occurs

createFromSearch

public static <IMAGE extends Image<?,IMAGE>> FlickrImageDataset<IMAGE> createFromSearch(InputStreamObjectReader<IMAGE> reader,
                                                                        FlickrAPIToken token,
                                                                        com.aetrion.flickr.photos.SearchParameters params,
                                                                        int number)
                                                                         throws Exception

Create an image dataset from a flickr search with the specified parameters. The number of images can be limited to a subset.

Parameters:

reader - the reader with which to load the images

token - the flickr api authentication token

params - the parameters describing the gallery and any additional constraints.

number - the maximum number of images to add to the dataset. Setting to 0 or less will attempt to use all the images.

Returns:

a FlickrImageDataset created from the gallery described by the given parameters

Throws:

Exception - if an error occurs