OME::Dataset - a collection of images
The Dataset class represents OME datasets, which are a collection
of images. Datasets and images form a many-to-many map, as do
datasets and projects. A user's session usually has a single dataset
selected as the "active dataset". Datasets also form the unit of
analysis for the OME analysis engine; analysis chains are
batch-execute against all of the images in a dataset.
Dataset)The following methods are available to Dataset in addition to those
defined by the OME::DBObject manpage.
my $name = $dataset->name();
$dataset->name($name);
Returns or sets the name of this dataset.
my $description = $dataset->description();
$dataset->description($description);
Returns or sets the description of this dataset.
my $locked = $dataset->locked();
$dataset->locked($locked);
Returns or sets whether this dataset is locked. A dataset must be locked once it is analyzed; nothing is allowed to add or remove images from a locked dataset. (Its other properties, such and name and description, however, can still be modified.)
my $owner = $dataset->owner();
$dataset->owner($owner);
Returns or sets the owner of this dataset.
my $group = $dataset->group();
$dataset->group($group);
Returns or sets the group that this dataset belongs to.
my @project_links = $dataset->project_links();
my $project_link_iterator = $dataset->project_links();
Returns or iterates, depending on context, the project links for this dataset. (Being a many-to-many map, the link represents the mapping table.)
my @image_links = $dataset->image_links();
my $image_link_iterator = $dataset->image_links();
Returns or iterates, depending on context, the image links for this dataset. (Being a many-to-many map, the link represents the mapping table.)
Douglas Creager <dcreager@alum.mit.edu>, Open Microscopy Environment, MIT