dataeval.utils.data.datasets.Ships¶

class dataeval.utils.data.datasets.Ships(root, transforms=None, download=False, verbose=False)¶

A dataset that focuses on identifying ships from satellite images.

The dataset comes from kaggle, Ships in Satellite Imagery. The images come from Planet satellite imagery when they gave open-access to a portion of their data.

There are 4000 80x80x3 (HWC) images of ships, sea, and land. There are also 8 larger scene images similar to what would be operationally provided.

Parameters:¶

root : str or pathlib.Path¶

Root directory of dataset where the shipdataset folder exists.

transforms : Transform, Sequence[Transform] or None, default None¶

Transform(s) to apply to the data.

download : bool, default False¶

If True, downloads the dataset from the internet and puts it in root directory. Class checks to see if data is already downloaded to ensure it does not create a duplicate download.

verbose : bool, default False¶

If True, outputs print statements.

path¶

Location of the folder containing the data.

Type:¶

pathlib.Path

image_set¶

The base image set is the only available image set for the Ships dataset.

Type:¶

“base”

index2label¶

Dictionary which translates from class integers to the associated class strings.

Type:¶

dict[int, str]

label2index¶

Dictionary which translates from class strings to the associated class integers.

Type:¶

dict[str, int]

metadata¶

Typed dictionary containing dataset metadata, such as id which returns the dataset class name.

Type:¶

DatasetMetadata

transforms¶

The transforms to be applied to the data.

Type:¶

Sequence[Transform]

size¶

The size of the dataset.

Type:¶

int

Note

Data License: CC BY-SA 4.0

get_scene(index)¶

Get the desired satellite image (scene) by passing in the index of the desired file.

Parameters:¶

index : int¶

Value of the desired data point

Returns:¶

Scene image

Return type:¶

NDArray[np.uintp]

Note

The scene will be returned with the channel axis first.