Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update python Tables code to use 'Image' column #2355

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 40 additions & 30 deletions omero/developers/Python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -656,52 +656,62 @@ Write data
OMERO tables
^^^^^^^^^^^^

- **Create a name for the Original File (should be unique)**
- **Create some sample data. One table row per Image in Dataset**

The "Image" name is important to identify the Image ID column.

::

from random import random
table_name = "TablesDemo:%s" % str(random())
col1 = omero.grid.LongColumn('Uid', 'testLong', [])
col2 = omero.grid.StringColumn('MyStringColumnInit', '', 64, [])
columns = [col1, col2]
dataset = conn.getObject('Dataset', dataset_id)
group_id = dataset.getDetails().group.id.val
conn.SERVICE_OPTS.setOmeroGroup(group_id)
column_names = ["Image", "Image_Name", "random_number"]
column_data = {"Image": [], "Image_Name": [], "random_number":[]}
for image in dataset.listChildren():
column_data["Image"].append(image.getId())
column_data["Image_Name"].append(image.name)
column_data["random_number"].append(random())

- **Create and initialize a new table.**
- **Create appropriate column types with data.**

::

resources = conn.c.sf.sharedResources()
repository_id = resources.repositories().descriptions[0].getId().getValue()
table = resources.newTable(repository_id, table_name)
table.initialize(columns)
cols = []
for name in column_names:
col_values = column_data[name]
if name == 'Image':
cols.append(ImageColumn(name, 'Description', col_values))
elif isinstance(col_values[0], int):
cols.append(LongColumn(name, 'Integer value column', col_values))
elif isinstance(col_values[0], float):
cols.append(DoubleColumn(name, '', col_values))
elif isinstance(col_values[0], str):
cols.append(StringColumn(name, '', 64, col_values))

- **Add data to the table**
- **Initialize table with the data**

::

ids = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
strings = ["one", "two", "three", "four", "five",
"six", "seven", "eight", "nine", "ten"]
data1 = omero.grid.LongColumn('Uid', 'test Long', ids)
data2 = omero.grid.StringColumn('MyStringColumn', '', 64, strings)
data = [data1, data2]
table.addData(data)
orig_file = table.getOriginalFile()
table.close() # when we are done, close.
resources = conn.c.sf.sharedResources()
repository_id = resources.repositories().descriptions[0].getId().getValue()
table = resources.newTable(repository_id, "TablesDemo:%i" % int(random()*1e6))
table.initialize(cols)
# Upload the data
table.addData(cols)
table_file_id = table.getOriginalFile().id.val
table.close()

- **Load the table as an original file**
- **link the table file to the Dataset**

::

orig_file_id = orig_file.id.val
# ...so you can attach this data to an object e.g. Dataset
file_ann = omero.model.FileAnnotationI()
# use unloaded OriginalFileI
file_ann.setFile(omero.model.OriginalFileI(orig_file_id, False))
file_ann = conn.getUpdateService().saveAndReturnObject(file_ann)
link = omero.model.DatasetAnnotationLinkI()
link.setParent(omero.model.DatasetI(datasetId, False))
link.setChild(omero.model.FileAnnotationI(file_ann.getId().getValue(), False))
annotation = FileAnnotationI()
annotation.setFile(OriginalFileI(table_file_id, False))
annotation = conn.getUpdateService().saveAndReturnObject(annotation)
link = DatasetAnnotationLinkI()
link.setParent(DatasetI(dataset.getId(), False))
link.setChild(FileAnnotationI(annotation.getId().getValue(), False))
conn.getUpdateService().saveAndReturnObject(link)

- **Table API**
Expand Down